![]() ![]() | ![]() |
More compact layout for parameter selection
1: # The LearningOnline Network with CAPA 2: # a pile of common routines 3: # 4: # $Id: loncommon.pm,v 1.997 2011/01/15 21:49:37 www Exp $ 5: # 6: # Copyright Michigan State University Board of Trustees 7: # 8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA). 9: # 10: # LON-CAPA is free software; you can redistribute it and/or modify 11: # it under the terms of the GNU General Public License as published by 12: # the Free Software Foundation; either version 2 of the License, or 13: # (at your option) any later version. 14: # 15: # LON-CAPA is distributed in the hope that it will be useful, 16: # but WITHOUT ANY WARRANTY; without even the implied warranty of 17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18: # GNU General Public License for more details. 19: # 20: # You should have received a copy of the GNU General Public License 21: # along with LON-CAPA; if not, write to the Free Software 22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 23: # 24: # /home/httpd/html/adm/gpl.txt 25: # 26: # http://www.lon-capa.org/ 27: # 28: 29: # Makes a table out of the previous attempts 30: # Inputs result_from_symbread, user, domain, course_id 31: # Reads in non-network-related .tab files 32: 33: # POD header: 34: 35: =pod 36: 37: =head1 NAME 38: 39: Apache::loncommon - pile of common routines 40: 41: =head1 SYNOPSIS 42: 43: Common routines for manipulating connections, student answers, 44: domains, common Javascript fragments, etc. 45: 46: =head1 OVERVIEW 47: 48: A collection of commonly used subroutines that don't have a natural 49: home anywhere else. This collection helps remove 50: redundancy from other modules and increase efficiency of memory usage. 51: 52: =cut 53: 54: # End of POD header 55: package Apache::loncommon; 56: 57: use strict; 58: use Apache::lonnet; 59: use GDBM_File; 60: use POSIX qw(strftime mktime); 61: use Apache::lonmenu(); 62: use Apache::lonenc(); 63: use Apache::lonlocal; 64: use Apache::lonnet(); 65: use HTML::Entities; 66: use Apache::lonhtmlcommon(); 67: use Apache::loncoursedata(); 68: use Apache::lontexconvert(); 69: use Apache::lonclonecourse(); 70: use LONCAPA qw(:DEFAULT :match); 71: use DateTime::TimeZone; 72: use DateTime::Locale::Catalog; 73: 74: # ---------------------------------------------- Designs 75: use vars qw(%defaultdesign); 76: 77: my $readit; 78: 79: 80: ## 81: ## Global Variables 82: ## 83: 84: 85: # ----------------------------------------------- SSI with retries: 86: # 87: 88: =pod 89: 90: =head1 Server Side include with retries: 91: 92: =over 4 93: 94: =item * &ssi_with_retries(resource,retries form) 95: 96: Performs an ssi with some number of retries. Retries continue either 97: until the result is ok or until the retry count supplied by the 98: caller is exhausted. 99: 100: Inputs: 101: 102: =over 4 103: 104: resource - Identifies the resource to insert. 105: 106: retries - Count of the number of retries allowed. 107: 108: form - Hash that identifies the rendering options. 109: 110: =back 111: 112: Returns: 113: 114: =over 4 115: 116: content - The content of the response. If retries were exhausted this is empty. 117: 118: response - The response from the last attempt (which may or may not have been successful. 119: 120: =back 121: 122: =back 123: 124: =cut 125: 126: sub ssi_with_retries { 127: my ($resource, $retries, %form) = @_; 128: 129: 130: my $ok = 0; # True if we got a good response. 131: my $content; 132: my $response; 133: 134: # Try to get the ssi done. within the retries count: 135: 136: do { 137: ($content, $response) = &Apache::lonnet::ssi($resource, %form); 138: $ok = $response->is_success; 139: if (!$ok) { 140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message); 141: } 142: $retries--; 143: } while (!$ok && ($retries > 0)); 144: 145: if (!$ok) { 146: $content = ''; # On error return an empty content. 147: } 148: return ($content, $response); 149: 150: } 151: 152: 153: 154: # ----------------------------------------------- Filetypes/Languages/Copyright 155: my %language; 156: my %supported_language; 157: my %cprtag; 158: my %scprtag; 159: my %fe; my %fd; my %fm; 160: my %category_extensions; 161: 162: # ---------------------------------------------- Thesaurus variables 163: # 164: # %Keywords: 165: # A hash used by &keyword to determine if a word is considered a keyword. 166: # $thesaurus_db_file 167: # Scalar containing the full path to the thesaurus database. 168: 169: my %Keywords; 170: my $thesaurus_db_file; 171: 172: # 173: # Initialize values from language.tab, copyright.tab, filetypes.tab, 174: # thesaurus.tab, and filecategories.tab. 175: # 176: BEGIN { 177: # Variable initialization 178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db"; 179: # 180: unless ($readit) { 181: # ------------------------------------------------------------------- languages 182: { 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}. 184: '/language.tab'; 185: if ( open(my $fh,"<$langtabfile") ) { 186: while (my $line = <$fh>) { 187: next if ($line=~/^\#/); 188: chomp($line); 189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line)); 190: $language{$key}=$val.' - '.$enc; 191: if ($sup) { 192: $supported_language{$key}=$sup; 193: } 194: } 195: close($fh); 196: } 197: } 198: # ------------------------------------------------------------------ copyrights 199: { 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}. 201: '/copyright.tab'; 202: if ( open (my $fh,"<$copyrightfile") ) { 203: while (my $line = <$fh>) { 204: next if ($line=~/^\#/); 205: chomp($line); 206: my ($key,$val)=(split(/\s+/,$line,2)); 207: $cprtag{$key}=$val; 208: } 209: close($fh); 210: } 211: } 212: # ----------------------------------------------------------- source copyrights 213: { 214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}. 215: '/source_copyright.tab'; 216: if ( open (my $fh,"<$sourcecopyrightfile") ) { 217: while (my $line = <$fh>) { 218: next if ($line =~ /^\#/); 219: chomp($line); 220: my ($key,$val)=(split(/\s+/,$line,2)); 221: $scprtag{$key}=$val; 222: } 223: close($fh); 224: } 225: } 226: 227: # -------------------------------------------------------------- default domain designs 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors'; 229: my $designfile = $designdir.'/default.tab'; 230: if ( open (my $fh,"<$designfile") ) { 231: while (my $line = <$fh>) { 232: next if ($line =~ /^\#/); 233: chomp($line); 234: my ($key,$val)=(split(/\=/,$line)); 235: if ($val) { $defaultdesign{$key}=$val; } 236: } 237: close($fh); 238: } 239: 240: # ------------------------------------------------------------- file categories 241: { 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}. 243: '/filecategories.tab'; 244: if ( open (my $fh,"<$categoryfile") ) { 245: while (my $line = <$fh>) { 246: next if ($line =~ /^\#/); 247: chomp($line); 248: my ($extension,$category)=(split(/\s+/,$line,2)); 249: push @{$category_extensions{lc($category)}},$extension; 250: } 251: close($fh); 252: } 253: 254: } 255: # ------------------------------------------------------------------ file types 256: { 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}. 258: '/filetypes.tab'; 259: if ( open (my $fh,"<$typesfile") ) { 260: while (my $line = <$fh>) { 261: next if ($line =~ /^\#/); 262: chomp($line); 263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4); 264: if ($descr ne '') { 265: $fe{$ending}=lc($emb); 266: $fd{$ending}=$descr; 267: if ($mime ne 'unk') { $fm{$ending}=$mime; } 268: } 269: } 270: close($fh); 271: } 272: } 273: &Apache::lonnet::logthis( 274: "<span style='color:yellow;'>INFO: Read file types</span>"); 275: $readit=1; 276: } # end of unless($readit) 277: 278: } 279: 280: ############################################################### 281: ## HTML and Javascript Helper Functions ## 282: ############################################################### 283: 284: =pod 285: 286: =head1 HTML and Javascript Functions 287: 288: =over 4 289: 290: =item * &browser_and_searcher_javascript() 291: 292: X<browsing, javascript>X<searching, javascript>Returns a string 293: containing javascript with two functions, C<openbrowser> and 294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt> 295: tags. 296: 297: =item * &openbrowser(formname,elementname,only,omit) [javascript] 298: 299: inputs: formname, elementname, only, omit 300: 301: formname and elementname indicate the name of the html form and name of 302: the element that the results of the browsing selection are to be placed in. 303: 304: Specifying 'only' will restrict the browser to displaying only files 305: with the given extension. Can be a comma separated list. 306: 307: Specifying 'omit' will restrict the browser to NOT displaying files 308: with the given extension. Can be a comma separated list. 309: 310: =item * &opensearcher(formname,elementname) [javascript] 311: 312: Inputs: formname, elementname 313: 314: formname and elementname specify the name of the html form and the name 315: of the element the selection from the search results will be placed in. 316: 317: =cut 318: 319: sub browser_and_searcher_javascript { 320: my ($mode)=@_; 321: if (!defined($mode)) { $mode='edit'; } 322: my $resurl=&escape_single(&lastresurl()); 323: return <<END; 324: // <!-- BEGIN LON-CAPA Internal 325: var editbrowser = null; 326: function openbrowser(formname,elementname,only,omit,titleelement) { 327: var url = '$resurl/?'; 328: if (editbrowser == null) { 329: url += 'launch=1&'; 330: } 331: url += 'catalogmode=interactive&'; 332: url += 'mode=$mode&'; 333: url += 'inhibitmenu=yes&'; 334: url += 'form=' + formname + '&'; 335: if (only != null) { 336: url += 'only=' + only + '&'; 337: } else { 338: url += 'only=&'; 339: } 340: if (omit != null) { 341: url += 'omit=' + omit + '&'; 342: } else { 343: url += 'omit=&'; 344: } 345: if (titleelement != null) { 346: url += 'titleelement=' + titleelement + '&'; 347: } else { 348: url += 'titleelement=&'; 349: } 350: url += 'element=' + elementname + ''; 351: var title = 'Browser'; 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1'; 353: options += ',width=700,height=600'; 354: editbrowser = open(url,title,options,'1'); 355: editbrowser.focus(); 356: } 357: var editsearcher; 358: function opensearcher(formname,elementname,titleelement) { 359: var url = '/adm/searchcat?'; 360: if (editsearcher == null) { 361: url += 'launch=1&'; 362: } 363: url += 'catalogmode=interactive&'; 364: url += 'mode=$mode&'; 365: url += 'form=' + formname + '&'; 366: if (titleelement != null) { 367: url += 'titleelement=' + titleelement + '&'; 368: } else { 369: url += 'titleelement=&'; 370: } 371: url += 'element=' + elementname + ''; 372: var title = 'Search'; 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1'; 374: options += ',width=700,height=600'; 375: editsearcher = open(url,title,options,'1'); 376: editsearcher.focus(); 377: } 378: // END LON-CAPA Internal --> 379: END 380: } 381: 382: sub lastresurl { 383: if ($env{'environment.lastresurl'}) { 384: return $env{'environment.lastresurl'} 385: } else { 386: return '/res'; 387: } 388: } 389: 390: sub storeresurl { 391: my $resurl=&Apache::lonnet::clutter(shift); 392: unless ($resurl=~/^\/res/) { return 0; } 393: $resurl=~s/\/$//; 394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl}); 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl}); 396: return 1; 397: } 398: 399: sub studentbrowser_javascript { 400: unless ( 401: (($env{'request.course.id'}) && 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'}) 403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}. 404: '/'.$env{'request.course.sec'}) 405: )) 406: || ($env{'request.role'}=~/^(au|dc|su)/) 407: ) { return ''; } 408: return (<<'ENDSTDBRW'); 409: <script type="text/javascript" language="Javascript"> 410: // <![CDATA[ 411: var stdeditbrowser; 412: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) { 413: var url = '/adm/pickstudent?'; 414: var filter; 415: if (!ignorefilter) { 416: eval('filter=document.'+formname+'.'+uname+'.value;'); 417: } 418: if (filter != null) { 419: if (filter != '') { 420: url += 'filter='+filter+'&'; 421: } 422: } 423: url += 'form=' + formname + '&unameelement='+uname+ 424: '&udomelement='+udom; 425: if (roleflag) { url+="&roles=1"; } 426: if (courseadvonly) { url+="&courseadvonly=1"; } 427: var title = 'Student_Browser'; 428: var options = 'scrollbars=1,resizable=1,menubar=0'; 429: options += ',width=700,height=600'; 430: stdeditbrowser = open(url,title,options,'1'); 431: stdeditbrowser.focus(); 432: } 433: // ]]> 434: </script> 435: ENDSTDBRW 436: } 437: 438: sub selectstudent_link { 439: my ($form,$unameele,$udomele,$courseadvonly)=@_; 440: my $callargs = "'".$form."','".$unameele."','".$udomele."'"; 441: if ($env{'request.course.id'}) { 442: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'}) 443: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}. 444: '/'.$env{'request.course.sec'})) { 445: return ''; 446: } 447: if ($courseadvonly) { 448: $callargs .= ",'',1,1"; 449: } 450: return '<span class="LC_nobreak">'. 451: '<a href="javascript:openstdbrowser('.$callargs.');">'. 452: &mt('Select User').'</a></span>'; 453: } 454: if ($env{'request.role'}=~/^(au|dc|su)/) { 455: $callargs .= ",1"; 456: return '<span class="LC_nobreak">'. 457: '<a href="javascript:openstdbrowser('.$callargs.');">'. 458: &mt('Select User').'</a></span>'; 459: } 460: return ''; 461: } 462: 463: sub authorbrowser_javascript { 464: return <<"ENDAUTHORBRW"; 465: <script type="text/javascript" language="JavaScript"> 466: // <![CDATA[ 467: var stdeditbrowser; 468: 469: function openauthorbrowser(formname,udom) { 470: var url = '/adm/pickauthor?'; 471: url += 'form='+formname+'&roledom='+udom; 472: var title = 'Author_Browser'; 473: var options = 'scrollbars=1,resizable=1,menubar=0'; 474: options += ',width=700,height=600'; 475: stdeditbrowser = open(url,title,options,'1'); 476: stdeditbrowser.focus(); 477: } 478: 479: // ]]> 480: </script> 481: ENDAUTHORBRW 482: } 483: 484: sub coursebrowser_javascript { 485: my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_; 486: my $wintitle = 'Course_Browser'; 487: if ($crstype eq 'Community') { 488: $wintitle = 'Community_Browser'; 489: } 490: my $id_functions = &javascript_index_functions(); 491: my $output = ' 492: <script type="text/javascript" language="JavaScript"> 493: // <![CDATA[ 494: var stdeditbrowser;'."\n"; 495: 496: $output .= <<"ENDSTDBRW"; 497: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) { 498: var url = '/adm/pickcourse?'; 499: var formid = getFormIdByName(formname); 500: var domainfilter = getDomainFromSelectbox(formname,udom); 501: if (domainfilter != null) { 502: if (domainfilter != '') { 503: url += 'domainfilter='+domainfilter+'&'; 504: } 505: } 506: url += 'form=' + formname + '&cnumelement='+uname+ 507: '&cdomelement='+udom+ 508: '&cnameelement='+desc; 509: if (extra_element !=null && extra_element != '') { 510: if (formname == 'rolechoice' || formname == 'studentform') { 511: url += '&roleelement='+extra_element; 512: if (domainfilter == null || domainfilter == '') { 513: url += '&domainfilter='+extra_element; 514: } 515: } 516: else { 517: if (formname == 'portform') { 518: url += '&setroles='+extra_element; 519: } else { 520: if (formname == 'rules') { 521: url += '&fixeddom='+extra_element; 522: } 523: } 524: } 525: } 526: if (type != null && type != '') { 527: url += '&type='+type; 528: } 529: if (type_elem != null && type_elem != '') { 530: url += '&typeelement='+type_elem; 531: } 532: if (formname == 'ccrs') { 533: var ownername = document.forms[formid].ccuname.value; 534: var ownerdom = document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value; 535: url += '&cloner='+ownername+':'+ownerdom; 536: } 537: if (multflag !=null && multflag != '') { 538: url += '&multiple='+multflag; 539: } 540: var title = '$wintitle'; 541: var options = 'scrollbars=1,resizable=1,menubar=0'; 542: options += ',width=700,height=600'; 543: stdeditbrowser = open(url,title,options,'1'); 544: stdeditbrowser.focus(); 545: } 546: $id_functions 547: ENDSTDBRW 548: if (($sec_element ne '') || ($role_element ne '')) { 549: $output .= &setsec_javascript($sec_element,$formname,$role_element); 550: } 551: $output .= ' 552: // ]]> 553: </script>'; 554: return $output; 555: } 556: 557: sub javascript_index_functions { 558: return <<"ENDJS"; 559: 560: function getFormIdByName(formname) { 561: for (var i=0;i<document.forms.length;i++) { 562: if (document.forms[i].name == formname) { 563: return i; 564: } 565: } 566: return -1; 567: } 568: 569: function getIndexByName(formid,item) { 570: for (var i=0;i<document.forms[formid].elements.length;i++) { 571: if (document.forms[formid].elements[i].name == item) { 572: return i; 573: } 574: } 575: return -1; 576: } 577: 578: function getDomainFromSelectbox(formname,udom) { 579: var userdom; 580: var formid = getFormIdByName(formname); 581: if (formid > -1) { 582: var domid = getIndexByName(formid,udom); 583: if (domid > -1) { 584: if (document.forms[formid].elements[domid].type == 'select-one') { 585: userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value; 586: } 587: if (document.forms[formid].elements[domid].type == 'hidden') { 588: userdom=document.forms[formid].elements[domid].value; 589: } 590: } 591: } 592: return userdom; 593: } 594: 595: ENDJS 596: 597: } 598: 599: sub userbrowser_javascript { 600: my $id_functions = &javascript_index_functions(); 601: return <<"ENDUSERBRW"; 602: 603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) { 604: var url = '/adm/pickuser?'; 605: var userdom = getDomainFromSelectbox(formname,udom); 606: if (userdom != null) { 607: if (userdom != '') { 608: url += 'srchdom='+userdom+'&'; 609: } 610: } 611: url += 'form=' + formname + '&unameelement='+uname+ 612: '&udomelement='+udom+ 613: '&ulastelement='+ulast+ 614: '&ufirstelement='+ufirst+ 615: '&uemailelement='+uemail+ 616: '&hideudomelement='+hideudom+ 617: '&coursedom='+crsdom; 618: if ((caller != null) && (caller != undefined)) { 619: url += '&caller='+caller; 620: } 621: var title = 'User_Browser'; 622: var options = 'scrollbars=1,resizable=1,menubar=0'; 623: options += ',width=700,height=600'; 624: var stdeditbrowser = open(url,title,options,'1'); 625: stdeditbrowser.focus(); 626: } 627: 628: function fix_domain (formname,udom,origdom,uname) { 629: var formid = getFormIdByName(formname); 630: if (formid > -1) { 631: var unameid = getIndexByName(formid,uname); 632: var domid = getIndexByName(formid,udom); 633: var hidedomid = getIndexByName(formid,origdom); 634: if (hidedomid > -1) { 635: var fixeddom = document.forms[formid].elements[hidedomid].value; 636: var unameval = document.forms[formid].elements[unameid].value; 637: if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) { 638: if (domid > -1) { 639: var slct = document.forms[formid].elements[domid]; 640: if (slct.type == 'select-one') { 641: var i; 642: for (i=0;i<slct.length;i++) { 643: if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; } 644: } 645: } 646: if (slct.type == 'hidden') { 647: slct.value = fixeddom; 648: } 649: } 650: } 651: } 652: } 653: return; 654: } 655: 656: $id_functions 657: ENDUSERBRW 658: } 659: 660: sub setsec_javascript { 661: my ($sec_element,$formname,$role_element) = @_; 662: my (@courserolenames,@communityrolenames,$rolestr,$courserolestr, 663: $communityrolestr); 664: if ($role_element ne '') { 665: my @allroles = ('st','ta','ep','in','ad'); 666: foreach my $crstype ('Course','Community') { 667: if ($crstype eq 'Community') { 668: foreach my $role (@allroles) { 669: push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype)); 670: } 671: push(@communityrolenames,&Apache::lonnet::plaintext('co')); 672: } else { 673: foreach my $role (@allroles) { 674: push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype)); 675: } 676: push(@courserolenames,&Apache::lonnet::plaintext('cc')); 677: } 678: } 679: $rolestr = '"'.join('","',@allroles).'"'; 680: $courserolestr = '"'.join('","',@courserolenames).'"'; 681: $communityrolestr = '"'.join('","',@communityrolenames).'"'; 682: } 683: my $setsections = qq| 684: function setSect(sectionlist) { 685: var sectionsArray = new Array(); 686: if ((sectionlist != '') && (typeof sectionlist != "undefined")) { 687: sectionsArray = sectionlist.split(","); 688: } 689: var numSections = sectionsArray.length; 690: document.$formname.$sec_element.length = 0; 691: if (numSections == 0) { 692: document.$formname.$sec_element.multiple=false; 693: document.$formname.$sec_element.size=1; 694: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false) 695: } else { 696: if (numSections == 1) { 697: document.$formname.$sec_element.multiple=false; 698: document.$formname.$sec_element.size=1; 699: document.$formname.$sec_element.options[0] = new Option('Select','',true,true); 700: document.$formname.$sec_element.options[1] = new Option('No section','',false,false) 701: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false); 702: } else { 703: for (var i=0; i<numSections; i++) { 704: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false) 705: } 706: document.$formname.$sec_element.multiple=true 707: if (numSections < 3) { 708: document.$formname.$sec_element.size=numSections; 709: } else { 710: document.$formname.$sec_element.size=3; 711: } 712: document.$formname.$sec_element.options[0].selected = false 713: } 714: } 715: } 716: 717: function setRole(crstype) { 718: |; 719: if ($role_element eq '') { 720: $setsections .= ' return; 721: } 722: '; 723: } else { 724: $setsections .= qq| 725: var elementLength = document.$formname.$role_element.length; 726: var allroles = Array($rolestr); 727: var courserolenames = Array($courserolestr); 728: var communityrolenames = Array($communityrolestr); 729: if (elementLength != undefined) { 730: if (document.$formname.$role_element.options[5].value == 'cc') { 731: if (crstype == 'Course') { 732: return; 733: } else { 734: allroles[5] = 'co'; 735: for (var i=0; i<6; i++) { 736: document.$formname.$role_element.options[i].value = allroles[i]; 737: document.$formname.$role_element.options[i].text = communityrolenames[i]; 738: } 739: } 740: } else { 741: if (crstype == 'Community') { 742: return; 743: } else { 744: allroles[5] = 'cc'; 745: for (var i=0; i<6; i++) { 746: document.$formname.$role_element.options[i].value = allroles[i]; 747: document.$formname.$role_element.options[i].text = courserolenames[i]; 748: } 749: } 750: } 751: } 752: return; 753: } 754: |; 755: } 756: return $setsections; 757: } 758: 759: sub selectcourse_link { 760: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype, 761: $typeelement) = @_; 762: my $type = $selecttype; 763: my $linktext = &mt('Select Course'); 764: if ($selecttype eq 'Community') { 765: $linktext = &mt('Select Community'); 766: } elsif ($selecttype eq 'Course/Community') { 767: $linktext = &mt('Select Course/Community'); 768: $type = ''; 769: } 770: return '<span class="LC_nobreak">' 771: ."<a href='" 772: .'javascript:opencrsbrowser("'.$form.'","'.$unameele 773: .'","'.$udomele.'","'.$desc.'","'.$extra_element 774: .'","'.$multflag.'","'.$type.'","'.$typeelement.'");' 775: ."'>".$linktext.'</a>' 776: .'</span>'; 777: } 778: 779: sub selectauthor_link { 780: my ($form,$udom)=@_; 781: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'. 782: &mt('Select Author').'</a>'; 783: } 784: 785: sub selectuser_link { 786: my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem, 787: $coursedom,$linktext,$caller) = @_; 788: return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',". 789: "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'". 790: ');">'.$linktext.'</a>'; 791: } 792: 793: sub check_uncheck_jscript { 794: my $jscript = <<"ENDSCRT"; 795: function checkAll(field) { 796: if (field.length > 0) { 797: for (i = 0; i < field.length; i++) { 798: field[i].checked = true ; 799: } 800: } else { 801: field.checked = true 802: } 803: } 804: 805: function uncheckAll(field) { 806: if (field.length > 0) { 807: for (i = 0; i < field.length; i++) { 808: field[i].checked = false ; 809: } 810: } else { 811: field.checked = false ; 812: } 813: } 814: ENDSCRT 815: return $jscript; 816: } 817: 818: sub select_timezone { 819: my ($name,$selected,$onchange,$includeempty)=@_; 820: my $output='<select name="'.$name.'" '.$onchange.'>'."\n"; 821: if ($includeempty) { 822: $output .= '<option value=""'; 823: if (($selected eq '') || ($selected eq 'local')) { 824: $output .= ' selected="selected" '; 825: } 826: $output .= '> </option>'; 827: } 828: my @timezones = DateTime::TimeZone->all_names; 829: foreach my $tzone (@timezones) { 830: $output.= '<option value="'.$tzone.'"'; 831: if ($tzone eq $selected) { 832: $output.=' selected="selected"'; 833: } 834: $output.=">$tzone</option>\n"; 835: } 836: $output.="</select>"; 837: return $output; 838: } 839: 840: sub select_datelocale { 841: my ($name,$selected,$onchange,$includeempty)=@_; 842: my $output='<select name="'.$name.'" '.$onchange.'>'."\n"; 843: if ($includeempty) { 844: $output .= '<option value=""'; 845: if ($selected eq '') { 846: $output .= ' selected="selected" '; 847: } 848: $output .= '> </option>'; 849: } 850: my (@possibles,%locale_names); 851: my @locales = DateTime::Locale::Catalog::Locales; 852: foreach my $locale (@locales) { 853: if (ref($locale) eq 'HASH') { 854: my $id = $locale->{'id'}; 855: if ($id ne '') { 856: my $en_terr = $locale->{'en_territory'}; 857: my $native_terr = $locale->{'native_territory'}; 858: my @languages = &Apache::lonlocal::preferred_languages(); 859: if (grep(/^en$/,@languages) || !@languages) { 860: if ($en_terr ne '') { 861: $locale_names{$id} = '('.$en_terr.')'; 862: } elsif ($native_terr ne '') { 863: $locale_names{$id} = $native_terr; 864: } 865: } else { 866: if ($native_terr ne '') { 867: $locale_names{$id} = $native_terr.' '; 868: } elsif ($en_terr ne '') { 869: $locale_names{$id} = '('.$en_terr.')'; 870: } 871: } 872: push (@possibles,$id); 873: } 874: } 875: } 876: foreach my $item (sort(@possibles)) { 877: $output.= '<option value="'.$item.'"'; 878: if ($item eq $selected) { 879: $output.=' selected="selected"'; 880: } 881: $output.=">$item"; 882: if ($locale_names{$item} ne '') { 883: $output.=" $locale_names{$item}</option>\n"; 884: } 885: $output.="</option>\n"; 886: } 887: $output.="</select>"; 888: return $output; 889: } 890: 891: sub select_language { 892: my ($name,$selected,$includeempty) = @_; 893: my %langchoices; 894: if ($includeempty) { 895: %langchoices = ('' => 'No language preference'); 896: } 897: foreach my $id (&languageids()) { 898: my $code = &supportedlanguagecode($id); 899: if ($code) { 900: $langchoices{$code} = &plainlanguagedescription($id); 901: } 902: } 903: return &select_form($selected,$name,\%langchoices); 904: } 905: 906: =pod 907: 908: =item * &linked_select_forms(...) 909: 910: linked_select_forms returns a string containing a <script></script> block 911: and html for two <select> menus. The select menus will be linked in that 912: changing the value of the first menu will result in new values being placed 913: in the second menu. The values in the select menu will appear in alphabetical 914: order unless a defined order is provided. 915: 916: linked_select_forms takes the following ordered inputs: 917: 918: =over 4 919: 920: =item * $formname, the name of the <form> tag 921: 922: =item * $middletext, the text which appears between the <select> tags 923: 924: =item * $firstdefault, the default value for the first menu 925: 926: =item * $firstselectname, the name of the first <select> tag 927: 928: =item * $secondselectname, the name of the second <select> tag 929: 930: =item * $hashref, a reference to a hash containing the data for the menus. 931: 932: =item * $menuorder, the order of values in the first menu 933: 934: =back 935: 936: Below is an example of such a hash. Only the 'text', 'default', and 937: 'select2' keys must appear as stated. keys(%menu) are the possible 938: values for the first select menu. The text that coincides with the 939: first menu value is given in $menu{$choice1}->{'text'}. The values 940: and text for the second menu are given in the hash pointed to by 941: $menu{$choice1}->{'select2'}. 942: 943: my %menu = ( A1 => { text =>"Choice A1" , 944: default => "B3", 945: select2 => { 946: B1 => "Choice B1", 947: B2 => "Choice B2", 948: B3 => "Choice B3", 949: B4 => "Choice B4" 950: }, 951: order => ['B4','B3','B1','B2'], 952: }, 953: A2 => { text =>"Choice A2" , 954: default => "C2", 955: select2 => { 956: C1 => "Choice C1", 957: C2 => "Choice C2", 958: C3 => "Choice C3" 959: }, 960: order => ['C2','C1','C3'], 961: }, 962: A3 => { text =>"Choice A3" , 963: default => "D6", 964: select2 => { 965: D1 => "Choice D1", 966: D2 => "Choice D2", 967: D3 => "Choice D3", 968: D4 => "Choice D4", 969: D5 => "Choice D5", 970: D6 => "Choice D6", 971: D7 => "Choice D7" 972: }, 973: order => ['D4','D3','D2','D1','D7','D6','D5'], 974: } 975: ); 976: 977: =cut 978: 979: sub linked_select_forms { 980: my ($formname, 981: $middletext, 982: $firstdefault, 983: $firstselectname, 984: $secondselectname, 985: $hashref, 986: $menuorder, 987: ) = @_; 988: my $second = "document.$formname.$secondselectname"; 989: my $first = "document.$formname.$firstselectname"; 990: # output the javascript to do the changing 991: my $result = ''; 992: $result.='<script type="text/javascript" language="JavaScript">'."\n"; 993: $result.="// <![CDATA[\n"; 994: $result.="var select2data = new Object();\n"; 995: $" = '","'; 996: my $debug = ''; 997: foreach my $s1 (sort(keys(%$hashref))) { 998: $result.="select2data.d_$s1 = new Object();\n"; 999: $result.="select2data.d_$s1.def = new String('". 1000: $hashref->{$s1}->{'default'}."');\n"; 1001: $result.="select2data.d_$s1.values = new Array("; 1002: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } )); 1003: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') { 1004: @s2values = @{$hashref->{$s1}->{'order'}}; 1005: } 1006: $result.="\"@s2values\");\n"; 1007: $result.="select2data.d_$s1.texts = new Array("; 1008: my @s2texts; 1009: foreach my $value (@s2values) { 1010: push @s2texts, $hashref->{$s1}->{'select2'}->{$value}; 1011: } 1012: $result.="\"@s2texts\");\n"; 1013: } 1014: $"=' '; 1015: $result.= <<"END"; 1016: 1017: function select1_changed() { 1018: // Determine new choice 1019: var newvalue = "d_" + $first.value; 1020: // update select2 1021: var values = select2data[newvalue].values; 1022: var texts = select2data[newvalue].texts; 1023: var select2def = select2data[newvalue].def; 1024: var i; 1025: // out with the old 1026: for (i = 0; i < $second.options.length; i++) { 1027: $second.options[i] = null; 1028: } 1029: // in with the nuclear 1030: for (i=0;i<values.length; i++) { 1031: $second.options[i] = new Option(values[i]); 1032: $second.options[i].value = values[i]; 1033: $second.options[i].text = texts[i]; 1034: if (values[i] == select2def) { 1035: $second.options[i].selected = true; 1036: } 1037: } 1038: } 1039: // ]]> 1040: </script> 1041: END 1042: # output the initial values for the selection lists 1043: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n"; 1044: my @order = sort(keys(%{$hashref})); 1045: if (ref($menuorder) eq 'ARRAY') { 1046: @order = @{$menuorder}; 1047: } 1048: foreach my $value (@order) { 1049: $result.=" <option value=\"$value\" "; 1050: $result.=" selected=\"selected\" " if ($value eq $firstdefault); 1051: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n"; 1052: } 1053: $result .= "</select>\n"; 1054: my %select2 = %{$hashref->{$firstdefault}->{'select2'}}; 1055: $result .= $middletext; 1056: $result .= "<select size=\"1\" name=\"$secondselectname\">\n"; 1057: my $seconddefault = $hashref->{$firstdefault}->{'default'}; 1058: 1059: my @secondorder = sort(keys(%select2)); 1060: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') { 1061: @secondorder = @{$hashref->{$firstdefault}->{'order'}}; 1062: } 1063: foreach my $value (@secondorder) { 1064: $result.=" <option value=\"$value\" "; 1065: $result.=" selected=\"selected\" " if ($value eq $seconddefault); 1066: $result.=">".&mt($select2{$value})."</option>\n"; 1067: } 1068: $result .= "</select>\n"; 1069: # return $debug; 1070: return $result; 1071: } # end of sub linked_select_forms { 1072: 1073: =pod 1074: 1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height,$imgid) 1076: 1077: Returns a string corresponding to an HTML link to the given help 1078: $topic, where $topic corresponds to the name of a .tex file in 1079: /home/httpd/html/adm/help/tex, with underscores replaced by 1080: spaces. 1081: 1082: $text will optionally be linked to the same topic, allowing you to 1083: link text in addition to the graphic. If you do not want to link 1084: text, but wish to specify one of the later parameters, pass an 1085: empty string. 1086: 1087: $stayOnPage is a value that will be interpreted as a boolean. If true, 1088: the link will not open a new window. If false, the link will open 1089: a new window using Javascript. (Default is false.) 1090: 1091: $width and $height are optional numerical parameters that will 1092: override the width and height of the popped up window, which may 1093: be useful for certain help topics with big pictures included. 1094: 1095: $imgid is the id of the img tag used for the help icon. This may be 1096: used in a javascript call to switch the image src. See 1097: lonhtmlcommon::htmlareaselectactive() for an example. 1098: 1099: =cut 1100: 1101: sub help_open_topic { 1102: my ($topic, $text, $stayOnPage, $width, $height, $imgid) = @_; 1103: $text = "" if (not defined $text); 1104: $stayOnPage = 0 if (not defined $stayOnPage); 1105: $width = 350 if (not defined $width); 1106: $height = 400 if (not defined $height); 1107: my $filename = $topic; 1108: $filename =~ s/ /_/g; 1109: 1110: my $template = ""; 1111: my $link; 1112: 1113: $topic=~s/\W/\_/g; 1114: 1115: if (!$stayOnPage) { 1116: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))"; 1117: } else { 1118: $link = "/adm/help/${filename}.hlp"; 1119: } 1120: 1121: # Add the text 1122: if ($text ne "") { 1123: $template.='<span class="LC_help_open_topic">' 1124: .'<a target="_top" href="'.$link.'">' 1125: .$text.'</a>'; 1126: } 1127: 1128: # (Always) Add the graphic 1129: my $title = &mt('Online Help'); 1130: my $helpicon=&lonhttpdurl("/adm/help/help.png"); 1131: if ($imgid ne '') { 1132: $imgid = ' id="'.$imgid.'"'; 1133: } 1134: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">' 1135: .'<img src="'.$helpicon.'" border="0"' 1136: .' alt="'.&mt('Help: [_1]',$topic).'"' 1137: .' title="'.$title.'" style="vertical-align:middle;"'.$imgid 1138: .' /></a>'; 1139: if ($text ne "") { 1140: $template.='</span>'; 1141: } 1142: return $template; 1143: 1144: } 1145: 1146: # This is a quicky function for Latex cheatsheet editing, since it 1147: # appears in at least four places 1148: sub helpLatexCheatsheet { 1149: my ($topic,$text,$not_author) = @_; 1150: my $out; 1151: my $addOther = ''; 1152: if ($topic) { 1153: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text), 1154: undef, undef, 600). 1155: '</span> '; 1156: } 1157: $out = '<span>' # Start cheatsheet 1158: .$addOther 1159: .'<span>' 1160: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'), 1161: undef,undef,600) 1162: .'</span> <span>' 1163: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'), 1164: undef,undef,600) 1165: .'</span>'; 1166: unless ($not_author) { 1167: $out .= ' <span>' 1168: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'), 1169: undef,undef,600) 1170: .'</span>'; 1171: } 1172: $out .= '</span>'; # End cheatsheet 1173: return $out; 1174: } 1175: 1176: sub general_help { 1177: my $helptopic='Student_Intro'; 1178: if ($env{'request.role'}=~/^(ca|au)/) { 1179: $helptopic='Authoring_Intro'; 1180: } elsif ($env{'request.role'}=~/^(cc|co)/) { 1181: $helptopic='Course_Coordination_Intro'; 1182: } elsif ($env{'request.role'}=~/^dc/) { 1183: $helptopic='Domain_Coordination_Intro'; 1184: } 1185: return $helptopic; 1186: } 1187: 1188: sub update_help_link { 1189: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_; 1190: my $origurl = $ENV{'REQUEST_URI'}; 1191: $origurl=~s|^/~|/priv/|; 1192: my $timestamp = time; 1193: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) { 1194: $$datum = &escape($$datum); 1195: } 1196: 1197: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage"; 1198: my $output .= <<"ENDOUTPUT"; 1199: <script type="text/javascript"> 1200: // <![CDATA[ 1201: banner_link = '$banner_link'; 1202: // ]]> 1203: </script> 1204: ENDOUTPUT 1205: return $output; 1206: } 1207: 1208: # now just updates the help link and generates a blue icon 1209: sub help_open_menu { 1210: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 1211: = @_; 1212: $stayOnPage = 1; 1213: my $output; 1214: if ($component_help) { 1215: if (!$text) { 1216: $output=&help_open_topic($component_help,undef,$stayOnPage, 1217: $width,$height); 1218: } else { 1219: my $help_text; 1220: $help_text=&unescape($topic); 1221: $output='<table><tr><td>'. 1222: &help_open_topic($component_help,$help_text,$stayOnPage, 1223: $width,$height).'</td></tr></table>'; 1224: } 1225: } 1226: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage); 1227: return $output.$banner_link; 1228: } 1229: 1230: sub top_nav_help { 1231: my ($text) = @_; 1232: $text = &mt($text); 1233: my $stay_on_page = 1; 1234: 1235: my $link = ($stay_on_page) ? "javascript:helpMenu('display')" 1236: : "javascript:helpMenu('open')"; 1237: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page); 1238: 1239: my $title = &mt('Get help'); 1240: 1241: return <<"END"; 1242: $banner_link 1243: <a href="$link" title="$title">$text</a> 1244: END 1245: } 1246: 1247: sub help_menu_js { 1248: my ($text) = @_; 1249: my $stayOnPage = 1; 1250: my $width = 620; 1251: my $height = 600; 1252: my $helptopic=&general_help(); 1253: my $details_link = '/adm/help/'.$helptopic.'.hlp'; 1254: my $nothing=&Apache::lonhtmlcommon::javascript_nothing(); 1255: my $start_page = 1256: &Apache::loncommon::start_page('Help Menu', undef, 1257: {'frameset' => 1, 1258: 'js_ready' => 1, 1259: 'add_entries' => { 1260: 'border' => '0', 1261: 'rows' => "110,*",},}); 1262: my $end_page = 1263: &Apache::loncommon::end_page({'frameset' => 1, 1264: 'js_ready' => 1,}); 1265: 1266: my $template .= <<"ENDTEMPLATE"; 1267: <script type="text/javascript"> 1268: // <![CDATA[ 1269: // <!-- BEGIN LON-CAPA Internal 1270: var banner_link = ''; 1271: function helpMenu(target) { 1272: var caller = this; 1273: if (target == 'open') { 1274: var newWindow = null; 1275: try { 1276: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" ) 1277: } 1278: catch(error) { 1279: writeHelp(caller); 1280: return; 1281: } 1282: if (newWindow) { 1283: caller = newWindow; 1284: } 1285: } 1286: writeHelp(caller); 1287: return; 1288: } 1289: function writeHelp(caller) { 1290: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page') 1291: caller.document.close() 1292: caller.focus() 1293: } 1294: // END LON-CAPA Internal --> 1295: // ]]> 1296: </script> 1297: ENDTEMPLATE 1298: return $template; 1299: } 1300: 1301: sub help_open_bug { 1302: my ($topic, $text, $stayOnPage, $width, $height) = @_; 1303: unless ($env{'user.adv'}) { return ''; } 1304: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; } 1305: $text = "" if (not defined $text); 1306: $stayOnPage=1; 1307: $width = 600 if (not defined $width); 1308: $height = 600 if (not defined $height); 1309: 1310: $topic=~s/\W+/\+/g; 1311: my $link=''; 1312: my $template=''; 1313: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='. 1314: &escape($ENV{'REQUEST_URI'}).'&component='.$topic; 1315: if (!$stayOnPage) 1316: { 1317: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))"; 1318: } 1319: else 1320: { 1321: $link = $url; 1322: } 1323: # Add the text 1324: if ($text ne "") 1325: { 1326: $template .= 1327: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>". 1328: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>"; 1329: } 1330: 1331: # Add the graphic 1332: my $title = &mt('Report a Bug'); 1333: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif"); 1334: $template .= <<"ENDTEMPLATE"; 1335: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a> 1336: ENDTEMPLATE 1337: if ($text ne '') { $template.='</td></tr></table>' }; 1338: return $template; 1339: 1340: } 1341: 1342: sub help_open_faq { 1343: my ($topic, $text, $stayOnPage, $width, $height) = @_; 1344: unless ($env{'user.adv'}) { return ''; } 1345: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; } 1346: $text = "" if (not defined $text); 1347: $stayOnPage=1; 1348: $width = 350 if (not defined $width); 1349: $height = 400 if (not defined $height); 1350: 1351: $topic=~s/\W+/\+/g; 1352: my $link=''; 1353: my $template=''; 1354: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html'; 1355: if (!$stayOnPage) 1356: { 1357: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))"; 1358: } 1359: else 1360: { 1361: $link = $url; 1362: } 1363: 1364: # Add the text 1365: if ($text ne "") 1366: { 1367: $template .= 1368: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>". 1369: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>"; 1370: } 1371: 1372: # Add the graphic 1373: my $title = &mt('View the FAQ'); 1374: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif"); 1375: $template .= <<"ENDTEMPLATE"; 1376: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a> 1377: ENDTEMPLATE 1378: if ($text ne '') { $template.='</td></tr></table>' }; 1379: return $template; 1380: 1381: } 1382: 1383: ############################################################### 1384: ############################################################### 1385: 1386: =pod 1387: 1388: =item * &change_content_javascript(): 1389: 1390: This and the next function allow you to create small sections of an 1391: otherwise static HTML page that you can update on the fly with 1392: Javascript, even in Netscape 4. 1393: 1394: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag) 1395: must be written to the HTML page once. It will prove the Javascript 1396: function "change(name, content)". Calling the change function with the 1397: name of the section 1398: you want to update, matching the name passed to C<changable_area>, and 1399: the new content you want to put in there, will put the content into 1400: that area. 1401: 1402: B<Note>: Netscape 4 only reserves enough space for the changable area 1403: to contain room for the original contents. You need to "make space" 1404: for whatever changes you wish to make, and be B<sure> to check your 1405: code in Netscape 4. This feature in Netscape 4 is B<not> powerful; 1406: it's adequate for updating a one-line status display, but little more. 1407: This script will set the space to 100% width, so you only need to 1408: worry about height in Netscape 4. 1409: 1410: Modern browsers are much less limiting, and if you can commit to the 1411: user not using Netscape 4, this feature may be used freely with 1412: pretty much any HTML. 1413: 1414: =cut 1415: 1416: sub change_content_javascript { 1417: # If we're on Netscape 4, we need to use Layer-based code 1418: if ($env{'browser.type'} eq 'netscape' && 1419: $env{'browser.version'} =~ /^4\./) { 1420: return (<<NETSCAPE4); 1421: function change(name, content) { 1422: doc = document.layers[name+"___escape"].layers[0].document; 1423: doc.open(); 1424: doc.write(content); 1425: doc.close(); 1426: } 1427: NETSCAPE4 1428: } else { 1429: # Otherwise, we need to use semi-standards-compliant code 1430: # (technically, "innerHTML" isn't standard but the equivalent 1431: # is really scary, and every useful browser supports it 1432: return (<<DOMBASED); 1433: function change(name, content) { 1434: element = document.getElementById(name); 1435: element.innerHTML = content; 1436: } 1437: DOMBASED 1438: } 1439: } 1440: 1441: =pod 1442: 1443: =item * &changable_area($name,$origContent): 1444: 1445: This provides a "changable area" that can be modified on the fly via 1446: the Javascript code provided in C<change_content_javascript>. $name is 1447: the name you will use to reference the area later; do not repeat the 1448: same name on a given HTML page more then once. $origContent is what 1449: the area will originally contain, which can be left blank. 1450: 1451: =cut 1452: 1453: sub changable_area { 1454: my ($name, $origContent) = @_; 1455: 1456: if ($env{'browser.type'} eq 'netscape' && 1457: $env{'browser.version'} =~ /^4\./) { 1458: # If this is netscape 4, we need to use the Layer tag 1459: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>"; 1460: } else { 1461: return "<span id='$name'>$origContent</span>"; 1462: } 1463: } 1464: 1465: =pod 1466: 1467: =item * &viewport_geometry_js 1468: 1469: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser. 1470: 1471: =cut 1472: 1473: 1474: sub viewport_geometry_js { 1475: return <<"GEOMETRY"; 1476: var Geometry = {}; 1477: function init_geometry() { 1478: if (Geometry.init) { return }; 1479: Geometry.init=1; 1480: if (window.innerHeight) { 1481: Geometry.getViewportHeight = function() { return window.innerHeight; }; 1482: Geometry.getViewportWidth = function() { return window.innerWidth; }; 1483: Geometry.getHorizontalScroll = function() { return window.pageXOffset; }; 1484: Geometry.getVerticalScroll = function() { return window.pageYOffset; }; 1485: } 1486: else if (document.documentElement && document.documentElement.clientHeight) { 1487: Geometry.getViewportHeight = 1488: function() { return document.documentElement.clientHeight; }; 1489: Geometry.getViewportWidth = 1490: function() { return document.documentElement.clientWidth; }; 1491: 1492: Geometry.getHorizontalScroll = 1493: function() { return document.documentElement.scrollLeft; }; 1494: Geometry.getVerticalScroll = 1495: function() { return document.documentElement.scrollTop; }; 1496: } 1497: else if (document.body.clientHeight) { 1498: Geometry.getViewportHeight = 1499: function() { return document.body.clientHeight; }; 1500: Geometry.getViewportWidth = 1501: function() { return document.body.clientWidth; }; 1502: Geometry.getHorizontalScroll = 1503: function() { return document.body.scrollLeft; }; 1504: Geometry.getVerticalScroll = 1505: function() { return document.body.scrollTop; }; 1506: } 1507: } 1508: 1509: GEOMETRY 1510: } 1511: 1512: =pod 1513: 1514: =item * &viewport_size_js() 1515: 1516: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 1517: 1518: =cut 1519: 1520: sub viewport_size_js { 1521: my $geometry = &viewport_geometry_js(); 1522: return <<"DIMS"; 1523: 1524: $geometry 1525: 1526: function getViewportDims(width,height) { 1527: init_geometry(); 1528: width.value = Geometry.getViewportWidth(); 1529: height.value = Geometry.getViewportHeight(); 1530: return; 1531: } 1532: 1533: DIMS 1534: } 1535: 1536: =pod 1537: 1538: =item * &resize_textarea_js() 1539: 1540: emits the needed javascript to resize a textarea to be as big as possible 1541: 1542: creates a function resize_textrea that takes two IDs first should be 1543: the id of the element to resize, second should be the id of a div that 1544: surrounds everything that comes after the textarea, this routine needs 1545: to be attached to the <body> for the onload and onresize events. 1546: 1547: =back 1548: 1549: =cut 1550: 1551: sub resize_textarea_js { 1552: my $geometry = &viewport_geometry_js(); 1553: return <<"RESIZE"; 1554: <script type="text/javascript"> 1555: // <![CDATA[ 1556: $geometry 1557: 1558: function getX(element) { 1559: var x = 0; 1560: while (element) { 1561: x += element.offsetLeft; 1562: element = element.offsetParent; 1563: } 1564: return x; 1565: } 1566: function getY(element) { 1567: var y = 0; 1568: while (element) { 1569: y += element.offsetTop; 1570: element = element.offsetParent; 1571: } 1572: return y; 1573: } 1574: 1575: 1576: function resize_textarea(textarea_id,bottom_id) { 1577: init_geometry(); 1578: var textarea = document.getElementById(textarea_id); 1579: //alert(textarea); 1580: 1581: var textarea_top = getY(textarea); 1582: var textarea_height = textarea.offsetHeight; 1583: var bottom = document.getElementById(bottom_id); 1584: var bottom_top = getY(bottom); 1585: var bottom_height = bottom.offsetHeight; 1586: var window_height = Geometry.getViewportHeight(); 1587: var fudge = 23; 1588: var new_height = window_height-fudge-textarea_top-bottom_height; 1589: if (new_height < 300) { 1590: new_height = 300; 1591: } 1592: textarea.style.height=new_height+'px'; 1593: } 1594: // ]]> 1595: </script> 1596: RESIZE 1597: 1598: } 1599: 1600: =pod 1601: 1602: =head1 Excel and CSV file utility routines 1603: 1604: =over 4 1605: 1606: =cut 1607: 1608: ############################################################### 1609: ############################################################### 1610: 1611: =pod 1612: 1613: =item * &csv_translate($text) 1614: 1615: Translate $text to allow it to be output as a 'comma separated values' 1616: format. 1617: 1618: =cut 1619: 1620: ############################################################### 1621: ############################################################### 1622: sub csv_translate { 1623: my $text = shift; 1624: $text =~ s/\"/\"\"/g; 1625: $text =~ s/\n/ /g; 1626: return $text; 1627: } 1628: 1629: ############################################################### 1630: ############################################################### 1631: 1632: =pod 1633: 1634: =item * &define_excel_formats() 1635: 1636: Define some commonly used Excel cell formats. 1637: 1638: Currently supported formats: 1639: 1640: =over 4 1641: 1642: =item header 1643: 1644: =item bold 1645: 1646: =item h1 1647: 1648: =item h2 1649: 1650: =item h3 1651: 1652: =item h4 1653: 1654: =item i 1655: 1656: =item date 1657: 1658: =back 1659: 1660: Inputs: $workbook 1661: 1662: Returns: $format, a hash reference. 1663: 1664: =cut 1665: 1666: ############################################################### 1667: ############################################################### 1668: sub define_excel_formats { 1669: my ($workbook) = @_; 1670: my $format; 1671: $format->{'header'} = $workbook->add_format(bold => 1, 1672: bottom => 1, 1673: align => 'center'); 1674: $format->{'bold'} = $workbook->add_format(bold=>1); 1675: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18); 1676: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16); 1677: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14); 1678: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12); 1679: $format->{'i'} = $workbook->add_format(italic=>1); 1680: $format->{'date'} = $workbook->add_format(num_format=> 1681: 'mm/dd/yyyy hh:mm:ss'); 1682: return $format; 1683: } 1684: 1685: ############################################################### 1686: ############################################################### 1687: 1688: =pod 1689: 1690: =item * &create_workbook() 1691: 1692: Create an Excel worksheet. If it fails, output message on the 1693: request object and return undefs. 1694: 1695: Inputs: Apache request object 1696: 1697: Returns (undef) on failure, 1698: Excel worksheet object, scalar with filename, and formats 1699: from &Apache::loncommon::define_excel_formats on success 1700: 1701: =cut 1702: 1703: ############################################################### 1704: ############################################################### 1705: sub create_workbook { 1706: my ($r) = @_; 1707: # 1708: # Create the excel spreadsheet 1709: my $filename = '/prtspool/'. 1710: $env{'user.name'}.'_'.$env{'user.domain'}.'_'. 1711: time.'_'.rand(1000000000).'.xls'; 1712: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename); 1713: if (! defined($workbook)) { 1714: $r->log_error("Error creating excel spreadsheet $filename: $!"); 1715: $r->print( 1716: '<p class="LC_error">' 1717: .&mt('Problems occurred in creating the new Excel file.') 1718: .' '.&mt('This error has been logged.') 1719: .' '.&mt('Please alert your LON-CAPA administrator.') 1720: .'</p>' 1721: ); 1722: return (undef); 1723: } 1724: # 1725: $workbook->set_tempdir('/home/httpd/perl/tmp'); 1726: # 1727: my $format = &Apache::loncommon::define_excel_formats($workbook); 1728: return ($workbook,$filename,$format); 1729: } 1730: 1731: ############################################################### 1732: ############################################################### 1733: 1734: =pod 1735: 1736: =item * &create_text_file() 1737: 1738: Create a file to write to and eventually make available to the user. 1739: If file creation fails, outputs an error message on the request object and 1740: return undefs. 1741: 1742: Inputs: Apache request object, and file suffix 1743: 1744: Returns (undef) on failure, 1745: Filehandle and filename on success. 1746: 1747: =cut 1748: 1749: ############################################################### 1750: ############################################################### 1751: sub create_text_file { 1752: my ($r,$suffix) = @_; 1753: if (! defined($suffix)) { $suffix = 'txt'; }; 1754: my $fh; 1755: my $filename = '/prtspool/'. 1756: $env{'user.name'}.'_'.$env{'user.domain'}.'_'. 1757: time.'_'.rand(1000000000).'.'.$suffix; 1758: $fh = Apache::File->new('>/home/httpd'.$filename); 1759: if (! defined($fh)) { 1760: $r->log_error("Couldn't open $filename for output $!"); 1761: $r->print( 1762: '<p class="LC_error">' 1763: .&mt('Problems occurred in creating the output file.') 1764: .' '.&mt('This error has been logged.') 1765: .' '.&mt('Please alert your LON-CAPA administrator.') 1766: .'</p>' 1767: ); 1768: } 1769: return ($fh,$filename) 1770: } 1771: 1772: 1773: =pod 1774: 1775: =back 1776: 1777: =cut 1778: 1779: ############################################################### 1780: ## Home server <option> list generating code ## 1781: ############################################################### 1782: 1783: # ------------------------------------------ 1784: 1785: sub domain_select { 1786: my ($name,$value,$multiple)=@_; 1787: my %domains=map { 1788: $_ => $_.' '. &Apache::lonnet::domain($_,'description') 1789: } &Apache::lonnet::all_domains(); 1790: if ($multiple) { 1791: $domains{''}=&mt('Any domain'); 1792: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))]; 1793: return &multiple_select_form($name,$value,4,\%domains); 1794: } else { 1795: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))]; 1796: return &select_form($name,$value,\%domains); 1797: } 1798: } 1799: 1800: #------------------------------------------- 1801: 1802: =pod 1803: 1804: =head1 Routines for form select boxes 1805: 1806: =over 4 1807: 1808: =item * &multiple_select_form($name,$value,$size,$hash,$order) 1809: 1810: Returns a string containing a <select> element int multiple mode 1811: 1812: 1813: Args: 1814: $name - name of the <select> element 1815: $value - scalar or array ref of values that should already be selected 1816: $size - number of rows long the select element is 1817: $hash - the elements should be 'option' => 'shown text' 1818: (shown text should already have been &mt()) 1819: $order - (optional) array ref of the order to show the elements in 1820: 1821: =cut 1822: 1823: #------------------------------------------- 1824: sub multiple_select_form { 1825: my ($name,$value,$size,$hash,$order)=@_; 1826: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value); 1827: my $output=''; 1828: if (! defined($size)) { 1829: $size = 4; 1830: if (scalar(keys(%$hash))<4) { 1831: $size = scalar(keys(%$hash)); 1832: } 1833: } 1834: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">'; 1835: my @order; 1836: if (ref($order) eq 'ARRAY') { 1837: @order = @{$order}; 1838: } else { 1839: @order = sort(keys(%$hash)); 1840: } 1841: if (exists($$hash{'select_form_order'})) { 1842: @order = @{$$hash{'select_form_order'}}; 1843: } 1844: 1845: foreach my $key (@order) { 1846: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" '; 1847: $output.='selected="selected" ' if ($selected{$key}); 1848: $output.='>'.$hash->{$key}."</option>\n"; 1849: } 1850: $output.="</select>\n"; 1851: return $output; 1852: } 1853: 1854: #------------------------------------------- 1855: 1856: =pod 1857: 1858: =item * &select_form($defdom,$name,$hashref,$onchange) 1859: 1860: Returns a string containing a <select name='$name' size='1'> form to 1861: allow a user to select options from a ref to a hash containing: 1862: option_name => displayed text. An optional $onchange can include 1863: a javascript onchange item, e.g., onchange="this.form.submit();" 1864: 1865: See lonrights.pm for an example invocation and use. 1866: 1867: =cut 1868: 1869: #------------------------------------------- 1870: sub select_form { 1871: my ($def,$name,$hashref,$onchange) = @_; 1872: return unless (ref($hashref) eq 'HASH'); 1873: if ($onchange) { 1874: $onchange = ' onchange="'.$onchange.'"'; 1875: } 1876: my $selectform = "<select name=\"$name\" size=\"1\"$onchange>\n"; 1877: my @keys; 1878: if (exists($hashref->{'select_form_order'})) { 1879: @keys=@{$hashref->{'select_form_order'}}; 1880: } else { 1881: @keys=sort(keys(%{$hashref})); 1882: } 1883: foreach my $key (@keys) { 1884: $selectform.= 1885: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '. 1886: ($key eq $def ? 'selected="selected" ' : ''). 1887: ">".$hashref->{$key}."</option>\n"; 1888: } 1889: $selectform.="</select>"; 1890: return $selectform; 1891: } 1892: 1893: # For display filters 1894: 1895: sub display_filter { 1896: if (!$env{'form.show'}) { $env{'form.show'}=10; } 1897: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; } 1898: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]', 1899: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef, 1900: (&mt('all'),10,20,50,100,1000,10000))). 1901: '</label></span> <span class="LC_nobreak">'. 1902: &mt('Filter [_1]', 1903: &select_form($env{'form.displayfilter'}, 1904: 'displayfilter', 1905: {'currentfolder' => 'Current folder/page', 1906: 'containing' => 'Containing phrase', 1907: 'none' => 'None'})). 1908: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>'; 1909: } 1910: 1911: sub gradeleveldescription { 1912: my $gradelevel=shift; 1913: my %gradelevels=(0 => 'Not specified', 1914: 1 => 'Grade 1', 1915: 2 => 'Grade 2', 1916: 3 => 'Grade 3', 1917: 4 => 'Grade 4', 1918: 5 => 'Grade 5', 1919: 6 => 'Grade 6', 1920: 7 => 'Grade 7', 1921: 8 => 'Grade 8', 1922: 9 => 'Grade 9', 1923: 10 => 'Grade 10', 1924: 11 => 'Grade 11', 1925: 12 => 'Grade 12', 1926: 13 => 'Grade 13', 1927: 14 => '100 Level', 1928: 15 => '200 Level', 1929: 16 => '300 Level', 1930: 17 => '400 Level', 1931: 18 => 'Graduate Level'); 1932: return &mt($gradelevels{$gradelevel}); 1933: } 1934: 1935: sub select_level_form { 1936: my ($deflevel,$name)=@_; 1937: unless ($deflevel) { $deflevel=0; } 1938: my $selectform = "<select name=\"$name\" size=\"1\">\n"; 1939: for (my $i=0; $i<=18; $i++) { 1940: $selectform.="<option value=\"$i\" ". 1941: ($i==$deflevel ? 'selected="selected" ' : ''). 1942: ">".&gradeleveldescription($i)."</option>\n"; 1943: } 1944: $selectform.="</select>"; 1945: return $selectform; 1946: } 1947: 1948: #------------------------------------------- 1949: 1950: =pod 1951: 1952: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) 1953: 1954: Returns a string containing a <select name='$name' size='1'> form to 1955: allow a user to select the domain to preform an operation in. 1956: See loncreateuser.pm for an example invocation and use. 1957: 1958: If the $includeempty flag is set, it also includes an empty choice ("no domain 1959: selected"); 1960: 1961: If the $showdomdesc flag is set, the domain name is followed by the domain description. 1962: 1963: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted. 1964: 1965: The optional $incdoms is a reference to an array of domains which will be the only available options. 1966: 1967: =cut 1968: 1969: #------------------------------------------- 1970: sub select_dom_form { 1971: my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_; 1972: if ($onchange) { 1973: $onchange = ' onchange="'.$onchange.'"'; 1974: } 1975: my @domains; 1976: if (ref($incdoms) eq 'ARRAY') { 1977: @domains = sort {lc($a) cmp lc($b)} (@{$incdoms}); 1978: } else { 1979: @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains()); 1980: } 1981: if ($includeempty) { @domains=('',@domains); } 1982: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n"; 1983: foreach my $dom (@domains) { 1984: $selectdomain.="<option value=\"$dom\" ". 1985: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom; 1986: if ($showdomdesc) { 1987: if ($dom ne '') { 1988: my $domdesc = &Apache::lonnet::domain($dom,'description'); 1989: if ($domdesc ne '') { 1990: $selectdomain .= ' ('.$domdesc.')'; 1991: } 1992: } 1993: } 1994: $selectdomain .= "</option>\n"; 1995: } 1996: $selectdomain.="</select>"; 1997: return $selectdomain; 1998: } 1999: 2000: #------------------------------------------- 2001: 2002: =pod 2003: 2004: =item * &home_server_form_item($domain,$name,$defaultflag) 2005: 2006: input: 4 arguments (two required, two optional) - 2007: $domain - domain of new user 2008: $name - name of form element 2009: $default - Value of 'default' causes a default item to be first 2010: option, and selected by default. 2011: $hide - Value of 'hide' causes hiding of the name of the server, 2012: if 1 server found, or default, if 0 found. 2013: output: returns 2 items: 2014: (a) form element which contains either: 2015: (i) <select name="$name"> 2016: <option value="$hostid1">$hostid $servers{$hostid}</option> 2017: <option value="$hostid2">$hostid $servers{$hostid}</option> 2018: </select> 2019: form item if there are multiple library servers in $domain, or 2020: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 2021: if there is only one library server in $domain. 2022: 2023: (b) number of library servers found. 2024: 2025: See loncreateuser.pm for example of use. 2026: 2027: =cut 2028: 2029: #------------------------------------------- 2030: sub home_server_form_item { 2031: my ($domain,$name,$default,$hide) = @_; 2032: my %servers = &Apache::lonnet::get_servers($domain,'library'); 2033: my $result; 2034: my $numlib = keys(%servers); 2035: if ($numlib > 1) { 2036: $result .= '<select name="'.$name.'" />'."\n"; 2037: if ($default) { 2038: $result .= '<option value="default" selected="selected">'.&mt('default'). 2039: '</option>'."\n"; 2040: } 2041: foreach my $hostid (sort(keys(%servers))) { 2042: $result.= '<option value="'.$hostid.'">'. 2043: $hostid.' '.$servers{$hostid}."</option>\n"; 2044: } 2045: $result .= '</select>'."\n"; 2046: } elsif ($numlib == 1) { 2047: my $hostid; 2048: foreach my $item (keys(%servers)) { 2049: $hostid = $item; 2050: } 2051: $result .= '<input type="hidden" name="'.$name.'" value="'. 2052: $hostid.'" />'; 2053: if (!$hide) { 2054: $result .= $hostid.' '.$servers{$hostid}; 2055: } 2056: $result .= "\n"; 2057: } elsif ($default) { 2058: $result .= '<input type="hidden" name="'.$name. 2059: '" value="default" />'; 2060: if (!$hide) { 2061: $result .= &mt('default'); 2062: } 2063: $result .= "\n"; 2064: } 2065: return ($result,$numlib); 2066: } 2067: 2068: =pod 2069: 2070: =back 2071: 2072: =cut 2073: 2074: ############################################################### 2075: ## Decoding User Agent ## 2076: ############################################################### 2077: 2078: =pod 2079: 2080: =head1 Decoding the User Agent 2081: 2082: =over 4 2083: 2084: =item * &decode_user_agent() 2085: 2086: Inputs: $r 2087: 2088: Outputs: 2089: 2090: =over 4 2091: 2092: =item * $httpbrowser 2093: 2094: =item * $clientbrowser 2095: 2096: =item * $clientversion 2097: 2098: =item * $clientmathml 2099: 2100: =item * $clientunicode 2101: 2102: =item * $clientos 2103: 2104: =back 2105: 2106: =back 2107: 2108: =cut 2109: 2110: ############################################################### 2111: ############################################################### 2112: sub decode_user_agent { 2113: my ($r)=@_; 2114: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"}); 2115: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"}); 2116: my $httpbrowser=$ENV{"HTTP_USER_AGENT"}; 2117: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); } 2118: my $clientbrowser='unknown'; 2119: my $clientversion='0'; 2120: my $clientmathml=''; 2121: my $clientunicode='0'; 2122: for (my $i=0;$i<=$#browsertype;$i++) { 2123: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]); 2124: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) { 2125: $clientbrowser=$bname; 2126: $httpbrowser=~/$vreg/i; 2127: $clientversion=$1; 2128: $clientmathml=($clientversion>=$minv); 2129: $clientunicode=($clientversion>=$univ); 2130: } 2131: } 2132: my $clientos='unknown'; 2133: if (($httpbrowser=~/linux/i) || 2134: ($httpbrowser=~/unix/i) || 2135: ($httpbrowser=~/ux/i) || 2136: ($httpbrowser=~/solaris/i)) { $clientos='unix'; } 2137: if (($httpbrowser=~/vax/i) || 2138: ($httpbrowser=~/vms/i)) { $clientos='vms'; } 2139: if ($httpbrowser=~/next/i) { $clientos='next'; } 2140: if (($httpbrowser=~/mac/i) || 2141: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; } 2142: if ($httpbrowser=~/win/i) { $clientos='win'; } 2143: if ($httpbrowser=~/embed/i) { $clientos='pda'; } 2144: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml, 2145: $clientunicode,$clientos,); 2146: } 2147: 2148: ############################################################### 2149: ## Authentication changing form generation subroutines ## 2150: ############################################################### 2151: ## 2152: ## All of the authform_xxxxxxx subroutines take their inputs in a 2153: ## hash, and have reasonable default values. 2154: ## 2155: ## formname = the name given in the <form> tag. 2156: #------------------------------------------- 2157: 2158: =pod 2159: 2160: =head1 Authentication Routines 2161: 2162: =over 4 2163: 2164: =item * &authform_xxxxxx() 2165: 2166: The authform_xxxxxx subroutines provide javascript and html forms which 2167: handle some of the conveniences required for authentication forms. 2168: This is not an optimal method, but it works. 2169: 2170: =over 4 2171: 2172: =item * authform_header 2173: 2174: =item * authform_authorwarning 2175: 2176: =item * authform_nochange 2177: 2178: =item * authform_kerberos 2179: 2180: =item * authform_internal 2181: 2182: =item * authform_filesystem 2183: 2184: =back 2185: 2186: See loncreateuser.pm for invocation and use examples. 2187: 2188: =cut 2189: 2190: #------------------------------------------- 2191: sub authform_header{ 2192: my %in = ( 2193: formname => 'cu', 2194: kerb_def_dom => '', 2195: @_, 2196: ); 2197: $in{'formname'} = 'document.' . $in{'formname'}; 2198: my $result=''; 2199: 2200: #---------------------------------------------- Code for upper case translation 2201: my $Javascript_toUpperCase; 2202: unless ($in{kerb_def_dom}) { 2203: $Javascript_toUpperCase =<<"END"; 2204: switch (choice) { 2205: case 'krb': currentform.elements[choicearg].value = 2206: currentform.elements[choicearg].value.toUpperCase(); 2207: break; 2208: default: 2209: } 2210: END 2211: } else { 2212: $Javascript_toUpperCase = ""; 2213: } 2214: 2215: my $radioval = "'nochange'"; 2216: if (defined($in{'curr_authtype'})) { 2217: if ($in{'curr_authtype'} ne '') { 2218: $radioval = "'".$in{'curr_authtype'}."arg'"; 2219: } 2220: } 2221: my $argfield = 'null'; 2222: if (defined($in{'mode'})) { 2223: if ($in{'mode'} eq 'modifycourse') { 2224: if (defined($in{'curr_autharg'})) { 2225: if ($in{'curr_autharg'} ne '') { 2226: $argfield = "'$in{'curr_autharg'}'"; 2227: } 2228: } 2229: } 2230: } 2231: 2232: $result.=<<"END"; 2233: var current = new Object(); 2234: current.radiovalue = $radioval; 2235: current.argfield = $argfield; 2236: 2237: function changed_radio(choice,currentform) { 2238: var choicearg = choice + 'arg'; 2239: // If a radio button in changed, we need to change the argfield 2240: if (current.radiovalue != choice) { 2241: current.radiovalue = choice; 2242: if (current.argfield != null) { 2243: currentform.elements[current.argfield].value = ''; 2244: } 2245: if (choice == 'nochange') { 2246: current.argfield = null; 2247: } else { 2248: current.argfield = choicearg; 2249: switch(choice) { 2250: case 'krb': 2251: currentform.elements[current.argfield].value = 2252: "$in{'kerb_def_dom'}"; 2253: break; 2254: default: 2255: break; 2256: } 2257: } 2258: } 2259: return; 2260: } 2261: 2262: function changed_text(choice,currentform) { 2263: var choicearg = choice + 'arg'; 2264: if (currentform.elements[choicearg].value !='') { 2265: $Javascript_toUpperCase 2266: // clear old field 2267: if ((current.argfield != choicearg) && (current.argfield != null)) { 2268: currentform.elements[current.argfield].value = ''; 2269: } 2270: current.argfield = choicearg; 2271: } 2272: set_auth_radio_buttons(choice,currentform); 2273: return; 2274: } 2275: 2276: function set_auth_radio_buttons(newvalue,currentform) { 2277: var numauthchoices = currentform.login.length; 2278: if (typeof numauthchoices == "undefined") { 2279: return; 2280: } 2281: var i=0; 2282: while (i < numauthchoices) { 2283: if (currentform.login[i].value == newvalue) { break; } 2284: i++; 2285: } 2286: if (i == numauthchoices) { 2287: return; 2288: } 2289: current.radiovalue = newvalue; 2290: currentform.login[i].checked = true; 2291: return; 2292: } 2293: END 2294: return $result; 2295: } 2296: 2297: sub authform_authorwarning{ 2298: my $result=''; 2299: $result='<i>'. 2300: &mt('As a general rule, only authors or co-authors should be '. 2301: 'filesystem authenticated '. 2302: '(which allows access to the server filesystem).')."</i>\n"; 2303: return $result; 2304: } 2305: 2306: sub authform_nochange{ 2307: my %in = ( 2308: formname => 'document.cu', 2309: kerb_def_dom => 'MSU.EDU', 2310: @_, 2311: ); 2312: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 2313: my $result; 2314: if (keys(%can_assign) == 0) { 2315: $result = &mt('Under you current role you are not permitted to change login settings for this user'); 2316: } else { 2317: $result = '<label>'.&mt('[_1] Do not change login data', 2318: '<input type="radio" name="login" value="nochange" '. 2319: 'checked="checked" onclick="'. 2320: "javascript:changed_radio('nochange',$in{'formname'});".'" />'). 2321: '</label>'; 2322: } 2323: return $result; 2324: } 2325: 2326: sub authform_kerberos { 2327: my %in = ( 2328: formname => 'document.cu', 2329: kerb_def_dom => 'MSU.EDU', 2330: kerb_def_auth => 'krb4', 2331: @_, 2332: ); 2333: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype, 2334: $autharg,$jscall); 2335: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 2336: if ($in{'kerb_def_auth'} eq 'krb5') { 2337: $check5 = ' checked="checked"'; 2338: } else { 2339: $check4 = ' checked="checked"'; 2340: } 2341: $krbarg = $in{'kerb_def_dom'}; 2342: if (defined($in{'curr_authtype'})) { 2343: if ($in{'curr_authtype'} eq 'krb') { 2344: $krbcheck = ' checked="checked"'; 2345: if (defined($in{'mode'})) { 2346: if ($in{'mode'} eq 'modifyuser') { 2347: $krbcheck = ''; 2348: } 2349: } 2350: if (defined($in{'curr_kerb_ver'})) { 2351: if ($in{'curr_krb_ver'} eq '5') { 2352: $check5 = ' checked="checked"'; 2353: $check4 = ''; 2354: } else { 2355: $check4 = ' checked="checked"'; 2356: $check5 = ''; 2357: } 2358: } 2359: if (defined($in{'curr_autharg'})) { 2360: $krbarg = $in{'curr_autharg'}; 2361: } 2362: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) { 2363: if (defined($in{'curr_autharg'})) { 2364: $result = 2365: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].', 2366: $in{'curr_autharg'},$krbver); 2367: } else { 2368: $result = 2369: &mt('Currently Kerberos authenticated, Version [_1].',$krbver); 2370: } 2371: return $result; 2372: } 2373: } 2374: } else { 2375: if ($authnum == 1) { 2376: $authtype = '<input type="hidden" name="login" value="krb" />'; 2377: } 2378: } 2379: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) { 2380: return; 2381: } elsif ($authtype eq '') { 2382: if (defined($in{'mode'})) { 2383: if ($in{'mode'} eq 'modifycourse') { 2384: if ($authnum == 1) { 2385: $authtype = '<input type="hidden" name="login" value="krb" />'; 2386: } 2387: } 2388: } 2389: } 2390: $jscall = "javascript:changed_radio('krb',$in{'formname'});"; 2391: if ($authtype eq '') { 2392: $authtype = '<input type="radio" name="login" value="krb" '. 2393: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'. 2394: $krbcheck.' />'; 2395: } 2396: if (($can_assign{'krb4'} && $can_assign{'krb5'}) || 2397: ($can_assign{'krb4'} && !$can_assign{'krb5'} && 2398: $in{'curr_authtype'} eq 'krb5') || 2399: (!$can_assign{'krb4'} && $can_assign{'krb5'} && 2400: $in{'curr_authtype'} eq 'krb4')) { 2401: $result .= &mt 2402: ('[_1] Kerberos authenticated with domain [_2] '. 2403: '[_3] Version 4 [_4] Version 5 [_5]', 2404: '<label>'.$authtype, 2405: '</label><input type="text" size="10" name="krbarg" '. 2406: 'value="'.$krbarg.'" '. 2407: 'onchange="'.$jscall.'" />', 2408: '<label><input type="radio" name="krbver" value="4" '.$check4.' />', 2409: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />', 2410: '</label>'); 2411: } elsif ($can_assign{'krb4'}) { 2412: $result .= &mt 2413: ('[_1] Kerberos authenticated with domain [_2] '. 2414: '[_3] Version 4 [_4]', 2415: '<label>'.$authtype, 2416: '</label><input type="text" size="10" name="krbarg" '. 2417: 'value="'.$krbarg.'" '. 2418: 'onchange="'.$jscall.'" />', 2419: '<label><input type="hidden" name="krbver" value="4" />', 2420: '</label>'); 2421: } elsif ($can_assign{'krb5'}) { 2422: $result .= &mt 2423: ('[_1] Kerberos authenticated with domain [_2] '. 2424: '[_3] Version 5 [_4]', 2425: '<label>'.$authtype, 2426: '</label><input type="text" size="10" name="krbarg" '. 2427: 'value="'.$krbarg.'" '. 2428: 'onchange="'.$jscall.'" />', 2429: '<label><input type="hidden" name="krbver" value="5" />', 2430: '</label>'); 2431: } 2432: return $result; 2433: } 2434: 2435: sub authform_internal{ 2436: my %in = ( 2437: formname => 'document.cu', 2438: kerb_def_dom => 'MSU.EDU', 2439: @_, 2440: ); 2441: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall); 2442: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 2443: if (defined($in{'curr_authtype'})) { 2444: if ($in{'curr_authtype'} eq 'int') { 2445: if ($can_assign{'int'}) { 2446: $intcheck = 'checked="checked" '; 2447: if (defined($in{'mode'})) { 2448: if ($in{'mode'} eq 'modifyuser') { 2449: $intcheck = ''; 2450: } 2451: } 2452: if (defined($in{'curr_autharg'})) { 2453: $intarg = $in{'curr_autharg'}; 2454: } 2455: } else { 2456: $result = &mt('Currently internally authenticated.'); 2457: return $result; 2458: } 2459: } 2460: } else { 2461: if ($authnum == 1) { 2462: $authtype = '<input type="hidden" name="login" value="int" />'; 2463: } 2464: } 2465: if (!$can_assign{'int'}) { 2466: return; 2467: } elsif ($authtype eq '') { 2468: if (defined($in{'mode'})) { 2469: if ($in{'mode'} eq 'modifycourse') { 2470: if ($authnum == 1) { 2471: $authtype = '<input type="hidden" name="login" value="int" />'; 2472: } 2473: } 2474: } 2475: } 2476: $jscall = "javascript:changed_radio('int',$in{'formname'});"; 2477: if ($authtype eq '') { 2478: $authtype = '<input type="radio" name="login" value="int" '.$intcheck. 2479: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />'; 2480: } 2481: $autharg = '<input type="password" size="10" name="intarg" value="'. 2482: $intarg.'" onchange="'.$jscall.'" />'; 2483: $result = &mt 2484: ('[_1] Internally authenticated (with initial password [_2])', 2485: '<label>'.$authtype,'</label>'.$autharg); 2486: $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>'; 2487: return $result; 2488: } 2489: 2490: sub authform_local{ 2491: my %in = ( 2492: formname => 'document.cu', 2493: kerb_def_dom => 'MSU.EDU', 2494: @_, 2495: ); 2496: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall); 2497: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 2498: if (defined($in{'curr_authtype'})) { 2499: if ($in{'curr_authtype'} eq 'loc') { 2500: if ($can_assign{'loc'}) { 2501: $loccheck = 'checked="checked" '; 2502: if (defined($in{'mode'})) { 2503: if ($in{'mode'} eq 'modifyuser') { 2504: $loccheck = ''; 2505: } 2506: } 2507: if (defined($in{'curr_autharg'})) { 2508: $locarg = $in{'curr_autharg'}; 2509: } 2510: } else { 2511: $result = &mt('Currently using local (institutional) authentication.'); 2512: return $result; 2513: } 2514: } 2515: } else { 2516: if ($authnum == 1) { 2517: $authtype = '<input type="hidden" name="login" value="loc" />'; 2518: } 2519: } 2520: if (!$can_assign{'loc'}) { 2521: return; 2522: } elsif ($authtype eq '') { 2523: if (defined($in{'mode'})) { 2524: if ($in{'mode'} eq 'modifycourse') { 2525: if ($authnum == 1) { 2526: $authtype = '<input type="hidden" name="login" value="loc" />'; 2527: } 2528: } 2529: } 2530: } 2531: $jscall = "javascript:changed_radio('loc',$in{'formname'});"; 2532: if ($authtype eq '') { 2533: $authtype = '<input type="radio" name="login" value="loc" '. 2534: $loccheck.' onchange="'.$jscall.'" onclick="'. 2535: $jscall.'" />'; 2536: } 2537: $autharg = '<input type="text" size="10" name="locarg" value="'. 2538: $locarg.'" onchange="'.$jscall.'" />'; 2539: $result = &mt('[_1] Local Authentication with argument [_2]', 2540: '<label>'.$authtype,'</label>'.$autharg); 2541: return $result; 2542: } 2543: 2544: sub authform_filesystem{ 2545: my %in = ( 2546: formname => 'document.cu', 2547: kerb_def_dom => 'MSU.EDU', 2548: @_, 2549: ); 2550: my ($fsyscheck,$result,$authtype,$autharg,$jscall); 2551: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'}); 2552: if (defined($in{'curr_authtype'})) { 2553: if ($in{'curr_authtype'} eq 'fsys') { 2554: if ($can_assign{'fsys'}) { 2555: $fsyscheck = 'checked="checked" '; 2556: if (defined($in{'mode'})) { 2557: if ($in{'mode'} eq 'modifyuser') { 2558: $fsyscheck = ''; 2559: } 2560: } 2561: } else { 2562: $result = &mt('Currently Filesystem Authenticated.'); 2563: return $result; 2564: } 2565: } 2566: } else { 2567: if ($authnum == 1) { 2568: $authtype = '<input type="hidden" name="login" value="fsys" />'; 2569: } 2570: } 2571: if (!$can_assign{'fsys'}) { 2572: return; 2573: } elsif ($authtype eq '') { 2574: if (defined($in{'mode'})) { 2575: if ($in{'mode'} eq 'modifycourse') { 2576: if ($authnum == 1) { 2577: $authtype = '<input type="hidden" name="login" value="fsys" />'; 2578: } 2579: } 2580: } 2581: } 2582: $jscall = "javascript:changed_radio('fsys',$in{'formname'});"; 2583: if ($authtype eq '') { 2584: $authtype = '<input type="radio" name="login" value="fsys" '. 2585: $fsyscheck.' onchange="'.$jscall.'" onclick="'. 2586: $jscall.'" />'; 2587: } 2588: $autharg = '<input type="text" size="10" name="fsysarg" value=""'. 2589: ' onchange="'.$jscall.'" />'; 2590: $result = &mt 2591: ('[_1] Filesystem Authenticated (with initial password [_2])', 2592: '<label><input type="radio" name="login" value="fsys" '. 2593: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />', 2594: '</label><input type="password" size="10" name="fsysarg" value="" '. 2595: 'onchange="'.$jscall.'" />'); 2596: return $result; 2597: } 2598: 2599: sub get_assignable_auth { 2600: my ($dom) = @_; 2601: if ($dom eq '') { 2602: $dom = $env{'request.role.domain'}; 2603: } 2604: my %can_assign = ( 2605: krb4 => 1, 2606: krb5 => 1, 2607: int => 1, 2608: loc => 1, 2609: ); 2610: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom); 2611: if (ref($domconfig{'usercreation'}) eq 'HASH') { 2612: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') { 2613: my $authhash = $domconfig{'usercreation'}{'authtypes'}; 2614: my $context; 2615: if ($env{'request.role'} =~ /^au/) { 2616: $context = 'author'; 2617: } elsif ($env{'request.role'} =~ /^dc/) { 2618: $context = 'domain'; 2619: } elsif ($env{'request.course.id'}) { 2620: $context = 'course'; 2621: } 2622: if ($context) { 2623: if (ref($authhash->{$context}) eq 'HASH') { 2624: %can_assign = %{$authhash->{$context}}; 2625: } 2626: } 2627: } 2628: } 2629: my $authnum = 0; 2630: foreach my $key (keys(%can_assign)) { 2631: if ($can_assign{$key}) { 2632: $authnum ++; 2633: } 2634: } 2635: if ($can_assign{'krb4'} && $can_assign{'krb5'}) { 2636: $authnum --; 2637: } 2638: return ($authnum,%can_assign); 2639: } 2640: 2641: ############################################################### 2642: ## Get Kerberos Defaults for Domain ## 2643: ############################################################### 2644: ## 2645: ## Returns default kerberos version and an associated argument 2646: ## as listed in file domain.tab. If not listed, provides 2647: ## appropriate default domain and kerberos version. 2648: ## 2649: #------------------------------------------- 2650: 2651: =pod 2652: 2653: =item * &get_kerberos_defaults() 2654: 2655: get_kerberos_defaults($target_domain) returns the default kerberos 2656: version and domain. If not found, it defaults to version 4 and the 2657: domain of the server. 2658: 2659: =over 4 2660: 2661: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain); 2662: 2663: =back 2664: 2665: =back 2666: 2667: =cut 2668: 2669: #------------------------------------------- 2670: sub get_kerberos_defaults { 2671: my $domain=shift; 2672: my ($krbdef,$krbdefdom); 2673: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain); 2674: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) { 2675: $krbdef = $domdefaults{'auth_def'}; 2676: $krbdefdom = $domdefaults{'auth_arg_def'}; 2677: } else { 2678: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/; 2679: my $krbdefdom=$1; 2680: $krbdefdom=~tr/a-z/A-Z/; 2681: $krbdef = "krb4"; 2682: } 2683: return ($krbdef,$krbdefdom); 2684: } 2685: 2686: 2687: ############################################################### 2688: ## Thesaurus Functions ## 2689: ############################################################### 2690: 2691: =pod 2692: 2693: =head1 Thesaurus Functions 2694: 2695: =over 4 2696: 2697: =item * &initialize_keywords() 2698: 2699: Initializes the package variable %Keywords if it is empty. Uses the 2700: package variable $thesaurus_db_file. 2701: 2702: =cut 2703: 2704: ################################################### 2705: 2706: sub initialize_keywords { 2707: return 1 if (scalar keys(%Keywords)); 2708: # If we are here, %Keywords is empty, so fill it up 2709: # Make sure the file we need exists... 2710: if (! -e $thesaurus_db_file) { 2711: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file". 2712: " failed because it does not exist"); 2713: return 0; 2714: } 2715: # Set up the hash as a database 2716: my %thesaurus_db; 2717: if (! tie(%thesaurus_db,'GDBM_File', 2718: $thesaurus_db_file,&GDBM_READER(),0640)){ 2719: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ". 2720: $thesaurus_db_file); 2721: return 0; 2722: } 2723: # Get the average number of appearances of a word. 2724: my $avecount = $thesaurus_db{'average.count'}; 2725: # Put keywords (those that appear > average) into %Keywords 2726: while (my ($word,$data)=each (%thesaurus_db)) { 2727: my ($count,undef) = split /:/,$data; 2728: $Keywords{$word}++ if ($count > $avecount); 2729: } 2730: untie %thesaurus_db; 2731: # Remove special values from %Keywords. 2732: foreach my $value ('total.count','average.count') { 2733: delete($Keywords{$value}) if (exists($Keywords{$value})); 2734: } 2735: return 1; 2736: } 2737: 2738: ################################################### 2739: 2740: =pod 2741: 2742: =item * &keyword($word) 2743: 2744: Returns true if $word is a keyword. A keyword is a word that appears more 2745: than the average number of times in the thesaurus database. Calls 2746: &initialize_keywords 2747: 2748: =cut 2749: 2750: ################################################### 2751: 2752: sub keyword { 2753: return if (!&initialize_keywords()); 2754: my $word=lc(shift()); 2755: $word=~s/\W//g; 2756: return exists($Keywords{$word}); 2757: } 2758: 2759: ############################################################### 2760: 2761: =pod 2762: 2763: =item * &get_related_words() 2764: 2765: Look up a word in the thesaurus. Takes a scalar argument and returns 2766: an array of words. If the keyword is not in the thesaurus, an empty array 2767: will be returned. The order of the words returned is determined by the 2768: database which holds them. 2769: 2770: Uses global $thesaurus_db_file. 2771: 2772: =cut 2773: 2774: ############################################################### 2775: sub get_related_words { 2776: my $keyword = shift; 2777: my %thesaurus_db; 2778: if (! -e $thesaurus_db_file) { 2779: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ". 2780: "failed because the file does not exist"); 2781: return (); 2782: } 2783: if (! tie(%thesaurus_db,'GDBM_File', 2784: $thesaurus_db_file,&GDBM_READER(),0640)){ 2785: return (); 2786: } 2787: my @Words=(); 2788: my $count=0; 2789: if (exists($thesaurus_db{$keyword})) { 2790: # The first element is the number of times 2791: # the word appears. We do not need it now. 2792: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword})); 2793: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]); 2794: my $threshold=$mostfrequentcount/10; 2795: foreach my $possibleword (@RelatedWords) { 2796: my ($word,$wordcount)=split(/\,/,$possibleword); 2797: if ($wordcount>$threshold) { 2798: push(@Words,$word); 2799: $count++; 2800: if ($count>10) { last; } 2801: } 2802: } 2803: } 2804: untie %thesaurus_db; 2805: return @Words; 2806: } 2807: 2808: =pod 2809: 2810: =back 2811: 2812: =cut 2813: 2814: # -------------------------------------------------------------- Plaintext name 2815: =pod 2816: 2817: =head1 User Name Functions 2818: 2819: =over 4 2820: 2821: =item * &plainname($uname,$udom,$first) 2822: 2823: Takes a users logon name and returns it as a string in 2824: "first middle last generation" form 2825: if $first is set to 'lastname' then it returns it as 2826: 'lastname generation, firstname middlename' if their is a lastname 2827: 2828: =cut 2829: 2830: 2831: ############################################################### 2832: sub plainname { 2833: my ($uname,$udom,$first)=@_; 2834: return if (!defined($uname) || !defined($udom)); 2835: my %names=&getnames($uname,$udom); 2836: my $name=&Apache::lonnet::format_name($names{'firstname'}, 2837: $names{'middlename'}, 2838: $names{'lastname'}, 2839: $names{'generation'},$first); 2840: $name=~s/^\s+//; 2841: $name=~s/\s+$//; 2842: $name=~s/\s+/ /g; 2843: if ($name !~ /\S/) { $name=$uname.':'.$udom; } 2844: return $name; 2845: } 2846: 2847: # -------------------------------------------------------------------- Nickname 2848: =pod 2849: 2850: =item * &nickname($uname,$udom) 2851: 2852: Gets a users name and returns it as a string as 2853: 2854: ""nickname"" 2855: 2856: if the user has a nickname or 2857: 2858: "first middle last generation" 2859: 2860: if the user does not 2861: 2862: =cut 2863: 2864: sub nickname { 2865: my ($uname,$udom)=@_; 2866: return if (!defined($uname) || !defined($udom)); 2867: my %names=&getnames($uname,$udom); 2868: my $name=$names{'nickname'}; 2869: if ($name) { 2870: $name='"'.$name.'"'; 2871: } else { 2872: $name=$names{'firstname'}.' '.$names{'middlename'}.' '. 2873: $names{'lastname'}.' '.$names{'generation'}; 2874: $name=~s/\s+$//; 2875: $name=~s/\s+/ /g; 2876: } 2877: return $name; 2878: } 2879: 2880: sub getnames { 2881: my ($uname,$udom)=@_; 2882: return if (!defined($uname) || !defined($udom)); 2883: if ($udom eq 'public' && $uname eq 'public') { 2884: return ('lastname' => &mt('Public')); 2885: } 2886: my $id=$uname.':'.$udom; 2887: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id); 2888: if ($cached) { 2889: return %{$names}; 2890: } else { 2891: my %loadnames=&Apache::lonnet::get('environment', 2892: ['firstname','middlename','lastname','generation','nickname'], 2893: $udom,$uname); 2894: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames); 2895: return %loadnames; 2896: } 2897: } 2898: 2899: # -------------------------------------------------------------------- getemails 2900: 2901: =pod 2902: 2903: =item * &getemails($uname,$udom) 2904: 2905: Gets a user's email information and returns it as a hash with keys: 2906: notification, critnotification, permanentemail 2907: 2908: For notification and critnotification, values are comma-separated lists 2909: of e-mail addresses; for permanentemail, value is a single e-mail address. 2910: 2911: 2912: =cut 2913: 2914: 2915: sub getemails { 2916: my ($uname,$udom)=@_; 2917: if ($udom eq 'public' && $uname eq 'public') { 2918: return; 2919: } 2920: if (!$udom) { $udom=$env{'user.domain'}; } 2921: if (!$uname) { $uname=$env{'user.name'}; } 2922: my $id=$uname.':'.$udom; 2923: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id); 2924: if ($cached) { 2925: return %{$names}; 2926: } else { 2927: my %loadnames=&Apache::lonnet::get('environment', 2928: ['notification','critnotification', 2929: 'permanentemail'], 2930: $udom,$uname); 2931: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames); 2932: return %loadnames; 2933: } 2934: } 2935: 2936: sub flush_email_cache { 2937: my ($uname,$udom)=@_; 2938: if (!$udom) { $udom =$env{'user.domain'}; } 2939: if (!$uname) { $uname=$env{'user.name'}; } 2940: return if ($udom eq 'public' && $uname eq 'public'); 2941: my $id=$uname.':'.$udom; 2942: &Apache::lonnet::devalidate_cache_new('emailscache',$id); 2943: } 2944: 2945: # -------------------------------------------------------------------- getlangs 2946: 2947: =pod 2948: 2949: =item * &getlangs($uname,$udom) 2950: 2951: Gets a user's language preference and returns it as a hash with key: 2952: language. 2953: 2954: =cut 2955: 2956: 2957: sub getlangs { 2958: my ($uname,$udom) = @_; 2959: if (!$udom) { $udom =$env{'user.domain'}; } 2960: if (!$uname) { $uname=$env{'user.name'}; } 2961: my $id=$uname.':'.$udom; 2962: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id); 2963: if ($cached) { 2964: return %{$langs}; 2965: } else { 2966: my %loadlangs=&Apache::lonnet::get('environment',['languages'], 2967: $udom,$uname); 2968: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs); 2969: return %loadlangs; 2970: } 2971: } 2972: 2973: sub flush_langs_cache { 2974: my ($uname,$udom)=@_; 2975: if (!$udom) { $udom =$env{'user.domain'}; } 2976: if (!$uname) { $uname=$env{'user.name'}; } 2977: return if ($udom eq 'public' && $uname eq 'public'); 2978: my $id=$uname.':'.$udom; 2979: &Apache::lonnet::devalidate_cache_new('userlangs',$id); 2980: } 2981: 2982: # ------------------------------------------------------------------ Screenname 2983: 2984: =pod 2985: 2986: =item * &screenname($uname,$udom) 2987: 2988: Gets a users screenname and returns it as a string 2989: 2990: =cut 2991: 2992: sub screenname { 2993: my ($uname,$udom)=@_; 2994: if ($uname eq $env{'user.name'} && 2995: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};} 2996: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname); 2997: return $names{'screenname'}; 2998: } 2999: 3000: 3001: # ------------------------------------------------------------- Confirm Wrapper 3002: =pod 3003: 3004: =item confirmwrapper 3005: 3006: Wrap messages about completion of operation in box 3007: 3008: =cut 3009: 3010: sub confirmwrapper { 3011: my ($message)=@_; 3012: if ($message) { 3013: return "\n".'<div class="LC_confirm_box">'."\n" 3014: .$message."\n" 3015: .'</div>'."\n"; 3016: } else { 3017: return $message; 3018: } 3019: } 3020: 3021: # ------------------------------------------------------------- Message Wrapper 3022: 3023: sub messagewrapper { 3024: my ($link,$username,$domain,$subject,$text)=@_; 3025: return 3026: '<a href="/adm/email?compose=individual&'. 3027: 'recname='.$username.'&recdom='.$domain. 3028: '&subject='.&escape($subject).'&text='.&escape($text).'" '. 3029: 'title="'.&mt('Send message').'">'.$link.'</a>'; 3030: } 3031: 3032: # --------------------------------------------------------------- Notes Wrapper 3033: 3034: sub noteswrapper { 3035: my ($link,$un,$do)=@_; 3036: return 3037: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>"; 3038: } 3039: 3040: # ------------------------------------------------------------- Aboutme Wrapper 3041: 3042: sub aboutmewrapper { 3043: my ($link,$username,$domain,$target)=@_; 3044: if (!defined($username) && !defined($domain)) { 3045: return; 3046: } 3047: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'. 3048: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>'; 3049: } 3050: 3051: # ------------------------------------------------------------ Syllabus Wrapper 3052: 3053: sub syllabuswrapper { 3054: my ($linktext,$coursedir,$domain)=@_; 3055: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>}; 3056: } 3057: 3058: # ----------------------------------------------------------------------------- 3059: 3060: sub track_student_link { 3061: my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_; 3062: my $link ="/adm/trackstudent?"; 3063: my $title = 'View recent activity'; 3064: if (defined($sname) && $sname !~ /^\s*$/ && 3065: defined($sdom) && $sdom !~ /^\s*$/) { 3066: $link .= "selected_student=$sname:$sdom"; 3067: $title .= ' of this student'; 3068: } 3069: if (defined($target) && $target !~ /^\s*$/) { 3070: $target = qq{target="$target"}; 3071: } else { 3072: $target = ''; 3073: } 3074: if ($start) { $link.='&start='.$start; } 3075: if ($only_body) { $link .= '&only_body=1'; } 3076: $title = &mt($title); 3077: $linktext = &mt($linktext); 3078: return qq{<a href="$link" title="$title" $target>$linktext</a>}. 3079: &help_open_topic('View_recent_activity'); 3080: } 3081: 3082: sub slot_reservations_link { 3083: my ($linktext,$sname,$sdom,$target) = @_; 3084: my $link ="/adm/slotrequest?command=showresv&origin=aboutme"; 3085: my $title = 'View slot reservation history'; 3086: if (defined($sname) && $sname !~ /^\s*$/ && 3087: defined($sdom) && $sdom !~ /^\s*$/) { 3088: $link .= "&uname=$sname&udom=$sdom"; 3089: $title .= ' of this student'; 3090: } 3091: if (defined($target) && $target !~ /^\s*$/) { 3092: $target = qq{target="$target"}; 3093: } else { 3094: $target = ''; 3095: } 3096: $title = &mt($title); 3097: $linktext = &mt($linktext); 3098: return qq{<a href="$link" title="$title" $target>$linktext</a>}; 3099: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History'); 3100: 3101: } 3102: 3103: # ===================================================== Display a student photo 3104: 3105: 3106: sub student_image_tag { 3107: my ($domain,$user)=@_; 3108: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg'); 3109: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) { 3110: return '<img src="'.$imgsrc.'" align="right" />'; 3111: } else { 3112: return ''; 3113: } 3114: } 3115: 3116: =pod 3117: 3118: =back 3119: 3120: =head1 Access .tab File Data 3121: 3122: =over 4 3123: 3124: =item * &languageids() 3125: 3126: returns list of all language ids 3127: 3128: =cut 3129: 3130: sub languageids { 3131: return sort(keys(%language)); 3132: } 3133: 3134: =pod 3135: 3136: =item * &languagedescription() 3137: 3138: returns description of a specified language id 3139: 3140: =cut 3141: 3142: sub languagedescription { 3143: my $code=shift; 3144: return ($supported_language{$code}?'* ':''). 3145: $language{$code}. 3146: ($supported_language{$code}?' ('.&mt('interface available').')':''); 3147: } 3148: 3149: sub plainlanguagedescription { 3150: my $code=shift; 3151: return $language{$code}; 3152: } 3153: 3154: sub supportedlanguagecode { 3155: my $code=shift; 3156: return $supported_language{$code}; 3157: } 3158: 3159: =pod 3160: 3161: =item * ©rightids() 3162: 3163: returns list of all copyrights 3164: 3165: =cut 3166: 3167: sub copyrightids { 3168: return sort(keys(%cprtag)); 3169: } 3170: 3171: =pod 3172: 3173: =item * ©rightdescription() 3174: 3175: returns description of a specified copyright id 3176: 3177: =cut 3178: 3179: sub copyrightdescription { 3180: return &mt($cprtag{shift(@_)}); 3181: } 3182: 3183: =pod 3184: 3185: =item * &source_copyrightids() 3186: 3187: returns list of all source copyrights 3188: 3189: =cut 3190: 3191: sub source_copyrightids { 3192: return sort(keys(%scprtag)); 3193: } 3194: 3195: =pod 3196: 3197: =item * &source_copyrightdescription() 3198: 3199: returns description of a specified source copyright id 3200: 3201: =cut 3202: 3203: sub source_copyrightdescription { 3204: return &mt($scprtag{shift(@_)}); 3205: } 3206: 3207: =pod 3208: 3209: =item * &filecategories() 3210: 3211: returns list of all file categories 3212: 3213: =cut 3214: 3215: sub filecategories { 3216: return sort(keys(%category_extensions)); 3217: } 3218: 3219: =pod 3220: 3221: =item * &filecategorytypes() 3222: 3223: returns list of file types belonging to a given file 3224: category 3225: 3226: =cut 3227: 3228: sub filecategorytypes { 3229: my ($cat) = @_; 3230: return @{$category_extensions{lc($cat)}}; 3231: } 3232: 3233: =pod 3234: 3235: =item * &fileembstyle() 3236: 3237: returns embedding style for a specified file type 3238: 3239: =cut 3240: 3241: sub fileembstyle { 3242: return $fe{lc(shift(@_))}; 3243: } 3244: 3245: sub filemimetype { 3246: return $fm{lc(shift(@_))}; 3247: } 3248: 3249: 3250: sub filecategoryselect { 3251: my ($name,$value)=@_; 3252: return &select_form($value,$name, 3253: {'' => &mt('Any category'), map { $_,$_ } sort(keys(%category_extensions))}); 3254: } 3255: 3256: =pod 3257: 3258: =item * &filedescription() 3259: 3260: returns description for a specified file type 3261: 3262: =cut 3263: 3264: sub filedescription { 3265: my $file_description = $fd{lc(shift())}; 3266: $file_description =~ s:([\[\]]):~$1:g; 3267: return &mt($file_description); 3268: } 3269: 3270: =pod 3271: 3272: =item * &filedescriptionex() 3273: 3274: returns description for a specified file type with 3275: extra formatting 3276: 3277: =cut 3278: 3279: sub filedescriptionex { 3280: my $ex=shift; 3281: my $file_description = $fd{lc($ex)}; 3282: $file_description =~ s:([\[\]]):~$1:g; 3283: return '.'.$ex.' '.&mt($file_description); 3284: } 3285: 3286: # End of .tab access 3287: =pod 3288: 3289: =back 3290: 3291: =cut 3292: 3293: # ------------------------------------------------------------------ File Types 3294: sub fileextensions { 3295: return sort(keys(%fe)); 3296: } 3297: 3298: # ----------------------------------------------------------- Display Languages 3299: # returns a hash with all desired display languages 3300: # 3301: 3302: sub display_languages { 3303: my %languages=(); 3304: foreach my $lang (&Apache::lonlocal::preferred_languages()) { 3305: $languages{$lang}=1; 3306: } 3307: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']); 3308: if ($env{'form.displaylanguage'}) { 3309: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) { 3310: $languages{$lang}=1; 3311: } 3312: } 3313: return %languages; 3314: } 3315: 3316: sub languages { 3317: my ($possible_langs) = @_; 3318: my @preferred_langs = &Apache::lonlocal::preferred_languages(); 3319: if (!ref($possible_langs)) { 3320: if( wantarray ) { 3321: return @preferred_langs; 3322: } else { 3323: return $preferred_langs[0]; 3324: } 3325: } 3326: my %possibilities = map { $_ => 1 } (@$possible_langs); 3327: my @preferred_possibilities; 3328: foreach my $preferred_lang (@preferred_langs) { 3329: if (exists($possibilities{$preferred_lang})) { 3330: push(@preferred_possibilities, $preferred_lang); 3331: } 3332: } 3333: if( wantarray ) { 3334: return @preferred_possibilities; 3335: } 3336: return $preferred_possibilities[0]; 3337: } 3338: 3339: sub user_lang { 3340: my ($touname,$toudom,$fromcid) = @_; 3341: my @userlangs; 3342: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) { 3343: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/, 3344: $env{'course.'.$fromcid.'.languages'})); 3345: } else { 3346: my %langhash = &getlangs($touname,$toudom); 3347: if ($langhash{'languages'} ne '') { 3348: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'}); 3349: } else { 3350: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom); 3351: if ($domdefs{'lang_def'} ne '') { 3352: @userlangs = ($domdefs{'lang_def'}); 3353: } 3354: } 3355: } 3356: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs); 3357: my $user_lh = Apache::localize->get_handle(@languages); 3358: return $user_lh; 3359: } 3360: 3361: 3362: ############################################################### 3363: ## Student Answer Attempts ## 3364: ############################################################### 3365: 3366: =pod 3367: 3368: =head1 Alternate Problem Views 3369: 3370: =over 4 3371: 3372: =item * &get_previous_attempt($symb, $username, $domain, $course, 3373: $getattempt, $regexp, $gradesub) 3374: 3375: Return string with previous attempt on problem. Arguments: 3376: 3377: =over 4 3378: 3379: =item * $symb: Problem, including path 3380: 3381: =item * $username: username of the desired student 3382: 3383: =item * $domain: domain of the desired student 3384: 3385: =item * $course: Course ID 3386: 3387: =item * $getattempt: Leave blank for all attempts, otherwise put 3388: something 3389: 3390: =item * $regexp: if string matches this regexp, the string will be 3391: sent to $gradesub 3392: 3393: =item * $gradesub: routine that processes the string if it matches $regexp 3394: 3395: =back 3396: 3397: The output string is a table containing all desired attempts, if any. 3398: 3399: =cut 3400: 3401: sub get_previous_attempt { 3402: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_; 3403: my $prevattempts=''; 3404: no strict 'refs'; 3405: if ($symb) { 3406: my (%returnhash)= 3407: &Apache::lonnet::restore($symb,$course,$domain,$username); 3408: if ($returnhash{'version'}) { 3409: my %lasthash=(); 3410: my $version; 3411: for ($version=1;$version<=$returnhash{'version'};$version++) { 3412: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) { 3413: $lasthash{$key}=$returnhash{$version.':'.$key}; 3414: } 3415: } 3416: $prevattempts=&start_data_table().&start_data_table_header_row(); 3417: $prevattempts.='<th>'.&mt('History').'</th>'; 3418: my (%typeparts,%lasthidden); 3419: my $showsurv=&Apache::lonnet::allowed('vas',$env{'request.course.id'}); 3420: foreach my $key (sort(keys(%lasthash))) { 3421: my ($ign,@parts) = split(/\./,$key); 3422: if ($#parts > 0) { 3423: my $data=$parts[-1]; 3424: next if ($data eq 'foilorder'); 3425: pop(@parts); 3426: if ($data eq 'type') { 3427: unless ($showsurv) { 3428: my $id = join(',',@parts); 3429: $typeparts{$ign.'.'.$id} = $lasthash{$key}; 3430: if (($lasthash{$key} eq 'anonsurvey') || ($lasthash{$key} eq 'anonsurveycred')) { 3431: $lasthidden{$ign.'.'.$id} = 1; 3432: } 3433: } 3434: delete($lasthash{$key}); 3435: } else { 3436: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>'; 3437: } 3438: } else { 3439: if ($#parts == 0) { 3440: $prevattempts.='<th>'.$parts[0].'</th>'; 3441: } else { 3442: $prevattempts.='<th>'.$ign.'</th>'; 3443: } 3444: } 3445: } 3446: $prevattempts.=&end_data_table_header_row(); 3447: if ($getattempt eq '') { 3448: for ($version=1;$version<=$returnhash{'version'};$version++) { 3449: my @hidden; 3450: if (%typeparts) { 3451: foreach my $id (keys(%typeparts)) { 3452: if (($returnhash{$version.':'.$id.'.type'} eq 'anonsurvey') || ($returnhash{$version.':'.$id.'.type'} eq 'anonsurveycred')) { 3453: push(@hidden,$id); 3454: } 3455: } 3456: } 3457: $prevattempts.=&start_data_table_row(). 3458: '<td>'.&mt('Transaction [_1]',$version).'</td>'; 3459: if (@hidden) { 3460: foreach my $key (sort(keys(%lasthash))) { 3461: next if ($key =~ /\.foilorder$/); 3462: my $hide; 3463: foreach my $id (@hidden) { 3464: if ($key =~ /^\Q$id\E/) { 3465: $hide = 1; 3466: last; 3467: } 3468: } 3469: if ($hide) { 3470: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/); 3471: if (($data eq 'award') || ($data eq 'awarddetail')) { 3472: my $value = &format_previous_attempt_value($key, 3473: $returnhash{$version.':'.$key}); 3474: $prevattempts.='<td>'.$value.' </td>'; 3475: } else { 3476: $prevattempts.='<td> </td>'; 3477: } 3478: } else { 3479: if ($key =~ /\./) { 3480: my $value = &format_previous_attempt_value($key, 3481: $returnhash{$version.':'.$key}); 3482: $prevattempts.='<td>'.$value.' </td>'; 3483: } else { 3484: $prevattempts.='<td> </td>'; 3485: } 3486: } 3487: } 3488: } else { 3489: foreach my $key (sort(keys(%lasthash))) { 3490: next if ($key =~ /\.foilorder$/); 3491: my $value = &format_previous_attempt_value($key, 3492: $returnhash{$version.':'.$key}); 3493: $prevattempts.='<td>'.$value.' </td>'; 3494: } 3495: } 3496: $prevattempts.=&end_data_table_row(); 3497: } 3498: } 3499: my @currhidden = keys(%lasthidden); 3500: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>'; 3501: foreach my $key (sort(keys(%lasthash))) { 3502: next if ($key =~ /\.foilorder$/); 3503: if (%typeparts) { 3504: my $hidden; 3505: foreach my $id (@currhidden) { 3506: if ($key =~ /^\Q$id\E/) { 3507: $hidden = 1; 3508: last; 3509: } 3510: } 3511: if ($hidden) { 3512: my ($id,$data) = ($key =~ /^(.+)\.([^.]+)$/); 3513: if (($data eq 'award') || ($data eq 'awarddetail')) { 3514: my $value = &format_previous_attempt_value($key,$lasthash{$key}); 3515: if ($key =~/$regexp$/ && (defined &$gradesub)) { 3516: $value = &$gradesub($value); 3517: } 3518: $prevattempts.='<td>'.$value.' </td>'; 3519: } else { 3520: $prevattempts.='<td> </td>'; 3521: } 3522: } else { 3523: my $value = &format_previous_attempt_value($key,$lasthash{$key}); 3524: if ($key =~/$regexp$/ && (defined &$gradesub)) { 3525: $value = &$gradesub($value); 3526: } 3527: $prevattempts.='<td>'.$value.' </td>'; 3528: } 3529: } else { 3530: my $value = &format_previous_attempt_value($key,$lasthash{$key}); 3531: if ($key =~/$regexp$/ && (defined &$gradesub)) { 3532: $value = &$gradesub($value); 3533: } 3534: $prevattempts.='<td>'.$value.' </td>'; 3535: } 3536: } 3537: $prevattempts.= &end_data_table_row().&end_data_table(); 3538: } else { 3539: $prevattempts= 3540: &start_data_table().&start_data_table_row(). 3541: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'. 3542: &end_data_table_row().&end_data_table(); 3543: } 3544: } else { 3545: $prevattempts= 3546: &start_data_table().&start_data_table_row(). 3547: '<td>'.&mt('No data.').'</td>'. 3548: &end_data_table_row().&end_data_table(); 3549: } 3550: } 3551: 3552: sub format_previous_attempt_value { 3553: my ($key,$value) = @_; 3554: if ($key =~ /timestamp/) { 3555: $value = &Apache::lonlocal::locallocaltime($value); 3556: } elsif (ref($value) eq 'ARRAY') { 3557: $value = '('.join(', ', @{ $value }).')'; 3558: } elsif ($key =~ /answerstring$/) { 3559: my %answers = &Apache::lonnet::str2hash($value); 3560: my @anskeys = sort(keys(%answers)); 3561: if (@anskeys == 1) { 3562: my $answer = $answers{$anskeys[0]}; 3563: if ($answer =~ m{\Q\0\E}) { 3564: $answer =~ s{\Q\0\E}{, }g; 3565: } 3566: my $tag_internal_answer_name = 'INTERNAL'; 3567: if ($anskeys[0] eq $tag_internal_answer_name) { 3568: $value = $answer; 3569: } else { 3570: $value = $anskeys[0].'='.$answer; 3571: } 3572: } else { 3573: foreach my $ans (@anskeys) { 3574: my $answer = $answers{$ans}; 3575: if ($answer =~ m{\Q\0\E}) { 3576: $answer =~ s{\Q\0\E}{, }g; 3577: } 3578: $value .= $ans.'='.$answer.'<br />';; 3579: } 3580: } 3581: } else { 3582: $value = &unescape($value); 3583: } 3584: return $value; 3585: } 3586: 3587: 3588: sub relative_to_absolute { 3589: my ($url,$output)=@_; 3590: my $parser=HTML::TokeParser->new(\$output); 3591: my $token; 3592: my $thisdir=$url; 3593: my @rlinks=(); 3594: while ($token=$parser->get_token) { 3595: if ($token->[0] eq 'S') { 3596: if ($token->[1] eq 'a') { 3597: if ($token->[2]->{'href'}) { 3598: $rlinks[$#rlinks+1]=$token->[2]->{'href'}; 3599: } 3600: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) { 3601: $rlinks[$#rlinks+1]=$token->[2]->{'src'}; 3602: } elsif ($token->[1] eq 'base') { 3603: $thisdir=$token->[2]->{'href'}; 3604: } 3605: } 3606: } 3607: $thisdir=~s-/[^/]*$--; 3608: foreach my $link (@rlinks) { 3609: unless (($link=~/^https?\:\/\//i) || 3610: ($link=~/^\//) || 3611: ($link=~/^javascript:/i) || 3612: ($link=~/^mailto:/i) || 3613: ($link=~/^\#/)) { 3614: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link); 3615: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/; 3616: } 3617: } 3618: # -------------------------------------------------- Deal with Applet codebases 3619: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei; 3620: return $output; 3621: } 3622: 3623: =pod 3624: 3625: =item * &get_student_view() 3626: 3627: show a snapshot of what student was looking at 3628: 3629: =cut 3630: 3631: sub get_student_view { 3632: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_; 3633: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb); 3634: my (%form); 3635: my @elements=('symb','courseid','domain','username'); 3636: foreach my $element (@elements) { 3637: $form{'grade_'.$element}=eval '$'.$element #' 3638: } 3639: if (defined($moreenv)) { 3640: %form=(%form,%{$moreenv}); 3641: } 3642: if (defined($target)) { $form{'grade_target'} = $target; } 3643: $feedurl=&Apache::lonnet::clutter($feedurl); 3644: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form); 3645: $userview=~s/\<body[^\>]*\>//gi; 3646: $userview=~s/\<\/body\>//gi; 3647: $userview=~s/\<html\>//gi; 3648: $userview=~s/\<\/html\>//gi; 3649: $userview=~s/\<head\>//gi; 3650: $userview=~s/\<\/head\>//gi; 3651: $userview=~s/action\s*\=/would_be_action\=/gi; 3652: $userview=&relative_to_absolute($feedurl,$userview); 3653: if (wantarray) { 3654: return ($userview,$response); 3655: } else { 3656: return $userview; 3657: } 3658: } 3659: 3660: sub get_student_view_with_retries { 3661: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_; 3662: 3663: my $ok = 0; # True if we got a good response. 3664: my $content; 3665: my $response; 3666: 3667: # Try to get the student_view done. within the retries count: 3668: 3669: do { 3670: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv); 3671: $ok = $response->is_success; 3672: if (!$ok) { 3673: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message); 3674: } 3675: $retries--; 3676: } while (!$ok && ($retries > 0)); 3677: 3678: if (!$ok) { 3679: $content = ''; # On error return an empty content. 3680: } 3681: if (wantarray) { 3682: return ($content, $response); 3683: } else { 3684: return $content; 3685: } 3686: } 3687: 3688: =pod 3689: 3690: =item * &get_student_answers() 3691: 3692: show a snapshot of how student was answering problem 3693: 3694: =cut 3695: 3696: sub get_student_answers { 3697: my ($symb,$username,$domain,$courseid,%form) = @_; 3698: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb); 3699: my (%moreenv); 3700: my @elements=('symb','courseid','domain','username'); 3701: foreach my $element (@elements) { 3702: $moreenv{'grade_'.$element}=eval '$'.$element #' 3703: } 3704: $moreenv{'grade_target'}='answer'; 3705: %moreenv=(%form,%moreenv); 3706: $feedurl = &Apache::lonnet::clutter($feedurl); 3707: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv); 3708: return $userview; 3709: } 3710: 3711: =pod 3712: 3713: =item * &submlink() 3714: 3715: Inputs: $text $uname $udom $symb $target 3716: 3717: Returns: A link to grades.pm such as to see the SUBM view of a student 3718: 3719: =cut 3720: 3721: ############################################### 3722: sub submlink { 3723: my ($text,$uname,$udom,$symb,$target)=@_; 3724: if (!($uname && $udom)) { 3725: (my $cursymb, my $courseid,$udom,$uname)= 3726: &Apache::lonnet::whichuser($symb); 3727: if (!$symb) { $symb=$cursymb; } 3728: } 3729: if (!$symb) { $symb=&Apache::lonnet::symbread(); } 3730: $symb=&escape($symb); 3731: if ($target) { $target=" target=\"$target\""; } 3732: return 3733: '<a href="/adm/grades?command=submission'. 3734: '&symb='.$symb. 3735: '&student='.$uname. 3736: '&userdom='.$udom.'"'. 3737: $target.'>'.$text.'</a>'; 3738: } 3739: ############################################## 3740: 3741: =pod 3742: 3743: =item * &pgrdlink() 3744: 3745: Inputs: $text $uname $udom $symb $target 3746: 3747: Returns: A link to grades.pm such as to see the PGRD view of a student 3748: 3749: =cut 3750: 3751: ############################################### 3752: sub pgrdlink { 3753: my $link=&submlink(@_); 3754: $link=~s/(&command=submission)/$1&showgrading=yes/; 3755: return $link; 3756: } 3757: ############################################## 3758: 3759: =pod 3760: 3761: =item * &pprmlink() 3762: 3763: Inputs: $text $uname $udom $symb $target 3764: 3765: Returns: A link to parmset.pm such as to see the PPRM view of a 3766: student and a specific resource 3767: 3768: =cut 3769: 3770: ############################################### 3771: sub pprmlink { 3772: my ($text,$uname,$udom,$symb,$target)=@_; 3773: if (!($uname && $udom)) { 3774: (my $cursymb, my $courseid,$udom,$uname)= 3775: &Apache::lonnet::whichuser($symb); 3776: if (!$symb) { $symb=$cursymb; } 3777: } 3778: if (!$symb) { $symb=&Apache::lonnet::symbread(); } 3779: $symb=&escape($symb); 3780: if ($target) { $target="target=\"$target\""; } 3781: return '<a href="/adm/parmset?command=set&'. 3782: 'symb='.$symb.'&uname='.$uname. 3783: '&udom='.$udom.'" '.$target.'>'.$text.'</a>'; 3784: } 3785: ############################################## 3786: 3787: =pod 3788: 3789: =back 3790: 3791: =cut 3792: 3793: ############################################### 3794: 3795: 3796: sub timehash { 3797: my ($thistime) = @_; 3798: my $timezone = &Apache::lonlocal::gettimezone(); 3799: my $dt = DateTime->from_epoch(epoch => $thistime) 3800: ->set_time_zone($timezone); 3801: my $wday = $dt->day_of_week(); 3802: if ($wday == 7) { $wday = 0; } 3803: return ( 'second' => $dt->second(), 3804: 'minute' => $dt->minute(), 3805: 'hour' => $dt->hour(), 3806: 'day' => $dt->day_of_month(), 3807: 'month' => $dt->month(), 3808: 'year' => $dt->year(), 3809: 'weekday' => $wday, 3810: 'dayyear' => $dt->day_of_year(), 3811: 'dlsav' => $dt->is_dst() ); 3812: } 3813: 3814: sub utc_string { 3815: my ($date)=@_; 3816: return strftime("%Y%m%dT%H%M%SZ",gmtime($date)); 3817: } 3818: 3819: sub maketime { 3820: my %th=@_; 3821: my ($epoch_time,$timezone,$dt); 3822: $timezone = &Apache::lonlocal::gettimezone(); 3823: eval { 3824: $dt = DateTime->new( year => $th{'year'}, 3825: month => $th{'month'}, 3826: day => $th{'day'}, 3827: hour => $th{'hour'}, 3828: minute => $th{'minute'}, 3829: second => $th{'second'}, 3830: time_zone => $timezone, 3831: ); 3832: }; 3833: if (!$@) { 3834: $epoch_time = $dt->epoch; 3835: if ($epoch_time) { 3836: return $epoch_time; 3837: } 3838: } 3839: return POSIX::mktime( 3840: ($th{'seconds'},$th{'minutes'},$th{'hours'}, 3841: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1)); 3842: } 3843: 3844: ######################################### 3845: 3846: sub findallcourses { 3847: my ($roles,$uname,$udom) = @_; 3848: my %roles; 3849: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; } 3850: my %courses; 3851: my $now=time; 3852: if (!defined($uname)) { 3853: $uname = $env{'user.name'}; 3854: } 3855: if (!defined($udom)) { 3856: $udom = $env{'user.domain'}; 3857: } 3858: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) { 3859: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1}); 3860: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef, 3861: $extra); 3862: if (!%roles) { 3863: %roles = ( 3864: cc => 1, 3865: co => 1, 3866: in => 1, 3867: ep => 1, 3868: ta => 1, 3869: cr => 1, 3870: st => 1, 3871: ); 3872: } 3873: foreach my $entry (keys(%roleshash)) { 3874: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry}); 3875: if ($trole =~ /^cr/) { 3876: next if (!exists($roles{$trole}) && !exists($roles{'cr'})); 3877: } else { 3878: next if (!exists($roles{$trole})); 3879: } 3880: if ($tend) { 3881: next if ($tend < $now); 3882: } 3883: if ($tstart) { 3884: next if ($tstart > $now); 3885: } 3886: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec); 3887: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry); 3888: if ($secpart eq '') { 3889: ($cnum,$role) = split(/_/,$cnumpart); 3890: $sec = 'none'; 3891: $realsec = ''; 3892: } else { 3893: $cnum = $cnumpart; 3894: ($sec,$role) = split(/_/,$secpart); 3895: $realsec = $sec; 3896: } 3897: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec; 3898: } 3899: } else { 3900: foreach my $key (keys(%env)) { 3901: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} || 3902: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) { 3903: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4); 3904: next if ($role eq 'ca' || $role eq 'aa'); 3905: next if (%roles && !exists($roles{$role})); 3906: my ($starttime,$endtime)=split(/\./,$env{$key}); 3907: my $active=1; 3908: if ($starttime) { 3909: if ($now<$starttime) { $active=0; } 3910: } 3911: if ($endtime) { 3912: if ($now>$endtime) { $active=0; } 3913: } 3914: if ($active) { 3915: if ($sec eq '') { 3916: $sec = 'none'; 3917: } 3918: $courses{$cdom.'_'.$cnum}{$sec} = 3919: $role.'/'.$cdom.'/'.$cnum.'/'.$sec; 3920: } 3921: } 3922: } 3923: } 3924: return %courses; 3925: } 3926: 3927: ############################################### 3928: 3929: sub blockcheck { 3930: my ($setters,$activity,$uname,$udom) = @_; 3931: 3932: if (!defined($udom)) { 3933: $udom = $env{'user.domain'}; 3934: } 3935: if (!defined($uname)) { 3936: $uname = $env{'user.name'}; 3937: } 3938: 3939: # If uname and udom are for a course, check for blocks in the course. 3940: 3941: if (&Apache::lonnet::is_course($udom,$uname)) { 3942: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname); 3943: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname); 3944: return ($startblock,$endblock); 3945: } 3946: 3947: my $startblock = 0; 3948: my $endblock = 0; 3949: my %live_courses = &findallcourses(undef,$uname,$udom); 3950: 3951: # If uname is for a user, and activity is course-specific, i.e., 3952: # boards, chat or groups, check for blocking in current course only. 3953: 3954: if (($activity eq 'boards' || $activity eq 'chat' || 3955: $activity eq 'groups') && ($env{'request.course.id'})) { 3956: foreach my $key (keys(%live_courses)) { 3957: if ($key ne $env{'request.course.id'}) { 3958: delete($live_courses{$key}); 3959: } 3960: } 3961: } 3962: 3963: my $otheruser = 0; 3964: my %own_courses; 3965: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) { 3966: # Resource belongs to user other than current user. 3967: $otheruser = 1; 3968: # Gather courses for current user 3969: %own_courses = 3970: &findallcourses(undef,$env{'user.name'},$env{'user.domain'}); 3971: } 3972: 3973: # Gather active course roles - course coordinator, instructor, 3974: # exam proctor, ta, student, or custom role. 3975: 3976: foreach my $course (keys(%live_courses)) { 3977: my ($cdom,$cnum); 3978: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) { 3979: $cdom = $env{'course.'.$course.'.domain'}; 3980: $cnum = $env{'course.'.$course.'.num'}; 3981: } else { 3982: ($cdom,$cnum) = split(/_/,$course); 3983: } 3984: my $no_ownblock = 0; 3985: my $no_userblock = 0; 3986: if ($otheruser && $activity ne 'com') { 3987: # Check if current user has 'evb' priv for this 3988: if (defined($own_courses{$course})) { 3989: foreach my $sec (keys(%{$own_courses{$course}})) { 3990: my $checkrole = 'cm./'.$cdom.'/'.$cnum; 3991: if ($sec ne 'none') { 3992: $checkrole .= '/'.$sec; 3993: } 3994: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) { 3995: $no_ownblock = 1; 3996: last; 3997: } 3998: } 3999: } 4000: # if they have 'evb' priv and are currently not playing student 4001: next if (($no_ownblock) && 4002: ($env{'request.role'} !~ m{^st\./$cdom/$cnum})); 4003: } 4004: foreach my $sec (keys(%{$live_courses{$course}})) { 4005: my $checkrole = 'cm./'.$cdom.'/'.$cnum; 4006: if ($sec ne 'none') { 4007: $checkrole .= '/'.$sec; 4008: } 4009: if ($otheruser) { 4010: # Resource belongs to user other than current user. 4011: # Assemble privs for that user, and check for 'evb' priv. 4012: my ($trole,$tdom,$tnum,$tsec); 4013: my $entry = $live_courses{$course}{$sec}; 4014: if ($entry =~ /^cr/) { 4015: ($trole,$tdom,$tnum,$tsec) = 4016: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|); 4017: } else { 4018: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry); 4019: } 4020: my ($spec,$area,$trest,%allroles,%userroles); 4021: $area = '/'.$tdom.'/'.$tnum; 4022: $trest = $tnum; 4023: if ($tsec ne '') { 4024: $area .= '/'.$tsec; 4025: $trest .= '/'.$tsec; 4026: } 4027: $spec = $trole.'.'.$area; 4028: if ($trole =~ /^cr/) { 4029: &Apache::lonnet::custom_roleprivs(\%allroles,$trole, 4030: $tdom,$spec,$trest,$area); 4031: } else { 4032: &Apache::lonnet::standard_roleprivs(\%allroles,$trole, 4033: $tdom,$spec,$trest,$area); 4034: } 4035: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles); 4036: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) { 4037: if ($1) { 4038: $no_userblock = 1; 4039: last; 4040: } 4041: } 4042: } else { 4043: # Resource belongs to current user 4044: # Check for 'evb' priv via lonnet::allowed(). 4045: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) { 4046: $no_ownblock = 1; 4047: last; 4048: } 4049: } 4050: } 4051: # if they have the evb priv and are currently not playing student 4052: next if (($no_ownblock) && 4053: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E})); 4054: next if ($no_userblock); 4055: 4056: # Retrieve blocking times and identity of locker for course 4057: # of specified user, unless user has 'evb' privilege. 4058: 4059: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum); 4060: if (($start != 0) && 4061: (($startblock == 0) || ($startblock > $start))) { 4062: $startblock = $start; 4063: } 4064: if (($end != 0) && 4065: (($endblock == 0) || ($endblock < $end))) { 4066: $endblock = $end; 4067: } 4068: } 4069: return ($startblock,$endblock); 4070: } 4071: 4072: sub get_blocks { 4073: my ($setters,$activity,$cdom,$cnum) = @_; 4074: my $startblock = 0; 4075: my $endblock = 0; 4076: my $course = $cdom.'_'.$cnum; 4077: $setters->{$course} = {}; 4078: $setters->{$course}{'staff'} = []; 4079: $setters->{$course}{'times'} = []; 4080: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum); 4081: foreach my $record (keys(%records)) { 4082: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/); 4083: if ($start <= time && $end >= time) { 4084: my ($staff_name,$staff_dom,$title,$blocks) = 4085: &parse_block_record($records{$record}); 4086: if ($blocks->{$activity} eq 'on') { 4087: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]); 4088: push(@{$$setters{$course}{'times'}}, [$start,$end]); 4089: if ( ($startblock == 0) || ($startblock > $start) ) { 4090: $startblock = $start; 4091: } 4092: if ( ($endblock == 0) || ($endblock < $end) ) { 4093: $endblock = $end; 4094: } 4095: } 4096: } 4097: } 4098: return ($startblock,$endblock); 4099: } 4100: 4101: sub parse_block_record { 4102: my ($record) = @_; 4103: my ($setuname,$setudom,$title,$blocks); 4104: if (ref($record) eq 'HASH') { 4105: ($setuname,$setudom) = split(/:/,$record->{'setter'}); 4106: $title = &unescape($record->{'event'}); 4107: $blocks = $record->{'blocks'}; 4108: } else { 4109: my @data = split(/:/,$record,3); 4110: if (scalar(@data) eq 2) { 4111: $title = $data[1]; 4112: ($setuname,$setudom) = split(/@/,$data[0]); 4113: } else { 4114: ($setuname,$setudom,$title) = @data; 4115: } 4116: $blocks = { 'com' => 'on' }; 4117: } 4118: return ($setuname,$setudom,$title,$blocks); 4119: } 4120: 4121: sub blocking_status { 4122: my ($activity,$uname,$udom) = @_; 4123: my %setters; 4124: 4125: # check for active blocking 4126: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom); 4127: 4128: my $blocked = $startblock && $endblock ? 1 : 0; 4129: 4130: # caller just wants to know whether a block is active 4131: if (!wantarray) { return $blocked; } 4132: 4133: # build a link to a popup window containing the details 4134: my $querystring = "?activity=$activity"; 4135: # $uname and $udom decide whose portfolio the user is trying to look at 4136: $querystring .= "&udom=$udom" if $udom; 4137: $querystring .= "&uname=$uname" if $uname; 4138: 4139: my $output .= <<'END_MYBLOCK'; 4140: function openWindow(url, wdwName, w, h, toolbar,scrollbar) { 4141: var options = "width=" + w + ",height=" + h + ","; 4142: options += "resizable=yes,scrollbars="+scrollbar+",status=no,"; 4143: options += "menubar=no,toolbar="+toolbar+",location=no,directories=no"; 4144: var newWin = window.open(url, wdwName, options); 4145: newWin.focus(); 4146: } 4147: END_MYBLOCK 4148: 4149: $output = Apache::lonhtmlcommon::scripttag($output); 4150: 4151: my $popupUrl = "/adm/blockingstatus/$querystring"; 4152: my $text = mt('Communication Blocked'); 4153: 4154: $output .= <<"END_BLOCK"; 4155: <div class='LC_comblock'> 4156: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 4157: title='$text'> 4158: <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a> 4159: <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 4160: title='$text'>$text</a> 4161: </div> 4162: 4163: END_BLOCK 4164: 4165: return ($blocked, $output); 4166: } 4167: 4168: ############################################### 4169: 4170: sub check_ip_acc { 4171: my ($acc)=@_; 4172: &Apache::lonxml::debug("acc is $acc"); 4173: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) { 4174: return 1; 4175: } 4176: my $allowed=0; 4177: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'}; 4178: 4179: my $name; 4180: foreach my $pattern (split(',',$acc)) { 4181: $pattern =~ s/^\s*//; 4182: $pattern =~ s/\s*$//; 4183: if ($pattern =~ /\*$/) { 4184: #35.8.* 4185: $pattern=~s/\*//; 4186: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; } 4187: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) { 4188: #35.8.3.[34-56] 4189: my $low=$2; 4190: my $high=$3; 4191: $pattern=$1; 4192: if ($ip =~ /^\Q$pattern\E/) { 4193: my $last=(split(/\./,$ip))[3]; 4194: if ($last <=$high && $last >=$low) { $allowed=1; } 4195: } 4196: } elsif ($pattern =~ /^\*/) { 4197: #*.msu.edu 4198: $pattern=~s/\*//; 4199: if (!defined($name)) { 4200: use Socket; 4201: my $netaddr=inet_aton($ip); 4202: ($name)=gethostbyaddr($netaddr,AF_INET); 4203: } 4204: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; } 4205: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) { 4206: #127.0.0.1 4207: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; } 4208: } else { 4209: #some.name.com 4210: if (!defined($name)) { 4211: use Socket; 4212: my $netaddr=inet_aton($ip); 4213: ($name)=gethostbyaddr($netaddr,AF_INET); 4214: } 4215: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; } 4216: } 4217: if ($allowed) { last; } 4218: } 4219: return $allowed; 4220: } 4221: 4222: ############################################### 4223: 4224: =pod 4225: 4226: =head1 Domain Template Functions 4227: 4228: =over 4 4229: 4230: =item * &determinedomain() 4231: 4232: Inputs: $domain (usually will be undef) 4233: 4234: Returns: Determines which domain should be used for designs 4235: 4236: =cut 4237: 4238: ############################################### 4239: sub determinedomain { 4240: my $domain=shift; 4241: if (! $domain) { 4242: # Determine domain if we have not been given one 4243: $domain = &Apache::lonnet::default_login_domain(); 4244: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; } 4245: if ($env{'request.role.domain'}) { 4246: $domain=$env{'request.role.domain'}; 4247: } 4248: } 4249: return $domain; 4250: } 4251: ############################################### 4252: 4253: sub devalidate_domconfig_cache { 4254: my ($udom)=@_; 4255: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom); 4256: } 4257: 4258: # ---------------------- Get domain configuration for a domain 4259: sub get_domainconf { 4260: my ($udom) = @_; 4261: my $cachetime=1800; 4262: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom); 4263: if (defined($cached)) { return %{$result}; } 4264: 4265: my %domconfig = &Apache::lonnet::get_dom('configuration', 4266: ['login','rolecolors','autoenroll'],$udom); 4267: my (%designhash,%legacy); 4268: if (keys(%domconfig) > 0) { 4269: if (ref($domconfig{'login'}) eq 'HASH') { 4270: if (keys(%{$domconfig{'login'}})) { 4271: foreach my $key (keys(%{$domconfig{'login'}})) { 4272: if (ref($domconfig{'login'}{$key}) eq 'HASH') { 4273: if ($key eq 'loginvia') { 4274: if (ref($domconfig{'login'}{'loginvia'}) eq 'HASH') { 4275: my @ids = &Apache::lonnet::current_machine_ids(); 4276: foreach my $hostname (@ids) { 4277: if (ref($domconfig{'login'}{'loginvia'}{$hostname}) eq 'HASH') { 4278: if ($domconfig{'login'}{'loginvia'}{$hostname}{'server'}) { 4279: my $server = $domconfig{'login'}{'loginvia'}{$hostname}{'server'}; 4280: $designhash{$udom.'.login.loginvia'} = $server; 4281: if ($domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'} eq 'custom') { 4282: 4283: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'custompath'}; 4284: } else { 4285: $designhash{$udom.'.login.loginvia_'.$hostname} = $server.':'.$domconfig{'login'}{'loginvia'}{$hostname}{'serverpath'}; 4286: } 4287: if ($domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}) { 4288: $designhash{$udom.'.login.loginvia_exempt_'.$hostname} = $domconfig{'login'}{'loginvia'}{$hostname}{'exempt'}; 4289: } 4290: } 4291: } 4292: } 4293: } 4294: } else { 4295: foreach my $img (keys(%{$domconfig{'login'}{$key}})) { 4296: $designhash{$udom.'.login.'.$key.'_'.$img} = 4297: $domconfig{'login'}{$key}{$img}; 4298: } 4299: } 4300: } else { 4301: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key}; 4302: } 4303: } 4304: } else { 4305: $legacy{'login'} = 1; 4306: } 4307: } else { 4308: $legacy{'login'} = 1; 4309: } 4310: if (ref($domconfig{'rolecolors'}) eq 'HASH') { 4311: if (keys(%{$domconfig{'rolecolors'}})) { 4312: foreach my $role (keys(%{$domconfig{'rolecolors'}})) { 4313: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') { 4314: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) { 4315: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item}; 4316: } 4317: } 4318: } 4319: } else { 4320: $legacy{'rolecolors'} = 1; 4321: } 4322: } else { 4323: $legacy{'rolecolors'} = 1; 4324: } 4325: if (ref($domconfig{'autoenroll'}) eq 'HASH') { 4326: if ($domconfig{'autoenroll'}{'co-owners'}) { 4327: $designhash{$udom.'.autoassign.co-owners'}=$domconfig{'autoenroll'}{'co-owners'}; 4328: } 4329: } 4330: if (keys(%legacy) > 0) { 4331: my %legacyhash = &get_legacy_domconf($udom); 4332: foreach my $item (keys(%legacyhash)) { 4333: if ($item =~ /^\Q$udom\E\.login/) { 4334: if ($legacy{'login'}) { 4335: $designhash{$item} = $legacyhash{$item}; 4336: } 4337: } else { 4338: if ($legacy{'rolecolors'}) { 4339: $designhash{$item} = $legacyhash{$item}; 4340: } 4341: } 4342: } 4343: } 4344: } else { 4345: %designhash = &get_legacy_domconf($udom); 4346: } 4347: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash, 4348: $cachetime); 4349: return %designhash; 4350: } 4351: 4352: sub get_legacy_domconf { 4353: my ($udom) = @_; 4354: my %legacyhash; 4355: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors'; 4356: my $designfile = $designdir.'/'.$udom.'.tab'; 4357: if (-e $designfile) { 4358: if ( open (my $fh,"<$designfile") ) { 4359: while (my $line = <$fh>) { 4360: next if ($line =~ /^\#/); 4361: chomp($line); 4362: my ($key,$val)=(split(/\=/,$line)); 4363: if ($val) { $legacyhash{$udom.'.'.$key}=$val; } 4364: } 4365: close($fh); 4366: } 4367: } 4368: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') { 4369: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif"; 4370: } 4371: return %legacyhash; 4372: } 4373: 4374: =pod 4375: 4376: =item * &domainlogo() 4377: 4378: Inputs: $domain (usually will be undef) 4379: 4380: Returns: A link to a domain logo, if the domain logo exists. 4381: If the domain logo does not exist, a description of the domain. 4382: 4383: =cut 4384: 4385: ############################################### 4386: sub domainlogo { 4387: my $domain = &determinedomain(shift); 4388: my %designhash = &get_domainconf($domain); 4389: # See if there is a logo 4390: if ($designhash{$domain.'.login.domlogo'} ne '') { 4391: my $imgsrc = $designhash{$domain.'.login.domlogo'}; 4392: if ($imgsrc =~ m{^/(adm|res)/}) { 4393: if ($imgsrc =~ m{^/res/}) { 4394: my $local_name = &Apache::lonnet::filelocation('',$imgsrc); 4395: &Apache::lonnet::repcopy($local_name); 4396: } 4397: $imgsrc = &lonhttpdurl($imgsrc); 4398: } 4399: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />'; 4400: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) { 4401: return &Apache::lonnet::domain($domain,'description'); 4402: } else { 4403: return ''; 4404: } 4405: } 4406: ############################################## 4407: 4408: =pod 4409: 4410: =item * &designparm() 4411: 4412: Inputs: $which parameter; $domain (usually will be undef) 4413: 4414: Returns: value of designparamter $which 4415: 4416: =cut 4417: 4418: 4419: ############################################## 4420: sub designparm { 4421: my ($which,$domain)=@_; 4422: if (exists($env{'environment.color.'.$which})) { 4423: return $env{'environment.color.'.$which}; 4424: } 4425: $domain=&determinedomain($domain); 4426: my %domdesign = &get_domainconf($domain); 4427: my $output; 4428: if ($domdesign{$domain.'.'.$which} ne '') { 4429: $output = $domdesign{$domain.'.'.$which}; 4430: } else { 4431: $output = $defaultdesign{$which}; 4432: } 4433: if (($which =~ /^(student|coordinator|author|admin)\.img$/) || 4434: ($which =~ /login\.(img|logo|domlogo|login)/)) { 4435: if ($output =~ m{^/(adm|res)/}) { 4436: if ($output =~ m{^/res/}) { 4437: my $local_name = &Apache::lonnet::filelocation('',$output); 4438: &Apache::lonnet::repcopy($local_name); 4439: } 4440: $output = &lonhttpdurl($output); 4441: } 4442: } 4443: return $output; 4444: } 4445: 4446: ############################################## 4447: =pod 4448: 4449: =item * &authorspace() 4450: 4451: Inputs: ./. 4452: 4453: Returns: Path to the Construction Space of the current user's 4454: accessed author space 4455: The author space will be that of the current user 4456: when accessing the own author space 4457: and that of the co-author/assistent co-author 4458: when accessing the co-author's/assistent co-author's 4459: space 4460: 4461: =cut 4462: 4463: sub authorspace { 4464: my $caname = ''; 4465: if ($env{'request.role'} =~ /^ca|^aa/) { 4466: (undef,$caname) = 4467: ($env{'request.role'}=~/($match_domain)\/($match_username)$/); 4468: } else { 4469: $caname = $env{'user.name'}; 4470: } 4471: return '/priv/'.$caname.'/'; 4472: } 4473: 4474: ############################################## 4475: =pod 4476: 4477: =item * &head_subbox() 4478: 4479: Inputs: $content (contains HTML code with page functions, etc.) 4480: 4481: Returns: HTML div with $content 4482: To be included in page header 4483: 4484: =cut 4485: 4486: sub head_subbox { 4487: my ($content)=@_; 4488: my $output = 4489: '<div class="LC_head_subbox">' 4490: .$content 4491: .'</div>' 4492: } 4493: 4494: ############################################## 4495: =pod 4496: 4497: =item * &CSTR_pageheader() 4498: 4499: Inputs: ./. 4500: 4501: Returns: HTML div with CSTR path and recent box 4502: To be included on Construction Space pages 4503: 4504: =cut 4505: 4506: sub CSTR_pageheader { 4507: # this is for resources; directories have customtitle, and crumbs 4508: # and select recent are created in lonpubdir.pm 4509: my ($uname,$thisdisfn)= 4510: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|); 4511: my $formaction='/priv/'.$uname.'/'.$thisdisfn; 4512: $formaction=~s/\/+/\//g; 4513: 4514: my $parentpath = ''; 4515: my $lastitem = ''; 4516: if ($thisdisfn =~ m-(.+/)([^/]*)$-) { 4517: $parentpath = $1; 4518: $lastitem = $2; 4519: } else { 4520: $lastitem = $thisdisfn; 4521: } 4522: 4523: my $output = 4524: '<div>' 4525: .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it? 4526: .'<b>'.&mt('Construction Space:').'</b> ' 4527: .'<form name="dirs" method="post" action="'.$formaction 4528: .'" target="_top">' #FIXME lonpubdir: target="_parent" 4529: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv',undef,undef); 4530: 4531: if ($lastitem) { 4532: $output .= 4533: '<span class="LC_filename">' 4534: .$lastitem 4535: .'</span>'; 4536: } 4537: $output .= 4538: '<br />' 4539: #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />" 4540: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()') 4541: .'</form>' 4542: .&Apache::lonmenu::constspaceform() 4543: .'</div>'; 4544: 4545: return $output; 4546: } 4547: 4548: ############################################### 4549: ############################################### 4550: 4551: =pod 4552: 4553: =back 4554: 4555: =head1 HTML Helpers 4556: 4557: =over 4 4558: 4559: =item * &bodytag() 4560: 4561: Returns a uniform header for LON-CAPA web pages. 4562: 4563: Inputs: 4564: 4565: =over 4 4566: 4567: =item * $title, A title to be displayed on the page. 4568: 4569: =item * $function, the current role (can be undef). 4570: 4571: =item * $addentries, extra parameters for the <body> tag. 4572: 4573: =item * $bodyonly, if defined, only return the <body> tag. 4574: 4575: =item * $domain, if defined, force a given domain. 4576: 4577: =item * $forcereg, if page should register as content page (relevant for 4578: text interface only) 4579: 4580: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the 4581: navigational links 4582: 4583: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value 4584: 4585: =item * $args, optional argument valid values are 4586: no_auto_mt_title -> prevents &mt()ing the title arg 4587: inherit_jsmath -> when creating popup window in a page, 4588: should it have jsmath forced on by the 4589: current page 4590: 4591: =back 4592: 4593: Returns: A uniform header for LON-CAPA web pages. 4594: If $bodyonly is nonzero, a string containing a <body> tag will be returned. 4595: If $bodyonly is undef or zero, an html string containing a <body> tag and 4596: other decorations will be returned. 4597: 4598: =cut 4599: 4600: sub bodytag { 4601: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg, 4602: $no_nav_bar,$bgcolor,$args)=@_; 4603: 4604: my $public; 4605: if ((($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')) 4606: || ($env{'user.name'} eq '') && ($env{'user.domain'} eq '')) { 4607: $public = 1; 4608: } 4609: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); } 4610: 4611: $function = &get_users_function() if (!$function); 4612: my $img = &designparm($function.'.img',$domain); 4613: my $font = &designparm($function.'.font',$domain); 4614: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain); 4615: 4616: my %design = ( 'style' => 'margin-top: 0', 4617: 'bgcolor' => $pgbg, 4618: 'text' => $font, 4619: 'alink' => &designparm($function.'.alink',$domain), 4620: 'vlink' => &designparm($function.'.vlink',$domain), 4621: 'link' => &designparm($function.'.link',$domain),); 4622: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 4623: 4624: # role and realm 4625: my ($role,$realm) = split(/\./,$env{'request.role'},2); 4626: if ($role eq 'ca') { 4627: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$}); 4628: $realm = &plainname($rname,$rdom); 4629: } 4630: # realm 4631: if ($env{'request.course.id'}) { 4632: if ($env{'request.role'} !~ /^cr/) { 4633: $role = &Apache::lonnet::plaintext($role,&course_type()); 4634: } 4635: if ($env{'request.course.sec'}) { 4636: $role .= (' 'x2).'- '.&mt('section:').' '.$env{'request.course.sec'}; 4637: } 4638: $realm = $env{'course.'.$env{'request.course.id'}.'.description'}; 4639: } else { 4640: $role = &Apache::lonnet::plaintext($role); 4641: } 4642: 4643: if (!$realm) { $realm=' '; } 4644: 4645: my $extra_body_attr = &make_attr_string($forcereg,\%design); 4646: 4647: # construct main body tag 4648: my $bodytag = "<body $extra_body_attr>". 4649: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'}); 4650: 4651: if ($bodyonly) { 4652: return $bodytag; 4653: } 4654: 4655: my $name = &plainname($env{'user.name'},$env{'user.domain'}); 4656: if ($public) { 4657: undef($role); 4658: } else { 4659: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'}); 4660: } 4661: 4662: my $titleinfo = '<h1>'.$title.'</h1>'; 4663: # 4664: # Extra info if you are the DC 4665: my $dc_info = ''; 4666: if ($env{'user.adv'} && exists($env{'user.role.dc./'. 4667: $env{'course.'.$env{'request.course.id'}. 4668: '.domain'}.'/'})) { 4669: my $cid = $env{'request.course.id'}; 4670: $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'}; 4671: $dc_info =~ s/\s+$//; 4672: } 4673: 4674: $role = '<span class="LC_nobreak">('.$role.')</span>' if $role; 4675: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']); 4676: 4677: if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 4678: return $bodytag; 4679: } 4680: 4681: if ($env{'request.state'} eq 'construct') { $forcereg=1; } 4682: 4683: # if ($env{'request.state'} eq 'construct') { 4684: # $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls 4685: # } 4686: 4687: 4688: 4689: if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) { 4690: if ($dc_info) { 4691: $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|; 4692: } 4693: $bodytag .= qq|<div id="LC_nav_bar">$name $role<br /> 4694: <em>$realm</em> $dc_info</div>|; 4695: return $bodytag; 4696: } 4697: 4698: unless ($env{'request.symb'} =~ m/\.page___\d+___/) { 4699: $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|; 4700: } 4701: 4702: $bodytag .= Apache::lonhtmlcommon::scripttag( 4703: Apache::lonmenu::utilityfunctions(), 'start'); 4704: 4705: $bodytag .= Apache::lonmenu::primary_menu(); 4706: 4707: if ($dc_info) { 4708: $dc_info = &dc_courseid_toggle($dc_info); 4709: } 4710: $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|; 4711: 4712: #don't show menus for public users 4713: if (!$public){ 4714: $bodytag .= Apache::lonmenu::secondary_menu(); 4715: $bodytag .= Apache::lonmenu::serverform(); 4716: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 4717: if ($env{'request.state'} eq 'construct') { 4718: $bodytag .= &Apache::lonmenu::innerregister($forcereg, 4719: $args->{'bread_crumbs'}); 4720: } elsif ($forcereg) { 4721: $bodytag .= &Apache::lonmenu::innerregister($forcereg); 4722: } 4723: }else{ 4724: # this is to seperate menu from content when there's no secondary 4725: # menu. Especially needed for public accessible ressources. 4726: $bodytag .= '<hr style="clear:both" />'; 4727: $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 4728: } 4729: 4730: return $bodytag; 4731: } 4732: 4733: sub dc_courseid_toggle { 4734: my ($dc_info) = @_; 4735: return ' <span id="dccidtext" class="LC_cusr_subheading LC_nobreak">'. 4736: '<a href="javascript:showCourseID();">'. 4737: &mt('(More ...)').'</a></span>'. 4738: '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>'; 4739: } 4740: 4741: sub make_attr_string { 4742: my ($register,$attr_ref) = @_; 4743: 4744: if ($attr_ref && !ref($attr_ref)) { 4745: die("addentries Must be a hash ref ". 4746: join(':',caller(1))." ". 4747: join(':',caller(0))." "); 4748: } 4749: 4750: if ($register) { 4751: my ($on_load,$on_unload); 4752: foreach my $key (keys(%{$attr_ref})) { 4753: if (lc($key) eq 'onload') { 4754: $on_load.=$attr_ref->{$key}.';'; 4755: delete($attr_ref->{$key}); 4756: 4757: } elsif (lc($key) eq 'onunload') { 4758: $on_unload.=$attr_ref->{$key}.';'; 4759: delete($attr_ref->{$key}); 4760: } 4761: } 4762: $attr_ref->{'onload'} = $on_load; 4763: $attr_ref->{'onunload'}= $on_unload; 4764: } 4765: 4766: my $attr_string; 4767: foreach my $attr (keys(%$attr_ref)) { 4768: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" '; 4769: } 4770: return $attr_string; 4771: } 4772: 4773: 4774: ############################################### 4775: ############################################### 4776: 4777: =pod 4778: 4779: =item * &endbodytag() 4780: 4781: Returns a uniform footer for LON-CAPA web pages. 4782: 4783: Inputs: 1 - optional reference to an args hash 4784: If in the hash, key for noredirectlink has a value which evaluates to true, 4785: a 'Continue' link is not displayed if the page contains an 4786: internal redirect in the <head></head> section, 4787: i.e., $env{'internal.head.redirect'} exists 4788: 4789: =cut 4790: 4791: sub endbodytag { 4792: my ($args) = @_; 4793: my $endbodytag='</body>'; 4794: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag; 4795: if ( exists( $env{'internal.head.redirect'} ) ) { 4796: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) { 4797: $endbodytag= 4798: "<br /><a href=\"$env{'internal.head.redirect'}\">". 4799: &mt('Continue').'</a>'. 4800: $endbodytag; 4801: } 4802: } 4803: return $endbodytag; 4804: } 4805: 4806: =pod 4807: 4808: =item * &standard_css() 4809: 4810: Returns a style sheet 4811: 4812: Inputs: (all optional) 4813: domain -> force to color decorate a page for a specific 4814: domain 4815: function -> force usage of a specific rolish color scheme 4816: bgcolor -> override the default page bgcolor 4817: 4818: =cut 4819: 4820: sub standard_css { 4821: my ($function,$domain,$bgcolor) = @_; 4822: $function = &get_users_function() if (!$function); 4823: my $img = &designparm($function.'.img', $domain); 4824: my $tabbg = &designparm($function.'.tabbg', $domain); 4825: my $font = &designparm($function.'.font', $domain); 4826: my $fontmenu = &designparm($function.'.fontmenu', $domain); 4827: #second colour for later usage 4828: my $sidebg = &designparm($function.'.sidebg',$domain); 4829: my $pgbg_or_bgcolor = 4830: $bgcolor || 4831: &designparm($function.'.pgbg', $domain); 4832: my $pgbg = &designparm($function.'.pgbg', $domain); 4833: my $alink = &designparm($function.'.alink', $domain); 4834: my $vlink = &designparm($function.'.vlink', $domain); 4835: my $link = &designparm($function.'.link', $domain); 4836: 4837: my $sans = 'Verdana,Arial,Helvetica,sans-serif'; 4838: my $mono = 'monospace'; 4839: my $data_table_head = $sidebg; 4840: my $data_table_light = '#FAFAFA'; 4841: my $data_table_dark = '#F0F0F0'; 4842: my $data_table_darker = '#CCCCCC'; 4843: my $data_table_highlight = '#FFFF00'; 4844: my $mail_new = '#FFBB77'; 4845: my $mail_new_hover = '#DD9955'; 4846: my $mail_read = '#BBBB77'; 4847: my $mail_read_hover = '#999944'; 4848: my $mail_replied = '#AAAA88'; 4849: my $mail_replied_hover = '#888855'; 4850: my $mail_other = '#99BBBB'; 4851: my $mail_other_hover = '#669999'; 4852: my $table_header = '#DDDDDD'; 4853: my $feedback_link_bg = '#BBBBBB'; 4854: my $lg_border_color = '#C8C8C8'; 4855: my $button_hover = '#BF2317'; 4856: 4857: my $border = ($env{'browser.type'} eq 'explorer' || 4858: $env{'browser.type'} eq 'safari' ) ? '0 2px 0 2px' 4859: : '0 3px 0 4px'; 4860: 4861: 4862: return <<END; 4863: 4864: /* needed for iframe to allow 100% height in FF */ 4865: body, html { 4866: margin: 0; 4867: padding: 0 0.5%; 4868: height: 99%; /* to avoid scrollbars */ 4869: } 4870: 4871: body { 4872: font-family: $sans; 4873: line-height:130%; 4874: font-size:0.83em; 4875: color:$font; 4876: } 4877: 4878: a:focus, 4879: a:focus img { 4880: color: red; 4881: background: yellow; 4882: } 4883: 4884: form, .inline { 4885: display: inline; 4886: } 4887: 4888: .LC_right { 4889: text-align:right; 4890: } 4891: 4892: .LC_middle { 4893: vertical-align:middle; 4894: } 4895: 4896: .LC_400Box { 4897: width:400px; 4898: } 4899: 4900: .LC_iframecontainer { 4901: width: 98%; 4902: margin: 0; 4903: position: fixed; 4904: top: 8.5em; 4905: bottom: 0; 4906: } 4907: 4908: .LC_iframecontainer iframe{ 4909: border: none; 4910: width: 100%; 4911: height: 100%; 4912: } 4913: 4914: .LC_filename { 4915: font-family: $mono; 4916: white-space:pre; 4917: font-size: 120%; 4918: } 4919: 4920: .LC_fileicon { 4921: border: none; 4922: height: 1.3em; 4923: vertical-align: text-bottom; 4924: margin-right: 0.3em; 4925: text-decoration:none; 4926: } 4927: 4928: .LC_error { 4929: color: red; 4930: font-size: larger; 4931: } 4932: 4933: .LC_warning, 4934: .LC_diff_removed { 4935: color: red; 4936: } 4937: 4938: .LC_info, 4939: .LC_success, 4940: .LC_diff_added { 4941: color: green; 4942: } 4943: 4944: div.LC_confirm_box { 4945: background-color: #FAFAFA; 4946: border: 1px solid $lg_border_color; 4947: margin-right: 0; 4948: padding: 5px; 4949: } 4950: 4951: div.LC_confirm_box .LC_error img, 4952: div.LC_confirm_box .LC_success img { 4953: vertical-align: middle; 4954: } 4955: 4956: .LC_icon { 4957: border: none; 4958: vertical-align: middle; 4959: } 4960: 4961: .LC_docs_spacer { 4962: width: 25px; 4963: height: 1px; 4964: border: none; 4965: } 4966: 4967: .LC_internal_info { 4968: color: #999999; 4969: } 4970: 4971: .LC_discussion { 4972: background: $tabbg; 4973: border: 1px solid black; 4974: margin: 2px; 4975: } 4976: 4977: .LC_disc_action_links_bar { 4978: background: $tabbg; 4979: border: none; 4980: margin: 4px; 4981: } 4982: 4983: .LC_disc_action_left { 4984: text-align: left; 4985: } 4986: 4987: .LC_disc_action_right { 4988: text-align: right; 4989: } 4990: 4991: .LC_disc_new_item { 4992: background: white; 4993: border: 2px solid red; 4994: margin: 2px; 4995: } 4996: 4997: .LC_disc_old_item { 4998: background: white; 4999: border: 1px solid black; 5000: margin: 2px; 5001: } 5002: 5003: table.LC_pastsubmission { 5004: border: 1px solid black; 5005: margin: 2px; 5006: } 5007: 5008: table#LC_menubuttons { 5009: width: 100%; 5010: background: $pgbg; 5011: border: 2px; 5012: border-collapse: separate; 5013: padding: 0; 5014: } 5015: 5016: table#LC_title_bar a { 5017: color: $fontmenu; 5018: } 5019: 5020: table#LC_title_bar { 5021: clear: both; 5022: display: none; 5023: } 5024: 5025: table#LC_title_bar, 5026: table.LC_breadcrumbs, /* obsolete? */ 5027: table#LC_title_bar.LC_with_remote { 5028: width: 100%; 5029: border-color: $pgbg; 5030: border-style: solid; 5031: border-width: $border; 5032: background: $pgbg; 5033: color: $fontmenu; 5034: border-collapse: collapse; 5035: padding: 0; 5036: margin: 0; 5037: } 5038: 5039: ul.LC_breadcrumb_tools_outerlist { 5040: margin: 0; 5041: padding: 0; 5042: position: relative; 5043: list-style: none; 5044: } 5045: ul.LC_breadcrumb_tools_outerlist li { 5046: display: inline; 5047: } 5048: 5049: .LC_breadcrumb_tools_navigation { 5050: padding: 0; 5051: margin: 0; 5052: float: left; 5053: } 5054: .LC_breadcrumb_tools_tools { 5055: padding: 0; 5056: margin: 0; 5057: float: right; 5058: } 5059: 5060: table#LC_title_bar td { 5061: background: $tabbg; 5062: } 5063: 5064: table#LC_menubuttons img { 5065: border: none; 5066: } 5067: 5068: .LC_breadcrumbs_component { 5069: float: right; 5070: margin: 0 1em; 5071: } 5072: .LC_breadcrumbs_component img { 5073: vertical-align: middle; 5074: } 5075: 5076: td.LC_table_cell_checkbox { 5077: text-align: center; 5078: } 5079: 5080: .LC_fontsize_small { 5081: font-size: 70%; 5082: } 5083: 5084: #LC_breadcrumbs { 5085: clear:both; 5086: background: $sidebg; 5087: border-bottom: 1px solid $lg_border_color; 5088: line-height: 2.5em; 5089: overflow: hidden; 5090: margin: 0; 5091: padding: 0; 5092: text-align: left; 5093: } 5094: 5095: .LC_head_subbox { 5096: clear:both; 5097: background: #F8F8F8; /* $sidebg; */ 5098: border: 1px solid $sidebg; 5099: margin: 0 0 10px 0; 5100: padding: 3px; 5101: text-align: left; 5102: } 5103: 5104: .LC_fontsize_medium { 5105: font-size: 85%; 5106: } 5107: 5108: .LC_fontsize_large { 5109: font-size: 120%; 5110: } 5111: 5112: .LC_menubuttons_inline_text { 5113: color: $font; 5114: font-size: 90%; 5115: padding-left:3px; 5116: } 5117: 5118: .LC_menubuttons_inline_text img{ 5119: vertical-align: middle; 5120: } 5121: 5122: li.LC_menubuttons_inline_text img,a { 5123: cursor:pointer; 5124: } 5125: 5126: .LC_menubuttons_link { 5127: text-decoration: none; 5128: } 5129: 5130: .LC_menubuttons_category { 5131: color: $font; 5132: background: $pgbg; 5133: font-size: larger; 5134: font-weight: bold; 5135: } 5136: 5137: td.LC_menubuttons_text { 5138: color: $font; 5139: } 5140: 5141: .LC_current_location { 5142: background: $tabbg; 5143: } 5144: 5145: table.LC_data_table { 5146: border: 1px solid #000000; 5147: border-collapse: separate; 5148: border-spacing: 1px; 5149: background: $pgbg; 5150: } 5151: 5152: .LC_data_table_dense { 5153: font-size: small; 5154: } 5155: 5156: table.LC_nested_outer { 5157: border: 1px solid #000000; 5158: border-collapse: collapse; 5159: border-spacing: 0; 5160: width: 100%; 5161: } 5162: 5163: table.LC_innerpickbox, 5164: table.LC_nested { 5165: border: none; 5166: border-collapse: collapse; 5167: border-spacing: 0; 5168: width: 100%; 5169: } 5170: 5171: .ui-accordion, 5172: .ui-accordion table.LC_data_table, 5173: .ui-accordion table.LC_nested_outer{ 5174: border: 0px; 5175: border-spacing: 0px; 5176: margin: 3px; 5177: } 5178: 5179: table.LC_data_table tr th, 5180: table.LC_calendar tr th, 5181: table.LC_prior_tries tr th, 5182: table.LC_innerpickbox tr th { 5183: font-weight: bold; 5184: background-color: $data_table_head; 5185: color:$fontmenu; 5186: font-size:90%; 5187: } 5188: 5189: table.LC_innerpickbox tr th, 5190: table.LC_innerpickbox tr td { 5191: vertical-align: top; 5192: } 5193: 5194: table.LC_data_table tr.LC_info_row > td { 5195: background-color: #CCCCCC; 5196: font-weight: bold; 5197: text-align: left; 5198: } 5199: 5200: table.LC_data_table tr.LC_odd_row > td { 5201: background-color: $data_table_light; 5202: padding: 2px; 5203: vertical-align: top; 5204: } 5205: 5206: table.LC_pick_box tr > td.LC_odd_row { 5207: background-color: $data_table_light; 5208: vertical-align: top; 5209: } 5210: 5211: table.LC_data_table tr.LC_even_row > td { 5212: background-color: $data_table_dark; 5213: padding: 2px; 5214: vertical-align: top; 5215: } 5216: 5217: table.LC_pick_box tr > td.LC_even_row { 5218: background-color: $data_table_dark; 5219: vertical-align: top; 5220: } 5221: 5222: table.LC_data_table tr.LC_data_table_highlight td { 5223: background-color: $data_table_darker; 5224: } 5225: 5226: table.LC_data_table tr td.LC_leftcol_header { 5227: background-color: $data_table_head; 5228: font-weight: bold; 5229: } 5230: 5231: table.LC_data_table tr.LC_empty_row td, 5232: table.LC_nested tr.LC_empty_row td { 5233: font-weight: bold; 5234: font-style: italic; 5235: text-align: center; 5236: padding: 8px; 5237: } 5238: 5239: table.LC_data_table tr.LC_empty_row td { 5240: background-color: $sidebg; 5241: } 5242: 5243: table.LC_nested tr.LC_empty_row td { 5244: background-color: #FFFFFF; 5245: } 5246: 5247: table.LC_caption { 5248: } 5249: 5250: table.LC_nested tr.LC_empty_row td { 5251: padding: 4ex 5252: } 5253: 5254: table.LC_nested_outer tr th { 5255: font-weight: bold; 5256: color:$fontmenu; 5257: background-color: $data_table_head; 5258: font-size: small; 5259: border-bottom: 1px solid #000000; 5260: } 5261: 5262: table.LC_nested_outer tr td.LC_subheader { 5263: background-color: $data_table_head; 5264: font-weight: bold; 5265: font-size: small; 5266: border-bottom: 1px solid #000000; 5267: text-align: right; 5268: } 5269: 5270: table.LC_nested tr.LC_info_row td { 5271: background-color: #CCCCCC; 5272: font-weight: bold; 5273: font-size: small; 5274: text-align: center; 5275: } 5276: 5277: table.LC_nested tr.LC_info_row td.LC_left_item, 5278: table.LC_nested_outer tr th.LC_left_item { 5279: text-align: left; 5280: } 5281: 5282: table.LC_nested td { 5283: background-color: #FFFFFF; 5284: font-size: small; 5285: } 5286: 5287: table.LC_nested_outer tr th.LC_right_item, 5288: table.LC_nested tr.LC_info_row td.LC_right_item, 5289: table.LC_nested tr.LC_odd_row td.LC_right_item, 5290: table.LC_nested tr td.LC_right_item { 5291: text-align: right; 5292: } 5293: 5294: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_left_item, 5295: .ui-accordion table.LC_nested tr.LC_even_row td.LC_left_item { 5296: text-align: right; 5297: width: 40%; 5298: padding-right:10px; 5299: vertical-align: top; 5300: padding: 5px; 5301: } 5302: 5303: .ui-accordion table.LC_nested tr.LC_odd_row td.LC_right_item, 5304: .ui-accordion table.LC_nested tr.LC_even_row td.LC_right_item { 5305: text-align: left; 5306: width: 60%; 5307: padding: 2px 4px; 5308: } 5309: 5310: table.LC_nested tr.LC_odd_row td { 5311: background-color: #EEEEEE; 5312: } 5313: 5314: table.LC_createuser { 5315: } 5316: 5317: table.LC_createuser tr.LC_section_row td { 5318: font-size: small; 5319: } 5320: 5321: table.LC_createuser tr.LC_info_row td { 5322: background-color: #CCCCCC; 5323: font-weight: bold; 5324: text-align: center; 5325: } 5326: 5327: table.LC_calendar { 5328: border: 1px solid #000000; 5329: border-collapse: collapse; 5330: width: 98%; 5331: } 5332: 5333: table.LC_calendar_pickdate { 5334: font-size: xx-small; 5335: } 5336: 5337: table.LC_calendar tr td { 5338: border: 1px solid #000000; 5339: vertical-align: top; 5340: width: 14%; 5341: } 5342: 5343: table.LC_calendar tr td.LC_calendar_day_empty { 5344: background-color: $data_table_dark; 5345: } 5346: 5347: table.LC_calendar tr td.LC_calendar_day_current { 5348: background-color: $data_table_highlight; 5349: } 5350: 5351: table.LC_data_table tr td.LC_mail_new { 5352: background-color: $mail_new; 5353: } 5354: 5355: table.LC_data_table tr.LC_mail_new:hover { 5356: background-color: $mail_new_hover; 5357: } 5358: 5359: table.LC_data_table tr td.LC_mail_read { 5360: background-color: $mail_read; 5361: } 5362: 5363: /* 5364: table.LC_data_table tr.LC_mail_read:hover { 5365: background-color: $mail_read_hover; 5366: } 5367: */ 5368: 5369: table.LC_data_table tr td.LC_mail_replied { 5370: background-color: $mail_replied; 5371: } 5372: 5373: /* 5374: table.LC_data_table tr.LC_mail_replied:hover { 5375: background-color: $mail_replied_hover; 5376: } 5377: */ 5378: 5379: table.LC_data_table tr td.LC_mail_other { 5380: background-color: $mail_other; 5381: } 5382: 5383: /* 5384: table.LC_data_table tr.LC_mail_other:hover { 5385: background-color: $mail_other_hover; 5386: } 5387: */ 5388: 5389: table.LC_data_table tr > td.LC_browser_file, 5390: table.LC_data_table tr > td.LC_browser_file_published { 5391: background: #AAEE77; 5392: } 5393: 5394: table.LC_data_table tr > td.LC_browser_file_locked, 5395: table.LC_data_table tr > td.LC_browser_file_unpublished { 5396: background: #FFAA99; 5397: } 5398: 5399: table.LC_data_table tr > td.LC_browser_file_obsolete { 5400: background: #888888; 5401: } 5402: 5403: table.LC_data_table tr > td.LC_browser_file_modified, 5404: table.LC_data_table tr > td.LC_browser_file_metamodified { 5405: background: #F8F866; 5406: } 5407: 5408: table.LC_data_table tr.LC_browser_folder > td { 5409: background: #E0E8FF; 5410: } 5411: 5412: table.LC_data_table tr > td.LC_roles_is { 5413: /* background: #77FF77; */ 5414: } 5415: 5416: table.LC_data_table tr > td.LC_roles_future { 5417: border-right: 8px solid #FFFF77; 5418: } 5419: 5420: table.LC_data_table tr > td.LC_roles_will { 5421: border-right: 8px solid #FFAA77; 5422: } 5423: 5424: table.LC_data_table tr > td.LC_roles_expired { 5425: border-right: 8px solid #FF7777; 5426: } 5427: 5428: table.LC_data_table tr > td.LC_roles_will_not { 5429: border-right: 8px solid #AAFF77; 5430: } 5431: 5432: table.LC_data_table tr > td.LC_roles_selected { 5433: border-right: 8px solid #11CC55; 5434: } 5435: 5436: span.LC_current_location { 5437: font-size:larger; 5438: background: $pgbg; 5439: } 5440: 5441: span.LC_parm_menu_item { 5442: font-size: larger; 5443: } 5444: 5445: span.LC_parm_scope_all { 5446: color: red; 5447: } 5448: 5449: span.LC_parm_scope_folder { 5450: color: green; 5451: } 5452: 5453: span.LC_parm_scope_resource { 5454: color: orange; 5455: } 5456: 5457: span.LC_parm_part { 5458: color: blue; 5459: } 5460: 5461: span.LC_parm_folder, 5462: span.LC_parm_symb { 5463: font-size: x-small; 5464: font-family: $mono; 5465: color: #AAAAAA; 5466: } 5467: 5468: ul.LC_parm_parmlist li { 5469: display: inline-block; 5470: padding: 0.3em 0.8em; 5471: vertical-align: top; 5472: width: 150px; 5473: border-top:1px solid $lg_border_color; 5474: } 5475: 5476: td.LC_parm_overview_level_menu, 5477: td.LC_parm_overview_map_menu, 5478: td.LC_parm_overview_parm_selectors, 5479: td.LC_parm_overview_restrictions { 5480: border: 1px solid black; 5481: border-collapse: collapse; 5482: } 5483: 5484: table.LC_parm_overview_restrictions td { 5485: border-width: 1px 4px 1px 4px; 5486: border-style: solid; 5487: border-color: $pgbg; 5488: text-align: center; 5489: } 5490: 5491: table.LC_parm_overview_restrictions th { 5492: background: $tabbg; 5493: border-width: 1px 4px 1px 4px; 5494: border-style: solid; 5495: border-color: $pgbg; 5496: } 5497: 5498: table#LC_helpmenu { 5499: border: none; 5500: height: 55px; 5501: border-spacing: 0; 5502: } 5503: 5504: table#LC_helpmenu fieldset legend { 5505: font-size: larger; 5506: } 5507: 5508: table#LC_helpmenu_links { 5509: width: 100%; 5510: border: 1px solid black; 5511: background: $pgbg; 5512: padding: 0; 5513: border-spacing: 1px; 5514: } 5515: 5516: table#LC_helpmenu_links tr td { 5517: padding: 1px; 5518: background: $tabbg; 5519: text-align: center; 5520: font-weight: bold; 5521: } 5522: 5523: table#LC_helpmenu_links a:link, 5524: table#LC_helpmenu_links a:visited, 5525: table#LC_helpmenu_links a:active { 5526: text-decoration: none; 5527: color: $font; 5528: } 5529: 5530: table#LC_helpmenu_links a:hover { 5531: text-decoration: underline; 5532: color: $vlink; 5533: } 5534: 5535: .LC_chrt_popup_exists { 5536: border: 1px solid #339933; 5537: margin: -1px; 5538: } 5539: 5540: .LC_chrt_popup_up { 5541: border: 1px solid yellow; 5542: margin: -1px; 5543: } 5544: 5545: .LC_chrt_popup { 5546: border: 1px solid #8888FF; 5547: background: #CCCCFF; 5548: } 5549: 5550: table.LC_pick_box { 5551: border-collapse: separate; 5552: background: white; 5553: border: 1px solid black; 5554: border-spacing: 1px; 5555: } 5556: 5557: table.LC_pick_box td.LC_pick_box_title { 5558: background: $sidebg; 5559: font-weight: bold; 5560: text-align: left; 5561: vertical-align: top; 5562: width: 184px; 5563: padding: 8px; 5564: } 5565: 5566: table.LC_pick_box td.LC_pick_box_value { 5567: text-align: left; 5568: padding: 8px; 5569: } 5570: 5571: table.LC_pick_box td.LC_pick_box_select { 5572: text-align: left; 5573: padding: 8px; 5574: } 5575: 5576: table.LC_pick_box td.LC_pick_box_separator { 5577: padding: 0; 5578: height: 1px; 5579: background: black; 5580: } 5581: 5582: table.LC_pick_box td.LC_pick_box_submit { 5583: text-align: right; 5584: } 5585: 5586: table.LC_pick_box td.LC_evenrow_value { 5587: text-align: left; 5588: padding: 8px; 5589: background-color: $data_table_light; 5590: } 5591: 5592: table.LC_pick_box td.LC_oddrow_value { 5593: text-align: left; 5594: padding: 8px; 5595: background-color: $data_table_light; 5596: } 5597: 5598: span.LC_helpform_receipt_cat { 5599: font-weight: bold; 5600: } 5601: 5602: table.LC_group_priv_box { 5603: background: white; 5604: border: 1px solid black; 5605: border-spacing: 1px; 5606: } 5607: 5608: table.LC_group_priv_box td.LC_pick_box_title { 5609: background: $tabbg; 5610: font-weight: bold; 5611: text-align: right; 5612: width: 184px; 5613: } 5614: 5615: table.LC_group_priv_box td.LC_groups_fixed { 5616: background: $data_table_light; 5617: text-align: center; 5618: } 5619: 5620: table.LC_group_priv_box td.LC_groups_optional { 5621: background: $data_table_dark; 5622: text-align: center; 5623: } 5624: 5625: table.LC_group_priv_box td.LC_groups_functionality { 5626: background: $data_table_darker; 5627: text-align: center; 5628: font-weight: bold; 5629: } 5630: 5631: table.LC_group_priv td { 5632: text-align: left; 5633: padding: 0; 5634: } 5635: 5636: .LC_navbuttons { 5637: margin: 2ex 0ex 2ex 0ex; 5638: } 5639: 5640: .LC_topic_bar { 5641: font-weight: bold; 5642: background: $tabbg; 5643: margin: 1em 0em 1em 2em; 5644: padding: 3px; 5645: font-size: 1.2em; 5646: } 5647: 5648: .LC_topic_bar span { 5649: left: 0.5em; 5650: position: absolute; 5651: vertical-align: middle; 5652: font-size: 1.2em; 5653: } 5654: 5655: table.LC_course_group_status { 5656: margin: 20px; 5657: } 5658: 5659: table.LC_status_selector td { 5660: vertical-align: top; 5661: text-align: center; 5662: padding: 4px; 5663: } 5664: 5665: div.LC_feedback_link { 5666: clear: both; 5667: background: $sidebg; 5668: width: 100%; 5669: padding-bottom: 10px; 5670: border: 1px $tabbg solid; 5671: height: 22px; 5672: line-height: 22px; 5673: padding-top: 5px; 5674: } 5675: 5676: div.LC_feedback_link img { 5677: height: 22px; 5678: vertical-align:middle; 5679: } 5680: 5681: div.LC_feedback_link a { 5682: text-decoration: none; 5683: } 5684: 5685: div.LC_comblock { 5686: display:inline; 5687: color:$font; 5688: font-size:90%; 5689: } 5690: 5691: div.LC_feedback_link div.LC_comblock { 5692: padding-left:5px; 5693: } 5694: 5695: div.LC_feedback_link div.LC_comblock a { 5696: color:$font; 5697: } 5698: 5699: span.LC_feedback_link { 5700: /* background: $feedback_link_bg; */ 5701: font-size: larger; 5702: } 5703: 5704: span.LC_message_link { 5705: /* background: $feedback_link_bg; */ 5706: font-size: larger; 5707: position: absolute; 5708: right: 1em; 5709: } 5710: 5711: table.LC_prior_tries { 5712: border: 1px solid #000000; 5713: border-collapse: separate; 5714: border-spacing: 1px; 5715: } 5716: 5717: table.LC_prior_tries td { 5718: padding: 2px; 5719: } 5720: 5721: .LC_answer_correct { 5722: background: lightgreen; 5723: color: darkgreen; 5724: padding: 6px; 5725: } 5726: 5727: .LC_answer_charged_try { 5728: background: #FFAAAA; 5729: color: darkred; 5730: padding: 6px; 5731: } 5732: 5733: .LC_answer_not_charged_try, 5734: .LC_answer_no_grade, 5735: .LC_answer_late { 5736: background: lightyellow; 5737: color: black; 5738: padding: 6px; 5739: } 5740: 5741: .LC_answer_previous { 5742: background: lightblue; 5743: color: darkblue; 5744: padding: 6px; 5745: } 5746: 5747: .LC_answer_no_message { 5748: background: #FFFFFF; 5749: color: black; 5750: padding: 6px; 5751: } 5752: 5753: .LC_answer_unknown { 5754: background: orange; 5755: color: black; 5756: padding: 6px; 5757: } 5758: 5759: span.LC_prior_numerical, 5760: span.LC_prior_string, 5761: span.LC_prior_custom, 5762: span.LC_prior_reaction, 5763: span.LC_prior_math { 5764: font-family: $mono; 5765: white-space: pre; 5766: } 5767: 5768: span.LC_prior_string { 5769: font-family: $mono; 5770: white-space: pre; 5771: } 5772: 5773: table.LC_prior_option { 5774: width: 100%; 5775: border-collapse: collapse; 5776: } 5777: 5778: table.LC_prior_rank, 5779: table.LC_prior_match { 5780: border-collapse: collapse; 5781: } 5782: 5783: table.LC_prior_option tr td, 5784: table.LC_prior_rank tr td, 5785: table.LC_prior_match tr td { 5786: border: 1px solid #000000; 5787: } 5788: 5789: .LC_nobreak { 5790: white-space: nowrap; 5791: } 5792: 5793: span.LC_cusr_emph { 5794: font-style: italic; 5795: } 5796: 5797: span.LC_cusr_subheading { 5798: font-weight: normal; 5799: font-size: 85%; 5800: } 5801: 5802: div.LC_docs_entry_move { 5803: border: 1px solid #BBBBBB; 5804: background: #DDDDDD; 5805: width: 22px; 5806: padding: 1px; 5807: margin: 0; 5808: } 5809: 5810: table.LC_data_table tr > td.LC_docs_entry_commands, 5811: table.LC_data_table tr > td.LC_docs_entry_parameter { 5812: background: #DDDDDD; 5813: font-size: x-small; 5814: } 5815: 5816: .LC_docs_entry_parameter { 5817: white-space: nowrap; 5818: } 5819: 5820: .LC_docs_copy { 5821: color: #000099; 5822: } 5823: 5824: .LC_docs_cut { 5825: color: #550044; 5826: } 5827: 5828: .LC_docs_rename { 5829: color: #009900; 5830: } 5831: 5832: .LC_docs_remove { 5833: color: #990000; 5834: } 5835: 5836: .LC_docs_reinit_warn, 5837: .LC_docs_ext_edit { 5838: font-size: x-small; 5839: } 5840: 5841: table.LC_docs_adddocs td, 5842: table.LC_docs_adddocs th { 5843: border: 1px solid #BBBBBB; 5844: padding: 4px; 5845: background: #DDDDDD; 5846: } 5847: 5848: table.LC_sty_begin { 5849: background: #BBFFBB; 5850: } 5851: 5852: table.LC_sty_end { 5853: background: #FFBBBB; 5854: } 5855: 5856: table.LC_double_column { 5857: border-width: 0; 5858: border-collapse: collapse; 5859: width: 100%; 5860: padding: 2px; 5861: } 5862: 5863: table.LC_double_column tr td.LC_left_col { 5864: top: 2px; 5865: left: 2px; 5866: width: 47%; 5867: vertical-align: top; 5868: } 5869: 5870: table.LC_double_column tr td.LC_right_col { 5871: top: 2px; 5872: right: 2px; 5873: width: 47%; 5874: vertical-align: top; 5875: } 5876: 5877: div.LC_left_float { 5878: float: left; 5879: padding-right: 5%; 5880: padding-bottom: 4px; 5881: } 5882: 5883: div.LC_clear_float_header { 5884: padding-bottom: 2px; 5885: } 5886: 5887: div.LC_clear_float_footer { 5888: padding-top: 10px; 5889: clear: both; 5890: } 5891: 5892: div.LC_grade_show_user { 5893: /* border-left: 5px solid $sidebg; */ 5894: border-top: 5px solid #000000; 5895: margin: 50px 0 0 0; 5896: padding: 15px 0 5px 10px; 5897: } 5898: 5899: div.LC_grade_show_user_odd_row { 5900: /* border-left: 5px solid #000000; */ 5901: } 5902: 5903: div.LC_grade_show_user div.LC_Box { 5904: margin-right: 50px; 5905: } 5906: 5907: div.LC_grade_submissions, 5908: div.LC_grade_message_center, 5909: div.LC_grade_info_links { 5910: margin: 5px; 5911: width: 99%; 5912: background: #FFFFFF; 5913: } 5914: 5915: div.LC_grade_submissions_header, 5916: div.LC_grade_message_center_header { 5917: font-weight: bold; 5918: font-size: large; 5919: } 5920: 5921: div.LC_grade_submissions_body, 5922: div.LC_grade_message_center_body { 5923: border: 1px solid black; 5924: width: 99%; 5925: background: #FFFFFF; 5926: } 5927: 5928: table.LC_scantron_action { 5929: width: 100%; 5930: } 5931: 5932: table.LC_scantron_action tr th { 5933: font-weight:bold; 5934: font-style:normal; 5935: } 5936: 5937: .LC_edit_problem_header, 5938: div.LC_edit_problem_footer { 5939: font-weight: normal; 5940: font-size: medium; 5941: margin: 2px; 5942: } 5943: 5944: div.LC_edit_problem_header, 5945: div.LC_edit_problem_header div, 5946: div.LC_edit_problem_footer, 5947: div.LC_edit_problem_footer div, 5948: div.LC_edit_problem_editxml_header, 5949: div.LC_edit_problem_editxml_header div { 5950: margin-top: 5px; 5951: } 5952: 5953: div.LC_edit_problem_header_title { 5954: font-weight: bold; 5955: font-size: larger; 5956: background: $tabbg; 5957: padding: 3px; 5958: } 5959: 5960: table.LC_edit_problem_header_title { 5961: width: 100%; 5962: background: $tabbg; 5963: } 5964: 5965: div.LC_edit_problem_discards { 5966: float: left; 5967: padding-bottom: 5px; 5968: } 5969: 5970: div.LC_edit_problem_saves { 5971: float: right; 5972: padding-bottom: 5px; 5973: } 5974: 5975: img.stift { 5976: border-width: 0; 5977: vertical-align: middle; 5978: } 5979: 5980: table td.LC_mainmenu_col_fieldset { 5981: vertical-align: top; 5982: } 5983: 5984: div.LC_createcourse { 5985: margin: 10px 10px 10px 10px; 5986: } 5987: 5988: .LC_dccid { 5989: margin: 0.2em 0 0 0; 5990: padding: 0; 5991: font-size: 90%; 5992: display:none; 5993: } 5994: 5995: a:hover, 5996: ol.LC_primary_menu a:hover, 5997: ol#LC_MenuBreadcrumbs a:hover, 5998: ol#LC_PathBreadcrumbs a:hover, 5999: ul#LC_secondary_menu a:hover, 6000: .LC_FormSectionClearButton input:hover 6001: ul.LC_TabContent li:hover a { 6002: color:$button_hover; 6003: text-decoration:none; 6004: } 6005: 6006: h1 { 6007: padding: 0; 6008: line-height:130%; 6009: } 6010: 6011: h2, 6012: h3, 6013: h4, 6014: h5, 6015: h6 { 6016: margin: 5px 0 5px 0; 6017: padding: 0; 6018: line-height:130%; 6019: } 6020: 6021: .LC_hcell { 6022: padding:3px 15px 3px 15px; 6023: margin: 0; 6024: background-color:$tabbg; 6025: color:$fontmenu; 6026: border-bottom:solid 1px $lg_border_color; 6027: } 6028: 6029: .LC_Box > .LC_hcell { 6030: margin: 0 -10px 10px -10px; 6031: } 6032: 6033: .LC_noBorder { 6034: border: 0; 6035: } 6036: 6037: .LC_FormSectionClearButton input { 6038: background-color:transparent; 6039: border: none; 6040: cursor:pointer; 6041: text-decoration:underline; 6042: } 6043: 6044: .LC_help_open_topic { 6045: color: #FFFFFF; 6046: background-color: #EEEEFF; 6047: margin: 1px; 6048: padding: 4px; 6049: border: 1px solid #000033; 6050: white-space: nowrap; 6051: /* vertical-align: middle; */ 6052: } 6053: 6054: dl, 6055: ul, 6056: div, 6057: fieldset { 6058: margin: 10px 10px 10px 0; 6059: /* overflow: hidden; */ 6060: } 6061: 6062: fieldset > legend { 6063: font-weight: bold; 6064: padding: 0 5px 0 5px; 6065: } 6066: 6067: #LC_nav_bar { 6068: float: left; 6069: background-color: $pgbg_or_bgcolor; 6070: margin: 0 0 2px 0; 6071: } 6072: 6073: #LC_realm { 6074: margin: 0.2em 0 0 0; 6075: padding: 0; 6076: font-weight: bold; 6077: text-align: center; 6078: background-color: $pgbg_or_bgcolor; 6079: } 6080: 6081: #LC_nav_bar em { 6082: font-weight: bold; 6083: font-style: normal; 6084: } 6085: 6086: ol.LC_primary_menu { 6087: float: right; 6088: margin: 0; 6089: background-color: $pgbg_or_bgcolor; 6090: } 6091: 6092: ol#LC_PathBreadcrumbs { 6093: margin: 0; 6094: } 6095: 6096: ol.LC_primary_menu li { 6097: display: inline; 6098: padding: 5px 5px 0 10px; 6099: vertical-align: top; 6100: } 6101: 6102: ol.LC_primary_menu li img { 6103: vertical-align: bottom; 6104: height: 1.1em; 6105: } 6106: 6107: ol.LC_primary_menu a { 6108: color: RGB(80, 80, 80); 6109: text-decoration: none; 6110: } 6111: 6112: ol.LC_primary_menu a.LC_new_message { 6113: font-weight:bold; 6114: color: darkred; 6115: } 6116: 6117: ol.LC_docs_parameters { 6118: margin-left: 0; 6119: padding: 0; 6120: list-style: none; 6121: } 6122: 6123: ol.LC_docs_parameters li { 6124: margin: 0; 6125: padding-right: 20px; 6126: display: inline; 6127: } 6128: 6129: ol.LC_docs_parameters li:before { 6130: content: "\\002022 \\0020"; 6131: } 6132: 6133: li.LC_docs_parameters_title { 6134: font-weight: bold; 6135: } 6136: 6137: ol.LC_docs_parameters li.LC_docs_parameters_title:before { 6138: content: ""; 6139: } 6140: 6141: ul#LC_secondary_menu { 6142: clear: both; 6143: color: $fontmenu; 6144: background: $tabbg; 6145: list-style: none; 6146: padding: 0; 6147: margin: 0; 6148: width: 100%; 6149: text-align: left; 6150: } 6151: 6152: ul#LC_secondary_menu li { 6153: font-weight: bold; 6154: line-height: 1.8em; 6155: padding: 0 0.8em; 6156: border-right: 1px solid black; 6157: display: inline; 6158: vertical-align: middle; 6159: } 6160: 6161: ul.LC_TabContent { 6162: display:block; 6163: background: $sidebg; 6164: border-bottom: solid 1px $lg_border_color; 6165: list-style:none; 6166: margin: 0 -10px; 6167: padding: 0; 6168: } 6169: 6170: ul.LC_TabContent li, 6171: ul.LC_TabContentBigger li { 6172: float:left; 6173: } 6174: 6175: ul#LC_secondary_menu li a { 6176: color: $fontmenu; 6177: text-decoration: none; 6178: } 6179: 6180: ul.LC_TabContent { 6181: min-height:20px; 6182: } 6183: 6184: ul.LC_TabContent li { 6185: vertical-align:middle; 6186: padding: 0 16px 0 10px; 6187: background-color:$tabbg; 6188: border-bottom:solid 1px $lg_border_color; 6189: border-right: solid 1px $font; 6190: } 6191: 6192: ul.LC_TabContent .right { 6193: float:right; 6194: } 6195: 6196: ul.LC_TabContent li a, 6197: ul.LC_TabContent li { 6198: color:rgb(47,47,47); 6199: text-decoration:none; 6200: font-size:95%; 6201: font-weight:bold; 6202: min-height:20px; 6203: } 6204: 6205: ul.LC_TabContent li a:hover, 6206: ul.LC_TabContent li a:focus { 6207: color: $button_hover; 6208: background:none; 6209: outline:none; 6210: } 6211: 6212: ul.LC_TabContent li:hover { 6213: color: $button_hover; 6214: cursor:pointer; 6215: } 6216: 6217: ul.LC_TabContent li.active { 6218: color: $font; 6219: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center; 6220: border-bottom:solid 1px #FFFFFF; 6221: cursor: default; 6222: } 6223: 6224: ul.LC_TabContent li.active a { 6225: color:$font; 6226: background:#FFFFFF; 6227: outline: none; 6228: } 6229: #maincoursedoc { 6230: clear:both; 6231: } 6232: 6233: ul.LC_TabContentBigger { 6234: display:block; 6235: list-style:none; 6236: padding: 0; 6237: } 6238: 6239: ul.LC_TabContentBigger li { 6240: vertical-align:bottom; 6241: height: 30px; 6242: font-size:110%; 6243: font-weight:bold; 6244: color: #737373; 6245: } 6246: 6247: ul.LC_TabContentBigger li.active { 6248: position: relative; 6249: top: 1px; 6250: } 6251: 6252: ul.LC_TabContentBigger li a { 6253: background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat; 6254: height: 30px; 6255: line-height: 30px; 6256: text-align: center; 6257: display: block; 6258: text-decoration: none; 6259: outline: none; 6260: } 6261: 6262: ul.LC_TabContentBigger li.active a { 6263: background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat; 6264: color:$font; 6265: } 6266: 6267: ul.LC_TabContentBigger li b { 6268: background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom; 6269: display: block; 6270: float: left; 6271: padding: 0 30px; 6272: border-bottom: 1px solid $lg_border_color; 6273: } 6274: 6275: ul.LC_TabContentBigger li:hover b { 6276: color:$button_hover; 6277: } 6278: 6279: ul.LC_TabContentBigger li.active b { 6280: background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat; 6281: color:$font; 6282: border: 0; 6283: cursor:default; 6284: } 6285: 6286: 6287: ul.LC_CourseBreadcrumbs { 6288: background: $sidebg; 6289: line-height: 32px; 6290: padding-left: 10px; 6291: margin: 0 0 10px 0; 6292: list-style-position: inside; 6293: 6294: } 6295: 6296: ol#LC_MenuBreadcrumbs, 6297: ol#LC_PathBreadcrumbs { 6298: padding-left: 10px; 6299: margin: 0; 6300: height: 2.5em; /* equal to #LC_breadcrumbs line-height */ 6301: } 6302: 6303: ol#LC_MenuBreadcrumbs li, 6304: ol#LC_PathBreadcrumbs li, 6305: ul.LC_CourseBreadcrumbs li { 6306: display: inline; 6307: white-space: normal; 6308: } 6309: 6310: ol#LC_MenuBreadcrumbs li a, 6311: ul.LC_CourseBreadcrumbs li a { 6312: text-decoration: none; 6313: font-size:90%; 6314: } 6315: 6316: ol#LC_MenuBreadcrumbs h1 { 6317: display: inline; 6318: font-size: 90%; 6319: line-height: 2.5em; 6320: margin: 0; 6321: padding: 0; 6322: } 6323: 6324: ol#LC_PathBreadcrumbs li a { 6325: text-decoration:none; 6326: font-size:100%; 6327: font-weight:bold; 6328: } 6329: 6330: .LC_Box { 6331: border: solid 1px $lg_border_color; 6332: padding: 0 10px 10px 10px; 6333: } 6334: 6335: .LC_AboutMe_Image { 6336: float:left; 6337: margin-right:10px; 6338: } 6339: 6340: .LC_Clear_AboutMe_Image { 6341: clear:left; 6342: } 6343: 6344: dl.LC_ListStyleClean dt { 6345: padding-right: 5px; 6346: display: table-header-group; 6347: } 6348: 6349: dl.LC_ListStyleClean dd { 6350: display: table-row; 6351: } 6352: 6353: .LC_ListStyleClean, 6354: .LC_ListStyleSimple, 6355: .LC_ListStyleNormal, 6356: .LC_ListStyleSpecial { 6357: /* display:block; */ 6358: list-style-position: inside; 6359: list-style-type: none; 6360: overflow: hidden; 6361: padding: 0; 6362: } 6363: 6364: .LC_ListStyleSimple li, 6365: .LC_ListStyleSimple dd, 6366: .LC_ListStyleNormal li, 6367: .LC_ListStyleNormal dd, 6368: .LC_ListStyleSpecial li, 6369: .LC_ListStyleSpecial dd { 6370: margin: 0; 6371: padding: 5px 5px 5px 10px; 6372: clear: both; 6373: } 6374: 6375: .LC_ListStyleClean li, 6376: .LC_ListStyleClean dd { 6377: padding-top: 0; 6378: padding-bottom: 0; 6379: } 6380: 6381: .LC_ListStyleSimple dd, 6382: .LC_ListStyleSimple li { 6383: border-bottom: solid 1px $lg_border_color; 6384: } 6385: 6386: .LC_ListStyleSpecial li, 6387: .LC_ListStyleSpecial dd { 6388: list-style-type: none; 6389: background-color: RGB(220, 220, 220); 6390: margin-bottom: 4px; 6391: } 6392: 6393: table.LC_SimpleTable { 6394: margin:5px; 6395: border:solid 1px $lg_border_color; 6396: } 6397: 6398: table.LC_SimpleTable tr { 6399: padding: 0; 6400: border:solid 1px $lg_border_color; 6401: } 6402: 6403: table.LC_SimpleTable thead { 6404: background:rgb(220,220,220); 6405: } 6406: 6407: div.LC_columnSection { 6408: display: block; 6409: clear: both; 6410: overflow: hidden; 6411: margin: 0; 6412: } 6413: 6414: div.LC_columnSection>* { 6415: float: left; 6416: margin: 10px 20px 10px 0; 6417: overflow:hidden; 6418: } 6419: 6420: table em { 6421: font-weight: bold; 6422: font-style: normal; 6423: } 6424: 6425: table.LC_tableBrowseRes, 6426: table.LC_tableOfContent { 6427: border:none; 6428: border-spacing: 1px; 6429: padding: 3px; 6430: background-color: #FFFFFF; 6431: font-size: 90%; 6432: } 6433: 6434: table.LC_tableOfContent { 6435: border-collapse: collapse; 6436: } 6437: 6438: table.LC_tableBrowseRes a, 6439: table.LC_tableOfContent a { 6440: background-color: transparent; 6441: text-decoration: none; 6442: } 6443: 6444: table.LC_tableOfContent img { 6445: border: none; 6446: height: 1.3em; 6447: vertical-align: text-bottom; 6448: margin-right: 0.3em; 6449: } 6450: 6451: a#LC_content_toolbar_firsthomework { 6452: background-image:url(/res/adm/pages/open-first-problem.gif); 6453: } 6454: 6455: a#LC_content_toolbar_everything { 6456: background-image:url(/res/adm/pages/show-all.gif); 6457: } 6458: 6459: a#LC_content_toolbar_uncompleted { 6460: background-image:url(/res/adm/pages/show-incomplete-problems.gif); 6461: } 6462: 6463: #LC_content_toolbar_clearbubbles { 6464: background-image:url(/res/adm/pages/mark-discussionentries-read.gif); 6465: } 6466: 6467: a#LC_content_toolbar_changefolder { 6468: background : url(/res/adm/pages/close-all-folders.gif) top center ; 6469: } 6470: 6471: a#LC_content_toolbar_changefolder_toggled { 6472: background-image:url(/res/adm/pages/open-all-folders.gif); 6473: } 6474: 6475: ul#LC_toolbar li a:hover { 6476: background-position: bottom center; 6477: } 6478: 6479: ul#LC_toolbar { 6480: padding: 0; 6481: margin: 2px; 6482: list-style:none; 6483: position:relative; 6484: background-color:white; 6485: } 6486: 6487: ul#LC_toolbar li { 6488: border:1px solid white; 6489: padding: 0; 6490: margin: 0; 6491: float: left; 6492: display:inline; 6493: vertical-align:middle; 6494: } 6495: 6496: 6497: a.LC_toolbarItem { 6498: display:block; 6499: padding: 0; 6500: margin: 0; 6501: height: 32px; 6502: width: 32px; 6503: color:white; 6504: border: none; 6505: background-repeat:no-repeat; 6506: background-color:transparent; 6507: } 6508: 6509: ul.LC_funclist { 6510: margin: 0; 6511: padding: 0.5em 1em 0.5em 0; 6512: } 6513: 6514: ul.LC_funclist > li:first-child { 6515: font-weight:bold; 6516: margin-left:0.8em; 6517: } 6518: 6519: ul.LC_funclist + ul.LC_funclist { 6520: /* 6521: left border as a seperator if we have more than 6522: one list 6523: */ 6524: border-left: 1px solid $sidebg; 6525: /* 6526: this hides the left border behind the border of the 6527: outer box if element is wrapped to the next 'line' 6528: */ 6529: margin-left: -1px; 6530: } 6531: 6532: ul.LC_funclist li { 6533: display: inline; 6534: white-space: nowrap; 6535: margin: 0 0 0 25px; 6536: line-height: 150%; 6537: } 6538: 6539: .ui-accordion .LC_advanced_toggle { 6540: float: right; 6541: font-size: 90%; 6542: padding: 0px 4px 6543: } 6544: 6545: .LC_hidden { 6546: display: none; 6547: } 6548: 6549: END 6550: } 6551: 6552: =pod 6553: 6554: =item * &headtag() 6555: 6556: Returns a uniform footer for LON-CAPA web pages. 6557: 6558: Inputs: $title - optional title for the head 6559: $head_extra - optional extra HTML to put inside the <head> 6560: $args - optional arguments 6561: force_register - if is true call registerurl so the remote is 6562: informed 6563: redirect -> array ref of 6564: 1- seconds before redirect occurs 6565: 2- url to redirect to 6566: 3- whether the side effect should occur 6567: (side effect of setting 6568: $env{'internal.head.redirect'} to the url 6569: redirected too) 6570: domain -> force to color decorate a page for a specific 6571: domain 6572: function -> force usage of a specific rolish color scheme 6573: bgcolor -> override the default page bgcolor 6574: no_auto_mt_title 6575: -> prevent &mt()ing the title arg 6576: 6577: =cut 6578: 6579: sub headtag { 6580: my ($title,$head_extra,$args) = @_; 6581: 6582: my $function = $args->{'function'} || &get_users_function(); 6583: my $domain = $args->{'domain'} || &determinedomain(); 6584: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain); 6585: my $url = join(':',$env{'user.name'},$env{'user.domain'}, 6586: $Apache::lonnet::perlvar{'lonVersion'}, 6587: #time(), 6588: $env{'environment.color.timestamp'}, 6589: $function,$domain,$bgcolor); 6590: 6591: $url = '/adm/css/'.&escape($url).'.css'; 6592: 6593: my $result = 6594: '<head>'. 6595: &font_settings(); 6596: 6597: if (!$args->{'frameset'}) { 6598: $result .= &Apache::lonhtmlcommon::htmlareaheaders(); 6599: } 6600: if ($args->{'force_register'} && $env{'request.noversionuri'} !~ m{^/res/adm/pages/}) { 6601: $result .= Apache::lonxml::display_title(); 6602: } 6603: if (!$args->{'no_nav_bar'} 6604: && !$args->{'only_body'} 6605: && !$args->{'frameset'}) { 6606: $result .= &help_menu_js(); 6607: } 6608: 6609: if (ref($args->{'redirect'})) { 6610: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}}; 6611: $url = &Apache::lonenc::check_encrypt($url); 6612: if (!$inhibit_continue) { 6613: $env{'internal.head.redirect'} = $url; 6614: } 6615: $result.=<<ADDMETA 6616: <meta http-equiv="pragma" content="no-cache" /> 6617: <meta http-equiv="Refresh" content="$time; url=$url" /> 6618: ADDMETA 6619: } 6620: if (!defined($title)) { 6621: $title = 'The LearningOnline Network with CAPA'; 6622: } 6623: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); } 6624: $result .= '<title> LON-CAPA '.$title.'</title>' 6625: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />' 6626: .$head_extra; 6627: return $result.'</head>'; 6628: } 6629: 6630: =pod 6631: 6632: =item * &font_settings() 6633: 6634: Returns neccessary <meta> to set the proper encoding 6635: 6636: Inputs: none 6637: 6638: =cut 6639: 6640: sub font_settings { 6641: my $headerstring=''; 6642: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) { 6643: $headerstring.= 6644: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />'; 6645: } 6646: return $headerstring; 6647: } 6648: 6649: =pod 6650: 6651: =item * &xml_begin() 6652: 6653: Returns the needed doctype and <html> 6654: 6655: Inputs: none 6656: 6657: =cut 6658: 6659: sub xml_begin { 6660: my $output=''; 6661: 6662: if ($env{'browser.mathml'}) { 6663: $output='<?xml version="1.0"?>' 6664: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n" 6665: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" ' 6666: 6667: # .'<!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">] >' 6668: .'<!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">' 6669: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 6670: .'xmlns="http://www.w3.org/1999/xhtml">'; 6671: } else { 6672: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' 6673: .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">'; 6674: } 6675: return $output; 6676: } 6677: 6678: =pod 6679: 6680: =item * &start_page() 6681: 6682: Returns a complete <html> .. <body> section for LON-CAPA web pages. 6683: 6684: Inputs: 6685: 6686: =over 4 6687: 6688: $title - optional title for the page 6689: 6690: $head_extra - optional extra HTML to incude inside the <head> 6691: 6692: $args - additional optional args supported are: 6693: 6694: =over 8 6695: 6696: only_body -> is true will set &bodytag() onlybodytag 6697: arg on 6698: no_nav_bar -> is true will set &bodytag() no_nav_bar arg on 6699: add_entries -> additional attributes to add to the <body> 6700: domain -> force to color decorate a page for a 6701: specific domain 6702: function -> force usage of a specific rolish color 6703: scheme 6704: redirect -> see &headtag() 6705: bgcolor -> override the default page bg color 6706: js_ready -> return a string ready for being used in 6707: a javascript writeln 6708: html_encode -> return a string ready for being used in 6709: a html attribute 6710: force_register -> if is true will turn on the &bodytag() 6711: $forcereg arg 6712: frameset -> if true will start with a <frameset> 6713: rather than <body> 6714: skip_phases -> hash ref of 6715: head -> skip the <html><head> generation 6716: body -> skip all <body> generation 6717: no_auto_mt_title -> prevent &mt()ing the title arg 6718: inherit_jsmath -> when creating popup window in a page, 6719: should it have jsmath forced on by the 6720: current page 6721: bread_crumbs -> Array containing breadcrumbs 6722: bread_crumbs_component -> if exists show it as headline else show only the breadcrumbs 6723: 6724: =back 6725: 6726: =back 6727: 6728: =cut 6729: 6730: sub start_page { 6731: my ($title,$head_extra,$args) = @_; 6732: #&Apache::lonnet::logthis("start_page ".join(':',caller(0))); 6733: #SD 6734: #I don't see why we copy certain elements of %$args to %head_args 6735: #head args is passed to headtag() and this routine only reads those 6736: #keys that are needed. There doesn't happen any writes or any processing 6737: #of other keys. 6738: #proposal: just pass $args to headtag instead of \%head_args and delete 6739: #marked lines 6740: #<- MARK 6741: my %head_args; 6742: foreach my $arg ('redirect','force_register','domain','function', 6743: 'bgcolor','frameset','no_nav_bar','only_body', 6744: 'no_auto_mt_title') { 6745: if (defined($args->{$arg})) { 6746: $head_args{$arg} = $args->{$arg}; 6747: } 6748: } 6749: #MARK -> 6750: 6751: $env{'internal.start_page'}++; 6752: my $result; 6753: 6754: if (! exists($args->{'skip_phases'}{'head'}) ) { 6755: $result .= 6756: &xml_begin() . &headtag($title,$head_extra,\%head_args); 6757: #replace prev line by 6758: # &xml_begin() . &headtag($title, $head_extra, $args); 6759: } 6760: 6761: if (! exists($args->{'skip_phases'}{'body'}) ) { 6762: if ($args->{'frameset'}) { 6763: my $attr_string = &make_attr_string($args->{'force_register'}, 6764: $args->{'add_entries'}); 6765: $result .= "\n<frameset $attr_string>\n"; 6766: } else { 6767: $result .= 6768: &bodytag($title, 6769: $args->{'function'}, $args->{'add_entries'}, 6770: $args->{'only_body'}, $args->{'domain'}, 6771: $args->{'force_register'}, $args->{'no_nav_bar'}, 6772: $args->{'bgcolor'}, $args); 6773: } 6774: } 6775: 6776: if ($args->{'js_ready'}) { 6777: $result = &js_ready($result); 6778: } 6779: if ($args->{'html_encode'}) { 6780: $result = &html_encode($result); 6781: } 6782: 6783: # Preparation for new and consistent functionlist at top of screen 6784: # if ($args->{'functionlist'}) { 6785: # $result .= &build_functionlist(); 6786: #} 6787: 6788: # Don't add anything more if only_body wanted or in const space 6789: return $result if $args->{'only_body'} 6790: || $env{'request.state'} eq 'construct'; 6791: 6792: #Breadcrumbs 6793: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) { 6794: &Apache::lonhtmlcommon::clear_breadcrumbs(); 6795: #if any br links exists, add them to the breadcrumbs 6796: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') { 6797: foreach my $crumb (@{$args->{'bread_crumbs'}}){ 6798: &Apache::lonhtmlcommon::add_breadcrumb($crumb); 6799: } 6800: } 6801: 6802: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs 6803: if(exists($args->{'bread_crumbs_component'})){ 6804: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'}); 6805: }else{ 6806: $result .= &Apache::lonhtmlcommon::breadcrumbs(); 6807: } 6808: } 6809: return $result; 6810: } 6811: 6812: sub end_page { 6813: my ($args) = @_; 6814: $env{'internal.end_page'}++; 6815: my $result; 6816: if ($args->{'discussion'}) { 6817: my ($target,$parser); 6818: if (ref($args->{'discussion'})) { 6819: ($target,$parser) =($args->{'discussion'}{'target'}, 6820: $args->{'discussion'}{'parser'}); 6821: } 6822: $result .= &Apache::lonxml::xmlend($target,$parser); 6823: } 6824: 6825: if ($args->{'frameset'}) { 6826: $result .= '</frameset>'; 6827: } else { 6828: $result .= &endbodytag($args); 6829: } 6830: $result .= "\n</html>"; 6831: 6832: if ($args->{'js_ready'}) { 6833: $result = &js_ready($result); 6834: } 6835: 6836: if ($args->{'html_encode'}) { 6837: $result = &html_encode($result); 6838: } 6839: 6840: return $result; 6841: } 6842: 6843: sub html_encode { 6844: my ($result) = @_; 6845: 6846: $result = &HTML::Entities::encode($result,'<>&"'); 6847: 6848: return $result; 6849: } 6850: sub js_ready { 6851: my ($result) = @_; 6852: 6853: $result =~ s/[\n\r]/ /xmsg; 6854: $result =~ s/\\/\\\\/xmsg; 6855: $result =~ s/'/\\'/xmsg; 6856: $result =~ s{</}{<\\/}xmsg; 6857: 6858: return $result; 6859: } 6860: 6861: sub validate_page { 6862: if ( exists($env{'internal.start_page'}) 6863: && $env{'internal.start_page'} > 1) { 6864: &Apache::lonnet::logthis('start_page called multiple times '. 6865: $env{'internal.start_page'}.' '. 6866: $ENV{'request.filename'}); 6867: } 6868: if ( exists($env{'internal.end_page'}) 6869: && $env{'internal.end_page'} > 1) { 6870: &Apache::lonnet::logthis('end_page called multiple times '. 6871: $env{'internal.end_page'}.' '. 6872: $env{'request.filename'}); 6873: } 6874: if ( exists($env{'internal.start_page'}) 6875: && ! exists($env{'internal.end_page'})) { 6876: &Apache::lonnet::logthis('start_page called without end_page '. 6877: $env{'request.filename'}); 6878: } 6879: if ( ! exists($env{'internal.start_page'}) 6880: && exists($env{'internal.end_page'})) { 6881: &Apache::lonnet::logthis('end_page called without start_page'. 6882: $env{'request.filename'}); 6883: } 6884: } 6885: 6886: 6887: sub start_scrollbox { 6888: my ($outerwidth,$width,$height)=@_; 6889: unless ($outerwidth) { $outerwidth='520px'; } 6890: unless ($width) { $width='500px'; } 6891: unless ($height) { $height='200px'; } 6892: return "<table style='width: $outerwidth; border: 1px solid black;'><tr><td style='width: $width;' bgcolor='#FFFFFF'><div style='overflow:auto; width:$width; height: $height;'>"; 6893: } 6894: 6895: sub end_scrollbox { 6896: return '</td></tr></table>'; 6897: } 6898: 6899: sub simple_error_page { 6900: my ($r,$title,$msg) = @_; 6901: my $page = 6902: &Apache::loncommon::start_page($title). 6903: &mt($msg). 6904: &Apache::loncommon::end_page(); 6905: if (ref($r)) { 6906: $r->print($page); 6907: return; 6908: } 6909: return $page; 6910: } 6911: 6912: { 6913: my @row_count; 6914: 6915: sub start_data_table_count { 6916: unshift(@row_count, 0); 6917: return; 6918: } 6919: 6920: sub end_data_table_count { 6921: shift(@row_count); 6922: return; 6923: } 6924: 6925: sub start_data_table { 6926: my ($add_class) = @_; 6927: my $css_class = (join(' ','LC_data_table',$add_class)); 6928: &start_data_table_count(); 6929: return '<table class="'.$css_class.'">'."\n"; 6930: } 6931: 6932: sub end_data_table { 6933: &end_data_table_count(); 6934: return '</table>'."\n";; 6935: } 6936: 6937: sub start_data_table_row { 6938: my ($add_class, $id) = @_; 6939: $row_count[0]++; 6940: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row'; 6941: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq ''); 6942: $id = (' id="'.$id.'"') unless ($id eq ''); 6943: return '<tr class="'.$css_class.'"'.$id.'>'."\n"; 6944: } 6945: 6946: sub continue_data_table_row { 6947: my ($add_class, $id) = @_; 6948: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row'; 6949: $css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq ''); 6950: $id = (' id="'.$id.'"') unless ($id eq ''); 6951: return '<tr class="'.$css_class.'"'.$id.'>'."\n"; 6952: } 6953: 6954: sub end_data_table_row { 6955: return '</tr>'."\n";; 6956: } 6957: 6958: sub start_data_table_empty_row { 6959: # $row_count[0]++; 6960: return '<tr class="LC_empty_row" >'."\n";; 6961: } 6962: 6963: sub end_data_table_empty_row { 6964: return '</tr>'."\n";; 6965: } 6966: 6967: sub start_data_table_header_row { 6968: return '<tr class="LC_header_row">'."\n";; 6969: } 6970: 6971: sub end_data_table_header_row { 6972: return '</tr>'."\n";; 6973: } 6974: 6975: sub data_table_caption { 6976: my $caption = shift; 6977: return "<caption class=\"LC_caption\">$caption</caption>"; 6978: } 6979: } 6980: 6981: =pod 6982: 6983: =item * &inhibit_menu_check($arg) 6984: 6985: Checks for a inhibitmenu state and generates output to preserve it 6986: 6987: Inputs: $arg - can be any of 6988: - undef - in which case the return value is a string 6989: to add into arguments list of a uri 6990: - 'input' - in which case the return value is a HTML 6991: <form> <input> field of type hidden to 6992: preserve the value 6993: - a url - in which case the return value is the url with 6994: the neccesary cgi args added to preserve the 6995: inhibitmenu state 6996: - a ref to a url - no return value, but the string is 6997: updated to include the neccessary cgi 6998: args to preserve the inhibitmenu state 6999: 7000: =cut 7001: 7002: sub inhibit_menu_check { 7003: my ($arg) = @_; 7004: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']); 7005: if ($arg eq 'input') { 7006: if ($env{'form.inhibitmenu'}) { 7007: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />'; 7008: } else { 7009: return 7010: } 7011: } 7012: if ($env{'form.inhibitmenu'}) { 7013: if (ref($arg)) { 7014: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'}; 7015: } elsif ($arg eq '') { 7016: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'}; 7017: } else { 7018: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'}; 7019: } 7020: } 7021: if (!ref($arg)) { 7022: return $arg; 7023: } 7024: } 7025: 7026: ############################################### 7027: 7028: =pod 7029: 7030: =back 7031: 7032: =head1 User Information Routines 7033: 7034: =over 4 7035: 7036: =item * &get_users_function() 7037: 7038: Used by &bodytag to determine the current users primary role. 7039: Returns either 'student','coordinator','admin', or 'author'. 7040: 7041: =cut 7042: 7043: ############################################### 7044: sub get_users_function { 7045: my $function = 'norole'; 7046: if ($env{'request.role'}=~/^(st)/) { 7047: $function='student'; 7048: } 7049: if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) { 7050: $function='coordinator'; 7051: } 7052: if ($env{'request.role'}=~/^(su|dc|ad|li)/) { 7053: $function='admin'; 7054: } 7055: if (($env{'request.role'}=~/^(au|ca|aa)/) || 7056: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) { 7057: $function='author'; 7058: } 7059: return $function; 7060: } 7061: 7062: ############################################### 7063: 7064: =pod 7065: 7066: =item * &show_course() 7067: 7068: Used by lonmenu.pm and lonroles.pm to determine whether to use the word 7069: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles. 7070: 7071: Inputs: 7072: None 7073: 7074: Outputs: 7075: Scalar: 1 if 'Course' to be used, 0 otherwise. 7076: 7077: =cut 7078: 7079: ############################################### 7080: sub show_course { 7081: my $course = !$env{'user.adv'}; 7082: if (!$env{'user.adv'}) { 7083: foreach my $env (keys(%env)) { 7084: next if ($env !~ m/^user\.priv\./); 7085: if ($env !~ m/^user\.priv\.(?:st|cm)/) { 7086: $course = 0; 7087: last; 7088: } 7089: } 7090: } 7091: return $course; 7092: } 7093: 7094: ############################################### 7095: 7096: =pod 7097: 7098: =item * &check_user_status() 7099: 7100: Determines current status of supplied role for a 7101: specific user. Roles can be active, previous or future. 7102: 7103: Inputs: 7104: user's domain, user's username, course's domain, 7105: course's number, optional section ID. 7106: 7107: Outputs: 7108: role status: active, previous or future. 7109: 7110: =cut 7111: 7112: sub check_user_status { 7113: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_; 7114: my $extra = &Apache::lonnet::freeze_escape({'skipcheck' => 1}); 7115: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname,'.',undef,$extra); 7116: my @uroles = keys %userinfo; 7117: my $srchstr; 7118: my $active_chk = 'none'; 7119: my $now = time; 7120: if (@uroles > 0) { 7121: if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) { 7122: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role; 7123: } else { 7124: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role; 7125: } 7126: if (grep/^\Q$srchstr\E$/,@uroles) { 7127: my $role_end = 0; 7128: my $role_start = 0; 7129: $active_chk = 'active'; 7130: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) { 7131: $role_end = $1; 7132: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) { 7133: $role_start = $1; 7134: } 7135: } 7136: if ($role_start > 0) { 7137: if ($now < $role_start) { 7138: $active_chk = 'future'; 7139: } 7140: } 7141: if ($role_end > 0) { 7142: if ($now > $role_end) { 7143: $active_chk = 'previous'; 7144: } 7145: } 7146: } 7147: } 7148: return $active_chk; 7149: } 7150: 7151: ############################################### 7152: 7153: =pod 7154: 7155: =item * &get_sections() 7156: 7157: Determines all the sections for a course including 7158: sections with students and sections containing other roles. 7159: Incoming parameters: 7160: 7161: 1. domain 7162: 2. course number 7163: 3. reference to array containing roles for which sections should 7164: be gathered (optional). 7165: 4. reference to array containing status types for which sections 7166: should be gathered (optional). 7167: 7168: If the third argument is undefined, sections are gathered for any role. 7169: If the fourth argument is undefined, sections are gathered for any status. 7170: Permissible values are 'active' or 'future' or 'previous'. 7171: 7172: Returns section hash (keys are section IDs, values are 7173: number of users in each section), subject to the 7174: optional roles filter, optional status filter 7175: 7176: =cut 7177: 7178: ############################################### 7179: sub get_sections { 7180: my ($cdom,$cnum,$possible_roles,$possible_status) = @_; 7181: if (!defined($cdom) || !defined($cnum)) { 7182: my $cid = $env{'request.course.id'}; 7183: 7184: return if (!defined($cid)); 7185: 7186: $cdom = $env{'course.'.$cid.'.domain'}; 7187: $cnum = $env{'course.'.$cid.'.num'}; 7188: } 7189: 7190: my %sectioncount; 7191: my $now = time; 7192: 7193: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) { 7194: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum); 7195: my $sec_index = &Apache::loncoursedata::CL_SECTION(); 7196: my $status_index = &Apache::loncoursedata::CL_STATUS(); 7197: my $start_index = &Apache::loncoursedata::CL_START(); 7198: my $end_index = &Apache::loncoursedata::CL_END(); 7199: my $status; 7200: while (my ($student,$data) = each(%$classlist)) { 7201: my ($section,$stu_status,$start,$end) = ($data->[$sec_index], 7202: $data->[$status_index], 7203: $data->[$start_index], 7204: $data->[$end_index]); 7205: if ($stu_status eq 'Active') { 7206: $status = 'active'; 7207: } elsif ($end < $now) { 7208: $status = 'previous'; 7209: } elsif ($start > $now) { 7210: $status = 'future'; 7211: } 7212: if ($section ne '-1' && $section !~ /^\s*$/) { 7213: if ((!defined($possible_status)) || (($status ne '') && 7214: (grep/^\Q$status\E$/,@{$possible_status}))) { 7215: $sectioncount{$section}++; 7216: } 7217: } 7218: } 7219: } 7220: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum); 7221: foreach my $user (sort(keys(%courseroles))) { 7222: if ($user !~ /^(\w{2})/) { next; } 7223: my ($role) = ($user =~ /^(\w{2})/); 7224: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; } 7225: my ($section,$status); 7226: if ($role eq 'cr' && 7227: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) { 7228: $section=$1; 7229: } 7230: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; } 7231: if (!defined($section) || $section eq '-1') { next; } 7232: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/); 7233: if ($end == -1 && $start == -1) { 7234: next; #deleted role 7235: } 7236: if (!defined($possible_status)) { 7237: $sectioncount{$section}++; 7238: } else { 7239: if ((!$end || $end >= $now) && (!$start || $start <= $now)) { 7240: $status = 'active'; 7241: } elsif ($end < $now) { 7242: $status = 'future'; 7243: } elsif ($start > $now) { 7244: $status = 'previous'; 7245: } 7246: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) { 7247: $sectioncount{$section}++; 7248: } 7249: } 7250: } 7251: return %sectioncount; 7252: } 7253: 7254: ############################################### 7255: 7256: =pod 7257: 7258: =item * &get_course_users() 7259: 7260: Retrieves usernames:domains for users in the specified course 7261: with specific role(s), and access status. 7262: 7263: Incoming parameters: 7264: 1. course domain 7265: 2. course number 7266: 3. access status: users must have - either active, 7267: previous, future, or all. 7268: 4. reference to array of permissible roles 7269: 5. reference to array of section restrictions (optional) 7270: 6. reference to results object (hash of hashes). 7271: 7. reference to optional userdata hash 7272: 8. reference to optional statushash 7273: 9. flag if privileged users (except those set to unhide in 7274: course settings) should be excluded 7275: Keys of top level results hash are roles. 7276: Keys of inner hashes are username:domain, with 7277: values set to access type. 7278: Optional userdata hash returns an array with arguments in the 7279: same order as loncoursedata::get_classlist() for student data. 7280: 7281: Optional statushash returns 7282: 7283: Entries for end, start, section and status are blank because 7284: of the possibility of multiple values for non-student roles. 7285: 7286: =cut 7287: 7288: ############################################### 7289: 7290: sub get_course_users { 7291: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_; 7292: my %idx = (); 7293: my %seclists; 7294: 7295: $idx{udom} = &Apache::loncoursedata::CL_SDOM(); 7296: $idx{uname} = &Apache::loncoursedata::CL_SNAME(); 7297: $idx{end} = &Apache::loncoursedata::CL_END(); 7298: $idx{start} = &Apache::loncoursedata::CL_START(); 7299: $idx{id} = &Apache::loncoursedata::CL_ID(); 7300: $idx{section} = &Apache::loncoursedata::CL_SECTION(); 7301: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME(); 7302: $idx{status} = &Apache::loncoursedata::CL_STATUS(); 7303: 7304: if (grep(/^st$/,@{$roles})) { 7305: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum); 7306: my $now = time; 7307: foreach my $student (keys(%{$classlist})) { 7308: my $match = 0; 7309: my $secmatch = 0; 7310: my $section = $$classlist{$student}[$idx{section}]; 7311: my $status = $$classlist{$student}[$idx{status}]; 7312: if ($section eq '') { 7313: $section = 'none'; 7314: } 7315: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) { 7316: if (grep(/^all$/,@{$sections})) { 7317: $secmatch = 1; 7318: } elsif ($$classlist{$student}[$idx{section}] eq '') { 7319: if (grep(/^none$/,@{$sections})) { 7320: $secmatch = 1; 7321: } 7322: } else { 7323: if (grep(/^\Q$section\E$/,@{$sections})) { 7324: $secmatch = 1; 7325: } 7326: } 7327: if (!$secmatch) { 7328: next; 7329: } 7330: } 7331: if (defined($$types{'active'})) { 7332: if ($$classlist{$student}[$idx{status}] eq 'Active') { 7333: push(@{$$users{st}{$student}},'active'); 7334: $match = 1; 7335: } 7336: } 7337: if (defined($$types{'previous'})) { 7338: if ($$classlist{$student}[$idx{status}] eq 'Expired') { 7339: push(@{$$users{st}{$student}},'previous'); 7340: $match = 1; 7341: } 7342: } 7343: if (defined($$types{'future'})) { 7344: if ($$classlist{$student}[$idx{status}] eq 'Future') { 7345: push(@{$$users{st}{$student}},'future'); 7346: $match = 1; 7347: } 7348: } 7349: if ($match) { 7350: push(@{$seclists{$student}},$section); 7351: if (ref($userdata) eq 'HASH') { 7352: $$userdata{$student} = $$classlist{$student}; 7353: } 7354: if (ref($statushash) eq 'HASH') { 7355: $statushash->{$student}{'st'}{$section} = $status; 7356: } 7357: } 7358: } 7359: } 7360: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) { 7361: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum); 7362: my $now = time; 7363: my %displaystatus = ( previous => 'Expired', 7364: active => 'Active', 7365: future => 'Future', 7366: ); 7367: my %nothide; 7368: if ($hidepriv) { 7369: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum); 7370: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) { 7371: if ($user !~ /:/) { 7372: $nothide{join(':',split(/[\@]/,$user))}=1; 7373: } else { 7374: $nothide{$user} = 1; 7375: } 7376: } 7377: } 7378: foreach my $person (sort(keys(%coursepersonnel))) { 7379: my $match = 0; 7380: my $secmatch = 0; 7381: my $status; 7382: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/); 7383: $user =~ s/:$//; 7384: my ($end,$start) = split(/:/,$coursepersonnel{$person}); 7385: if ($end == -1 || $start == -1) { 7386: next; 7387: } 7388: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) || 7389: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) { 7390: my ($uname,$udom) = split(/:/,$user); 7391: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) { 7392: if (grep(/^all$/,@{$sections})) { 7393: $secmatch = 1; 7394: } elsif ($usec eq '') { 7395: if (grep(/^none$/,@{$sections})) { 7396: $secmatch = 1; 7397: } 7398: } else { 7399: if (grep(/^\Q$usec\E$/,@{$sections})) { 7400: $secmatch = 1; 7401: } 7402: } 7403: if (!$secmatch) { 7404: next; 7405: } 7406: } 7407: if ($usec eq '') { 7408: $usec = 'none'; 7409: } 7410: if ($uname ne '' && $udom ne '') { 7411: if ($hidepriv) { 7412: if ((&Apache::lonnet::privileged($uname,$udom)) && 7413: (!$nothide{$uname.':'.$udom})) { 7414: next; 7415: } 7416: } 7417: if ($end > 0 && $end < $now) { 7418: $status = 'previous'; 7419: } elsif ($start > $now) { 7420: $status = 'future'; 7421: } else { 7422: $status = 'active'; 7423: } 7424: foreach my $type (keys(%{$types})) { 7425: if ($status eq $type) { 7426: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) { 7427: push(@{$$users{$role}{$user}},$type); 7428: } 7429: $match = 1; 7430: } 7431: } 7432: if (($match) && (ref($userdata) eq 'HASH')) { 7433: if (!exists($$userdata{$uname.':'.$udom})) { 7434: &get_user_info($udom,$uname,\%idx,$userdata); 7435: } 7436: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) { 7437: push(@{$seclists{$uname.':'.$udom}},$usec); 7438: } 7439: if (ref($statushash) eq 'HASH') { 7440: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status}; 7441: } 7442: } 7443: } 7444: } 7445: } 7446: if (grep(/^ow$/,@{$roles})) { 7447: if ((defined($cdom)) && (defined($cnum))) { 7448: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum); 7449: if ( defined($csettings{'internal.courseowner'}) ) { 7450: my $owner = $csettings{'internal.courseowner'}; 7451: next if ($owner eq ''); 7452: my ($ownername,$ownerdom); 7453: if ($owner =~ /^([^:]+):([^:]+)$/) { 7454: $ownername = $1; 7455: $ownerdom = $2; 7456: } else { 7457: $ownername = $owner; 7458: $ownerdom = $cdom; 7459: $owner = $ownername.':'.$ownerdom; 7460: } 7461: @{$$users{'ow'}{$owner}} = 'any'; 7462: if (defined($userdata) && 7463: !exists($$userdata{$owner})) { 7464: &get_user_info($ownerdom,$ownername,\%idx,$userdata); 7465: if (!grep(/^none$/,@{$seclists{$owner}})) { 7466: push(@{$seclists{$owner}},'none'); 7467: } 7468: if (ref($statushash) eq 'HASH') { 7469: $statushash->{$owner}{'ow'}{'none'} = 'Any'; 7470: } 7471: } 7472: } 7473: } 7474: } 7475: foreach my $user (keys(%seclists)) { 7476: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}}); 7477: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}}); 7478: } 7479: } 7480: return; 7481: } 7482: 7483: sub get_user_info { 7484: my ($udom,$uname,$idx,$userdata) = @_; 7485: $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 7486: &plainname($uname,$udom,'lastname'); 7487: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname; 7488: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom; 7489: my %idhash = &Apache::lonnet::idrget($udom,($uname)); 7490: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 7491: return; 7492: } 7493: 7494: ############################################### 7495: 7496: =pod 7497: 7498: =item * &get_user_quota() 7499: 7500: Retrieves quota assigned for storage of portfolio files for a user 7501: 7502: Incoming parameters: 7503: 1. user's username 7504: 2. user's domain 7505: 7506: Returns: 7507: 1. Disk quota (in Mb) assigned to student. 7508: 2. (Optional) Type of setting: custom or default 7509: (individually assigned or default for user's 7510: institutional status). 7511: 3. (Optional) - User's institutional status (e.g., faculty, staff 7512: or student - types as defined in localenroll::inst_usertypes 7513: for user's domain, which determines default quota for user. 7514: 4. (Optional) - Default quota which would apply to the user. 7515: 7516: If a value has been stored in the user's environment, 7517: it will return that, otherwise it returns the maximal default 7518: defined for the user's instituional status(es) in the domain. 7519: 7520: =cut 7521: 7522: ############################################### 7523: 7524: 7525: sub get_user_quota { 7526: my ($uname,$udom) = @_; 7527: my ($quota,$quotatype,$settingstatus,$defquota); 7528: if (!defined($udom)) { 7529: $udom = $env{'user.domain'}; 7530: } 7531: if (!defined($uname)) { 7532: $uname = $env{'user.name'}; 7533: } 7534: if (($udom eq '' || $uname eq '') || 7535: ($udom eq 'public') && ($uname eq 'public')) { 7536: $quota = 0; 7537: $quotatype = 'default'; 7538: $defquota = 0; 7539: } else { 7540: my $inststatus; 7541: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) { 7542: $quota = $env{'environment.portfolioquota'}; 7543: $inststatus = $env{'environment.inststatus'}; 7544: } else { 7545: my %userenv = 7546: &Apache::lonnet::get('environment',['portfolioquota', 7547: 'inststatus'],$udom,$uname); 7548: my ($tmp) = keys(%userenv); 7549: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 7550: $quota = $userenv{'portfolioquota'}; 7551: $inststatus = $userenv{'inststatus'}; 7552: } else { 7553: undef(%userenv); 7554: } 7555: } 7556: ($defquota,$settingstatus) = &default_quota($udom,$inststatus); 7557: if ($quota eq '') { 7558: $quota = $defquota; 7559: $quotatype = 'default'; 7560: } else { 7561: $quotatype = 'custom'; 7562: } 7563: } 7564: if (wantarray) { 7565: return ($quota,$quotatype,$settingstatus,$defquota); 7566: } else { 7567: return $quota; 7568: } 7569: } 7570: 7571: ############################################### 7572: 7573: =pod 7574: 7575: =item * &default_quota() 7576: 7577: Retrieves default quota assigned for storage of user portfolio files, 7578: given an (optional) user's institutional status. 7579: 7580: Incoming parameters: 7581: 1. domain 7582: 2. (Optional) institutional status(es). This is a : separated list of 7583: status types (e.g., faculty, staff, student etc.) 7584: which apply to the user for whom the default is being retrieved. 7585: If the institutional status string in undefined, the domain 7586: default quota will be returned. 7587: 7588: Returns: 7589: 1. Default disk quota (in Mb) for user portfolios in the domain. 7590: 2. (Optional) institutional type which determined the value of the 7591: default quota. 7592: 7593: If a value has been stored in the domain's configuration db, 7594: it will return that, otherwise it returns 20 (for backwards 7595: compatibility with domains which have not set up a configuration 7596: db file; the original statically defined portfolio quota was 20 Mb). 7597: 7598: If the user's status includes multiple types (e.g., staff and student), 7599: the largest default quota which applies to the user determines the 7600: default quota returned. 7601: 7602: =back 7603: 7604: =cut 7605: 7606: ############################################### 7607: 7608: 7609: sub default_quota { 7610: my ($udom,$inststatus) = @_; 7611: my ($defquota,$settingstatus); 7612: my %quotahash = &Apache::lonnet::get_dom('configuration', 7613: ['quotas'],$udom); 7614: if (ref($quotahash{'quotas'}) eq 'HASH') { 7615: if ($inststatus ne '') { 7616: my @statuses = map { &unescape($_); } split(/:/,$inststatus); 7617: foreach my $item (@statuses) { 7618: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') { 7619: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') { 7620: if ($defquota eq '') { 7621: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item}; 7622: $settingstatus = $item; 7623: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) { 7624: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item}; 7625: $settingstatus = $item; 7626: } 7627: } 7628: } else { 7629: if ($quotahash{'quotas'}{$item} ne '') { 7630: if ($defquota eq '') { 7631: $defquota = $quotahash{'quotas'}{$item}; 7632: $settingstatus = $item; 7633: } elsif ($quotahash{'quotas'}{$item} > $defquota) { 7634: $defquota = $quotahash{'quotas'}{$item}; 7635: $settingstatus = $item; 7636: } 7637: } 7638: } 7639: } 7640: } 7641: if ($defquota eq '') { 7642: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') { 7643: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'}; 7644: } else { 7645: $defquota = $quotahash{'quotas'}{'default'}; 7646: } 7647: $settingstatus = 'default'; 7648: } 7649: } else { 7650: $settingstatus = 'default'; 7651: $defquota = 20; 7652: } 7653: if (wantarray) { 7654: return ($defquota,$settingstatus); 7655: } else { 7656: return $defquota; 7657: } 7658: } 7659: 7660: sub get_secgrprole_info { 7661: my ($cdom,$cnum,$needroles,$type) = @_; 7662: my %sections_count = &get_sections($cdom,$cnum); 7663: my @sections = (sort {$a <=> $b} keys(%sections_count)); 7664: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum); 7665: my @groups = sort(keys(%curr_groups)); 7666: my $allroles = []; 7667: my $rolehash; 7668: my $accesshash = { 7669: active => 'Currently has access', 7670: future => 'Will have future access', 7671: previous => 'Previously had access', 7672: }; 7673: if ($needroles) { 7674: $rolehash = {'all' => 'all'}; 7675: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum); 7676: if (&Apache::lonnet::error(%user_roles)) { 7677: undef(%user_roles); 7678: } 7679: foreach my $item (keys(%user_roles)) { 7680: my ($role)=split(/\:/,$item,2); 7681: if ($role eq 'cr') { next; } 7682: if ($role =~ /^cr/) { 7683: $$rolehash{$role} = (split('/',$role))[3]; 7684: } else { 7685: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type); 7686: } 7687: } 7688: foreach my $key (sort(keys(%{$rolehash}))) { 7689: push(@{$allroles},$key); 7690: } 7691: push (@{$allroles},'st'); 7692: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type); 7693: } 7694: return (\@sections,\@groups,$allroles,$rolehash,$accesshash); 7695: } 7696: 7697: sub user_picker { 7698: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype,$context) = @_; 7699: my $currdom = $dom; 7700: my %curr_selected = ( 7701: srchin => 'dom', 7702: srchby => 'lastname', 7703: ); 7704: my $srchterm; 7705: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) { 7706: if ($srch->{'srchby'} ne '') { 7707: $curr_selected{'srchby'} = $srch->{'srchby'}; 7708: } 7709: if ($srch->{'srchin'} ne '') { 7710: $curr_selected{'srchin'} = $srch->{'srchin'}; 7711: } 7712: if ($srch->{'srchtype'} ne '') { 7713: $curr_selected{'srchtype'} = $srch->{'srchtype'}; 7714: } 7715: if ($srch->{'srchdomain'} ne '') { 7716: $currdom = $srch->{'srchdomain'}; 7717: } 7718: $srchterm = $srch->{'srchterm'}; 7719: } 7720: my %lt=&Apache::lonlocal::texthash( 7721: 'usr' => 'Search criteria', 7722: 'doma' => 'Domain/institution to search', 7723: 'uname' => 'username', 7724: 'lastname' => 'last name', 7725: 'lastfirst' => 'last name, first name', 7726: 'crs' => 'in this course', 7727: 'dom' => 'in selected LON-CAPA domain', 7728: 'alc' => 'all LON-CAPA', 7729: 'instd' => 'in institutional directory for selected domain', 7730: 'exact' => 'is', 7731: 'contains' => 'contains', 7732: 'begins' => 'begins with', 7733: 'youm' => "You must include some text to search for.", 7734: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.", 7735: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.", 7736: 'yomc' => "You must choose a domain when using an institutional directory search.", 7737: 'ymcd' => "You must choose a domain when using a domain search.", 7738: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.", 7739: 'whse' => "When searching by last,first you must include at least one character in the first name.", 7740: 'thfo' => "The following need to be corrected before the search can be run:", 7741: ); 7742: my $domform = &select_dom_form($currdom,'srchdomain',1,1); 7743: my $srchinsel = ' <select name="srchin">'; 7744: 7745: my @srchins = ('crs','dom','alc','instd'); 7746: 7747: foreach my $option (@srchins) { 7748: # FIXME 'alc' option unavailable until 7749: # loncreateuser::print_user_query_page() 7750: # has been completed. 7751: next if ($option eq 'alc'); 7752: next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs')); 7753: next if ($option eq 'crs' && !$env{'request.course.id'}); 7754: if ($curr_selected{'srchin'} eq $option) { 7755: $srchinsel .= ' 7756: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>'; 7757: } else { 7758: $srchinsel .= ' 7759: <option value="'.$option.'">'.$lt{$option}.'</option>'; 7760: } 7761: } 7762: $srchinsel .= "\n </select>\n"; 7763: 7764: my $srchbysel = ' <select name="srchby">'; 7765: foreach my $option ('lastname','lastfirst','uname') { 7766: if ($curr_selected{'srchby'} eq $option) { 7767: $srchbysel .= ' 7768: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>'; 7769: } else { 7770: $srchbysel .= ' 7771: <option value="'.$option.'">'.$lt{$option}.'</option>'; 7772: } 7773: } 7774: $srchbysel .= "\n </select>\n"; 7775: 7776: my $srchtypesel = ' <select name="srchtype">'; 7777: foreach my $option ('begins','contains','exact') { 7778: if ($curr_selected{'srchtype'} eq $option) { 7779: $srchtypesel .= ' 7780: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>'; 7781: } else { 7782: $srchtypesel .= ' 7783: <option value="'.$option.'">'.$lt{$option}.'</option>'; 7784: } 7785: } 7786: $srchtypesel .= "\n </select>\n"; 7787: 7788: my ($newuserscript,$new_user_create); 7789: my $context_dom = $env{'request.role.domain'}; 7790: if ($context eq 'requestcrs') { 7791: if ($env{'form.coursedom'} ne '') { 7792: $context_dom = $env{'form.coursedom'}; 7793: } 7794: } 7795: if ($forcenewuser) { 7796: if (ref($srch) eq 'HASH') { 7797: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $context_dom) { 7798: if ($cancreate) { 7799: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>'; 7800: } else { 7801: my $helplink = 'javascript:helpMenu('."'display'".')'; 7802: my %usertypetext = ( 7803: official => 'institutional', 7804: unofficial => 'non-institutional', 7805: ); 7806: $new_user_create = '<p class="LC_warning">' 7807: .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.") 7808: .' ' 7809: .&mt('Please contact the [_1]helpdesk[_2] for assistance.' 7810: ,'<a href="'.$helplink.'">','</a>') 7811: .'</p><br />'; 7812: } 7813: } 7814: } 7815: 7816: $newuserscript = <<"ENDSCRIPT"; 7817: 7818: function setSearch(createnew,callingForm) { 7819: if (createnew == 1) { 7820: for (var i=0; i<callingForm.srchby.length; i++) { 7821: if (callingForm.srchby.options[i].value == 'uname') { 7822: callingForm.srchby.selectedIndex = i; 7823: } 7824: } 7825: for (var i=0; i<callingForm.srchin.length; i++) { 7826: if ( callingForm.srchin.options[i].value == 'dom') { 7827: callingForm.srchin.selectedIndex = i; 7828: } 7829: } 7830: for (var i=0; i<callingForm.srchtype.length; i++) { 7831: if (callingForm.srchtype.options[i].value == 'exact') { 7832: callingForm.srchtype.selectedIndex = i; 7833: } 7834: } 7835: for (var i=0; i<callingForm.srchdomain.length; i++) { 7836: if (callingForm.srchdomain.options[i].value == '$context_dom') { 7837: callingForm.srchdomain.selectedIndex = i; 7838: } 7839: } 7840: } 7841: } 7842: ENDSCRIPT 7843: 7844: } 7845: 7846: my $output = <<"END_BLOCK"; 7847: <script type="text/javascript"> 7848: // <![CDATA[ 7849: function validateEntry(callingForm) { 7850: 7851: var checkok = 1; 7852: var srchin; 7853: for (var i=0; i<callingForm.srchin.length; i++) { 7854: if ( callingForm.srchin[i].checked ) { 7855: srchin = callingForm.srchin[i].value; 7856: } 7857: } 7858: 7859: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value; 7860: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value; 7861: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value; 7862: var srchterm = callingForm.srchterm.value; 7863: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value; 7864: var msg = ""; 7865: 7866: if (srchterm == "") { 7867: checkok = 0; 7868: msg += "$lt{'youm'}\\n"; 7869: } 7870: 7871: if (srchtype== 'begins') { 7872: if (srchterm.length < 2) { 7873: checkok = 0; 7874: msg += "$lt{'thte'}\\n"; 7875: } 7876: } 7877: 7878: if (srchtype== 'contains') { 7879: if (srchterm.length < 3) { 7880: checkok = 0; 7881: msg += "$lt{'thet'}\\n"; 7882: } 7883: } 7884: if (srchin == 'instd') { 7885: if (srchdomain == '') { 7886: checkok = 0; 7887: msg += "$lt{'yomc'}\\n"; 7888: } 7889: } 7890: if (srchin == 'dom') { 7891: if (srchdomain == '') { 7892: checkok = 0; 7893: msg += "$lt{'ymcd'}\\n"; 7894: } 7895: } 7896: if (srchby == 'lastfirst') { 7897: if (srchterm.indexOf(",") == -1) { 7898: checkok = 0; 7899: msg += "$lt{'whus'}\\n"; 7900: } 7901: if (srchterm.indexOf(",") == srchterm.length -1) { 7902: checkok = 0; 7903: msg += "$lt{'whse'}\\n"; 7904: } 7905: } 7906: if (checkok == 0) { 7907: alert("$lt{'thfo'}\\n"+msg); 7908: return; 7909: } 7910: if (checkok == 1) { 7911: callingForm.submit(); 7912: } 7913: } 7914: 7915: $newuserscript 7916: 7917: // ]]> 7918: </script> 7919: 7920: $new_user_create 7921: 7922: END_BLOCK 7923: 7924: $output .= &Apache::lonhtmlcommon::start_pick_box(). 7925: &Apache::lonhtmlcommon::row_title($lt{'doma'}). 7926: $domform. 7927: &Apache::lonhtmlcommon::row_closure(). 7928: &Apache::lonhtmlcommon::row_title($lt{'usr'}). 7929: $srchbysel. 7930: $srchtypesel. 7931: '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'. 7932: $srchinsel. 7933: &Apache::lonhtmlcommon::row_closure(1). 7934: &Apache::lonhtmlcommon::end_pick_box(). 7935: '<br />'; 7936: return $output; 7937: } 7938: 7939: sub user_rule_check { 7940: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_; 7941: my $response; 7942: if (ref($usershash) eq 'HASH') { 7943: foreach my $user (keys(%{$usershash})) { 7944: my ($uname,$udom) = split(/:/,$user); 7945: next if ($udom eq '' || $uname eq ''); 7946: my ($id,$newuser); 7947: if (ref($usershash->{$user}) eq 'HASH') { 7948: $newuser = $usershash->{$user}->{'newuser'}; 7949: $id = $usershash->{$user}->{'id'}; 7950: } 7951: my $inst_response; 7952: if (ref($checks) eq 'HASH') { 7953: if (defined($checks->{'username'})) { 7954: ($inst_response,%{$inst_results->{$user}}) = 7955: &Apache::lonnet::get_instuser($udom,$uname); 7956: } elsif (defined($checks->{'id'})) { 7957: ($inst_response,%{$inst_results->{$user}}) = 7958: &Apache::lonnet::get_instuser($udom,undef,$id); 7959: } 7960: } else { 7961: ($inst_response,%{$inst_results->{$user}}) = 7962: &Apache::lonnet::get_instuser($udom,$uname); 7963: return; 7964: } 7965: if (!$got_rules->{$udom}) { 7966: my %domconfig = &Apache::lonnet::get_dom('configuration', 7967: ['usercreation'],$udom); 7968: if (ref($domconfig{'usercreation'}) eq 'HASH') { 7969: foreach my $item ('username','id') { 7970: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') { 7971: $$curr_rules{$udom}{$item} = 7972: $domconfig{'usercreation'}{$item.'_rule'}; 7973: } 7974: } 7975: } 7976: $got_rules->{$udom} = 1; 7977: } 7978: foreach my $item (keys(%{$checks})) { 7979: if (ref($$curr_rules{$udom}) eq 'HASH') { 7980: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') { 7981: if (@{$$curr_rules{$udom}{$item}} > 0) { 7982: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item}); 7983: foreach my $rule (@{$$curr_rules{$udom}{$item}}) { 7984: if ($rule_check{$rule}) { 7985: $$rulematch{$user}{$item} = $rule; 7986: if ($inst_response eq 'ok') { 7987: if (ref($inst_results) eq 'HASH') { 7988: if (ref($inst_results->{$user}) eq 'HASH') { 7989: if (keys(%{$inst_results->{$user}}) == 0) { 7990: $$alerts{$item}{$udom}{$uname} = 1; 7991: } 7992: } 7993: } 7994: } 7995: last; 7996: } 7997: } 7998: } 7999: } 8000: } 8001: } 8002: } 8003: } 8004: return; 8005: } 8006: 8007: sub user_rule_formats { 8008: my ($domain,$domdesc,$curr_rules,$check) = @_; 8009: my %text = ( 8010: 'username' => 'Usernames', 8011: 'id' => 'IDs', 8012: ); 8013: my $output; 8014: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check); 8015: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) { 8016: if (@{$ruleorder} > 0) { 8017: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>'; 8018: foreach my $rule (@{$ruleorder}) { 8019: if (ref($curr_rules) eq 'ARRAY') { 8020: if (grep(/^\Q$rule\E$/,@{$curr_rules})) { 8021: if (ref($rules->{$rule}) eq 'HASH') { 8022: $output .= '<li>'.$rules->{$rule}{'name'}.': '. 8023: $rules->{$rule}{'desc'}.'</li>'; 8024: } 8025: } 8026: } 8027: } 8028: $output .= '</ul>'; 8029: } 8030: } 8031: return $output; 8032: } 8033: 8034: sub instrule_disallow_msg { 8035: my ($checkitem,$domdesc,$count,$mode) = @_; 8036: my $response; 8037: my %text = ( 8038: item => 'username', 8039: items => 'usernames', 8040: match => 'matches', 8041: do => 'does', 8042: action => 'a username', 8043: one => 'one', 8044: ); 8045: if ($count > 1) { 8046: $text{'item'} = 'usernames'; 8047: $text{'match'} ='match'; 8048: $text{'do'} = 'do'; 8049: $text{'action'} = 'usernames', 8050: $text{'one'} = 'ones'; 8051: } 8052: if ($checkitem eq 'id') { 8053: $text{'items'} = 'IDs'; 8054: $text{'item'} = 'ID'; 8055: $text{'action'} = 'an ID'; 8056: if ($count > 1) { 8057: $text{'item'} = 'IDs'; 8058: $text{'action'} = 'IDs'; 8059: } 8060: } 8061: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />'; 8062: if ($mode eq 'upload') { 8063: if ($checkitem eq 'username') { 8064: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}."); 8065: } elsif ($checkitem eq 'id') { 8066: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field."); 8067: } 8068: } elsif ($mode eq 'selfcreate') { 8069: if ($checkitem eq 'id') { 8070: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank."); 8071: } 8072: } else { 8073: if ($checkitem eq 'username') { 8074: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}."); 8075: } elsif ($checkitem eq 'id') { 8076: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank."); 8077: } 8078: } 8079: return $response; 8080: } 8081: 8082: sub personal_data_fieldtitles { 8083: my %fieldtitles = &Apache::lonlocal::texthash ( 8084: id => 'Student/Employee ID', 8085: permanentemail => 'E-mail address', 8086: lastname => 'Last Name', 8087: firstname => 'First Name', 8088: middlename => 'Middle Name', 8089: generation => 'Generation', 8090: gen => 'Generation', 8091: inststatus => 'Affiliation', 8092: ); 8093: return %fieldtitles; 8094: } 8095: 8096: sub sorted_inst_types { 8097: my ($dom) = @_; 8098: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom); 8099: my $othertitle = &mt('All users'); 8100: if ($env{'request.course.id'}) { 8101: $othertitle = &mt('Any users'); 8102: } 8103: my @types; 8104: if (ref($order) eq 'ARRAY') { 8105: @types = @{$order}; 8106: } 8107: if (@types == 0) { 8108: if (ref($usertypes) eq 'HASH') { 8109: @types = sort(keys(%{$usertypes})); 8110: } 8111: } 8112: if (keys(%{$usertypes}) > 0) { 8113: $othertitle = &mt('Other users'); 8114: } 8115: return ($othertitle,$usertypes,\@types); 8116: } 8117: 8118: sub get_institutional_codes { 8119: my ($settings,$allcourses,$LC_code) = @_; 8120: # Get complete list of course sections to update 8121: my @currsections = (); 8122: my @currxlists = (); 8123: my $coursecode = $$settings{'internal.coursecode'}; 8124: 8125: if ($$settings{'internal.sectionnums'} ne '') { 8126: @currsections = split(/,/,$$settings{'internal.sectionnums'}); 8127: } 8128: 8129: if ($$settings{'internal.crosslistings'} ne '') { 8130: @currxlists = split(/,/,$$settings{'internal.crosslistings'}); 8131: } 8132: 8133: if (@currxlists > 0) { 8134: foreach (@currxlists) { 8135: if (m/^([^:]+):(\w*)$/) { 8136: unless (grep/^$1$/,@{$allcourses}) { 8137: push @{$allcourses},$1; 8138: $$LC_code{$1} = $2; 8139: } 8140: } 8141: } 8142: } 8143: 8144: if (@currsections > 0) { 8145: foreach (@currsections) { 8146: if (m/^(\w+):(\w*)$/) { 8147: my $sec = $coursecode.$1; 8148: my $lc_sec = $2; 8149: unless (grep/^$sec$/,@{$allcourses}) { 8150: push @{$allcourses},$sec; 8151: $$LC_code{$sec} = $lc_sec; 8152: } 8153: } 8154: } 8155: } 8156: return; 8157: } 8158: 8159: sub get_standard_codeitems { 8160: return ('Year','Semester','Department','Number','Section'); 8161: } 8162: 8163: =pod 8164: 8165: =head1 Slot Helpers 8166: 8167: =over 4 8168: 8169: =item * sorted_slots() 8170: 8171: Sorts an array of slot names in order of slot start time (earliest first). 8172: 8173: Inputs: 8174: 8175: =over 4 8176: 8177: slotsarr - Reference to array of unsorted slot names. 8178: 8179: slots - Reference to hash of hash, where outer hash keys are slot names. 8180: 8181: =back 8182: 8183: Returns: 8184: 8185: =over 4 8186: 8187: sorted - An array of slot names sorted by the start time of the slot. 8188: 8189: =back 8190: 8191: =back 8192: 8193: =cut 8194: 8195: 8196: sub sorted_slots { 8197: my ($slotsarr,$slots) = @_; 8198: my @sorted; 8199: if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) { 8200: @sorted = 8201: sort { 8202: if (ref($slots->{$a}) && ref($slots->{$b})) { 8203: return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'} 8204: } 8205: if (ref($slots->{$a})) { return -1;} 8206: if (ref($slots->{$b})) { return 1;} 8207: return 0; 8208: } @{$slotsarr}; 8209: } 8210: return @sorted; 8211: } 8212: 8213: 8214: =pod 8215: 8216: =head1 HTTP Helpers 8217: 8218: =over 4 8219: 8220: =item * &get_unprocessed_cgi($query,$possible_names) 8221: 8222: Modify the %env hash to contain unprocessed CGI form parameters held in 8223: $query. The parameters listed in $possible_names (an array reference), 8224: will be set in $env{'form.name'} if they do not already exist. 8225: 8226: Typically called with $ENV{'QUERY_STRING'} as the first parameter. 8227: $possible_names is an ref to an array of form element names. As an example: 8228: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']); 8229: will result in $env{'form.uname'} and $env{'form.udom'} being set. 8230: 8231: =cut 8232: 8233: sub get_unprocessed_cgi { 8234: my ($query,$possible_names)= @_; 8235: # $Apache::lonxml::debug=1; 8236: foreach my $pair (split(/&/,$query)) { 8237: my ($name, $value) = split(/=/,$pair); 8238: $name = &unescape($name); 8239: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) { 8240: $value =~ tr/+/ /; 8241: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg; 8242: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) }; 8243: } 8244: } 8245: } 8246: 8247: =pod 8248: 8249: =item * &cacheheader() 8250: 8251: returns cache-controlling header code 8252: 8253: =cut 8254: 8255: sub cacheheader { 8256: unless ($env{'request.method'} eq 'GET') { return ''; } 8257: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime); 8258: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" /> 8259: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" /> 8260: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />'; 8261: return $output; 8262: } 8263: 8264: =pod 8265: 8266: =item * &no_cache($r) 8267: 8268: specifies header code to not have cache 8269: 8270: =cut 8271: 8272: sub no_cache { 8273: my ($r) = @_; 8274: if ($ENV{'REQUEST_METHOD'} ne 'GET' && 8275: $env{'request.method'} ne 'GET') { return ''; } 8276: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time)); 8277: $r->no_cache(1); 8278: $r->header_out("Expires" => $date); 8279: $r->header_out("Pragma" => "no-cache"); 8280: } 8281: 8282: sub content_type { 8283: my ($r,$type,$charset) = @_; 8284: if ($r) { 8285: # Note that printout.pl calls this with undef for $r. 8286: &no_cache($r); 8287: } 8288: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; } 8289: unless ($charset) { 8290: $charset=&Apache::lonlocal::current_encoding; 8291: } 8292: if ($charset) { $type.='; charset='.$charset; } 8293: if ($r) { 8294: $r->content_type($type); 8295: } else { 8296: print("Content-type: $type\n\n"); 8297: } 8298: } 8299: 8300: =pod 8301: 8302: =item * &add_to_env($name,$value) 8303: 8304: adds $name to the %env hash with value 8305: $value, if $name already exists, the entry is converted to an array 8306: reference and $value is added to the array. 8307: 8308: =cut 8309: 8310: sub add_to_env { 8311: my ($name,$value)=@_; 8312: if (defined($env{$name})) { 8313: if (ref($env{$name})) { 8314: #already have multiple values 8315: push(@{ $env{$name} },$value); 8316: } else { 8317: #first time seeing multiple values, convert hash entry to an arrayref 8318: my $first=$env{$name}; 8319: undef($env{$name}); 8320: push(@{ $env{$name} },$first,$value); 8321: } 8322: } else { 8323: $env{$name}=$value; 8324: } 8325: } 8326: 8327: =pod 8328: 8329: =item * &get_env_multiple($name) 8330: 8331: gets $name from the %env hash, it seemlessly handles the cases where multiple 8332: values may be defined and end up as an array ref. 8333: 8334: returns an array of values 8335: 8336: =cut 8337: 8338: sub get_env_multiple { 8339: my ($name) = @_; 8340: my @values; 8341: if (defined($env{$name})) { 8342: # exists is it an array 8343: if (ref($env{$name})) { 8344: @values=@{ $env{$name} }; 8345: } else { 8346: $values[0]=$env{$name}; 8347: } 8348: } 8349: return(@values); 8350: } 8351: 8352: sub ask_for_embedded_content { 8353: my ($actionurl,$state,$allfiles,$codebase,$args)=@_; 8354: my (%subdependencies,%dependencies,%mapping,%existing,%newfiles,%pathchanges); 8355: my $num = 0; 8356: my $numremref = 0; 8357: my $numinvalid = 0; 8358: my $numpathchg = 0; 8359: my $numexisting = 0; 8360: my ($output,$upload_output,$toplevel,$url,$udom,$uname,$getpropath); 8361: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 8362: my $current_path='/'; 8363: if ($env{'form.currentpath'}) { 8364: $current_path = $env{'form.currentpath'}; 8365: } 8366: if ($actionurl eq '/adm/coursegrp_portfolio') { 8367: $udom = $env{'course.'.$env{'request.course.id'}.'.domain'}; 8368: $uname = $env{'course.'.$env{'request.course.id'}.'.num'}; 8369: $url = '/userfiles/groups/'.$env{'form.group'}.'/portfolio'; 8370: } else { 8371: $udom = $env{'user.domain'}; 8372: $uname = $env{'user.name'}; 8373: $url = '/userfiles/portfolio'; 8374: } 8375: $toplevel = $url.'/'; 8376: $url .= $current_path; 8377: $getpropath = 1; 8378: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 8379: ($actionurl eq '/adm/imsimport')) { 8380: ($uname,my $rest) = ($args->{'current_path'} =~ m{/priv/($match_username)/?(.*)$}); 8381: $url = '/home/'.$uname.'/public_html/'; 8382: $toplevel = $url; 8383: if ($rest ne '') { 8384: $url .= $rest; 8385: } 8386: } elsif ($actionurl eq '/adm/coursedocs') { 8387: if (ref($args) eq 'HASH') { 8388: $url = $args->{'docs_url'}; 8389: $toplevel = $url; 8390: } 8391: } 8392: my $now = time(); 8393: foreach my $embed_file (keys(%{$allfiles})) { 8394: my $absolutepath; 8395: if ($embed_file =~ m{^\w+://}) { 8396: $newfiles{$embed_file} = 1; 8397: $mapping{$embed_file} = $embed_file; 8398: } else { 8399: if ($embed_file =~ m{^/}) { 8400: $absolutepath = $embed_file; 8401: $embed_file =~ s{^(/+)}{}; 8402: } 8403: if ($embed_file =~ m{/}) { 8404: my ($path,$fname) = ($embed_file =~ m{^(.+)/([^/]*)$}); 8405: $path = &check_for_traversal($path,$url,$toplevel); 8406: my $item = $fname; 8407: if ($path ne '') { 8408: $item = $path.'/'.$fname; 8409: $subdependencies{$path}{$fname} = 1; 8410: } else { 8411: $dependencies{$item} = 1; 8412: } 8413: if ($absolutepath) { 8414: $mapping{$item} = $absolutepath; 8415: } else { 8416: $mapping{$item} = $embed_file; 8417: } 8418: } else { 8419: $dependencies{$embed_file} = 1; 8420: if ($absolutepath) { 8421: $mapping{$embed_file} = $absolutepath; 8422: } else { 8423: $mapping{$embed_file} = $embed_file; 8424: } 8425: } 8426: } 8427: } 8428: foreach my $path (keys(%subdependencies)) { 8429: my %currsubfile; 8430: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 8431: my @subdir_list = &Apache::lonnet::dirlist($url.$path,$udom,$uname,$getpropath); 8432: foreach my $line (@subdir_list) { 8433: my ($file_name,$rest) = split(/\&/,$line,2); 8434: $currsubfile{$file_name} = 1; 8435: } 8436: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) { 8437: if (opendir(my $dir,$url.'/'.$path)) { 8438: my @subdir_list = grep(!/^\./,readdir($dir)); 8439: map {$currsubfile{$_} = 1;} @subdir_list; 8440: } 8441: } 8442: foreach my $file (keys(%{$subdependencies{$path}})) { 8443: if ($currsubfile{$file}) { 8444: my $item = $path.'/'.$file; 8445: unless ($mapping{$item} eq $item) { 8446: $pathchanges{$item} = 1; 8447: } 8448: $existing{$item} = 1; 8449: $numexisting ++; 8450: } else { 8451: $newfiles{$path.'/'.$file} = 1; 8452: } 8453: } 8454: } 8455: my %currfile; 8456: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 8457: my @dir_list = &Apache::lonnet::dirlist($url,$udom,$uname,$getpropath); 8458: foreach my $line (@dir_list) { 8459: my ($file_name,$rest) = split(/\&/,$line,2); 8460: $currfile{$file_name} = 1; 8461: } 8462: } elsif (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) { 8463: if (opendir(my $dir,$url)) { 8464: my @dir_list = grep(!/^\./,readdir($dir)); 8465: map {$currfile{$_} = 1;} @dir_list; 8466: } 8467: } 8468: foreach my $file (keys(%dependencies)) { 8469: if ($currfile{$file}) { 8470: unless ($mapping{$file} eq $file) { 8471: $pathchanges{$file} = 1; 8472: } 8473: $existing{$file} = 1; 8474: $numexisting ++; 8475: } else { 8476: $newfiles{$file} = 1; 8477: } 8478: } 8479: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%newfiles)) { 8480: $upload_output .= &start_data_table_row(). 8481: '<td><span class="LC_filename">'.$embed_file.'</span>'; 8482: unless ($mapping{$embed_file} eq $embed_file) { 8483: $upload_output .= '<br /><span class="LC_info" style="font-size:smaller;">'.&mt('changed from: [_1]',$mapping{$embed_file}).'</span>'; 8484: } 8485: $upload_output .= '</td><td>'; 8486: if ($args->{'ignore_remote_references'} 8487: && $embed_file =~ m{^\w+://}) { 8488: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>'; 8489: $numremref++; 8490: } elsif ($args->{'error_on_invalid_names'} 8491: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) { 8492: 8493: $upload_output.='<span class="LC_warning">'.&mt('Invalid characters').'</span>'; 8494: $numinvalid++; 8495: } else { 8496: $upload_output .= &embedded_file_element('upload_embedded',$num, 8497: $embed_file,\%mapping, 8498: $allfiles,$codebase); 8499: $num++; 8500: } 8501: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row()."\n"; 8502: } 8503: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%existing)) { 8504: $upload_output .= &start_data_table_row(). 8505: '<td><span class="LC_filename">'.$embed_file.'</span></td>'. 8506: '<td><span class="LC_warning">'.&mt('Already exists').'</span></td>'. 8507: &Apache::loncommon::end_data_table_row()."\n"; 8508: } 8509: if ($upload_output) { 8510: $upload_output = &start_data_table(). 8511: $upload_output. 8512: &end_data_table()."\n"; 8513: } 8514: my $applies = 0; 8515: if ($numremref) { 8516: $applies ++; 8517: } 8518: if ($numinvalid) { 8519: $applies ++; 8520: } 8521: if ($numexisting) { 8522: $applies ++; 8523: } 8524: if ($num) { 8525: $output = '<form name="upload_embedded" action="'.$actionurl.'"'. 8526: ' method="post" enctype="multipart/form-data">'."\n". 8527: $state. 8528: '<h3>'.&mt('Upload embedded files'). 8529: ':</h3>'.$upload_output.'<br />'."\n". 8530: '<input type ="hidden" name="number_embedded_items" value="'. 8531: $num.'" />'."\n"; 8532: if ($actionurl eq '') { 8533: $output .= '<input type="hidden" name="phase" value="three" />'; 8534: } 8535: } elsif ($applies) { 8536: $output = '<b>'.&mt('Referenced files').'</b>:<br />'; 8537: if ($applies > 1) { 8538: $output .= 8539: &mt('No files need to be uploaded, as one of the following applies to each reference:').'<ul>'; 8540: if ($numremref) { 8541: $output .= '<li>'.&mt('reference is to a URL which points to another server').'</li>'."\n"; 8542: } 8543: if ($numinvalid) { 8544: $output .= '<li>'.&mt('reference is to file with a name containing invalid characters').'</li>'."\n"; 8545: } 8546: if ($numexisting) { 8547: $output .= '<li>'.&mt('reference is to an existing file at the specified location').'</li>'."\n"; 8548: } 8549: $output .= '</ul><br />'; 8550: } elsif ($numremref) { 8551: $output .= '<p>'.&mt('None to upload, as all references are to URLs pointing to another server.').'</p>'; 8552: } elsif ($numinvalid) { 8553: $output .= '<p>'.&mt('None to upload, as all references are to files with names containing invalid characters.').'</p>'; 8554: } elsif ($numexisting) { 8555: $output .= '<p>'.&mt('None to upload, as all references are to existing files.').'</p>'; 8556: } 8557: $output .= $upload_output.'<br />'; 8558: } 8559: my ($pathchange_output,$chgcount); 8560: $chgcount = $num; 8561: if (keys(%pathchanges) > 0) { 8562: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%pathchanges)) { 8563: if ($num) { 8564: $output .= &embedded_file_element('pathchange',$chgcount, 8565: $embed_file,\%mapping, 8566: $allfiles,$codebase); 8567: } else { 8568: $pathchange_output .= 8569: &start_data_table_row(). 8570: '<td><input type ="checkbox" name="namechange" value="'. 8571: $chgcount.'" checked="checked" /></td>'. 8572: '<td>'.$mapping{$embed_file}.'</td>'. 8573: '<td>'.$embed_file. 8574: &embedded_file_element('pathchange',$numpathchg,$embed_file, 8575: \%mapping,$allfiles,$codebase). 8576: '</td>'.&end_data_table_row(); 8577: } 8578: $numpathchg ++; 8579: $chgcount ++; 8580: } 8581: } 8582: if ($num) { 8583: if ($numpathchg) { 8584: $output .= '<input type ="hidden" name="number_pathchange_items" value="'. 8585: $numpathchg.'" />'."\n"; 8586: } 8587: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank') || 8588: ($actionurl eq '/adm/imsimport')) { 8589: $output .= '<input type="hidden" name="phase" value="three" />'."\n"; 8590: } elsif ($actionurl eq '/adm/portfolio' || $actionurl eq '/adm/coursegrp_portfolio') { 8591: $output .= '<input type="hidden" name="action" value="upload_embedded" />'; 8592: } 8593: $output .= '<input type ="submit" value="'.&mt('Upload Listed Files').'" />'."\n". 8594: &mt('(only files for which a location has been provided will be uploaded)').'</form>'."\n"; 8595: } elsif ($numpathchg) { 8596: my %pathchange = (); 8597: $output .= &modify_html_form('pathchange',$actionurl,$state,\%pathchange,$pathchange_output); 8598: if (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 8599: $output .= '<p>'.&mt('or').'</p>'; 8600: } 8601: } 8602: return ($output,$num,$numpathchg); 8603: } 8604: 8605: sub embedded_file_element { 8606: my ($context,$num,$embed_file,$mapping,$allfiles,$codebase) = @_; 8607: return unless ((ref($mapping) eq 'HASH') && (ref($allfiles) eq 'HASH') && 8608: (ref($codebase) eq 'HASH')); 8609: my $output; 8610: if ($context eq 'upload_embedded') { 8611: $output = '<input name="embedded_item_'.$num.'" type="file" value="" />'."\n"; 8612: } 8613: $output .= '<input name="embedded_orig_'.$num.'" type="hidden" value="'. 8614: &escape($embed_file).'" />'; 8615: unless (($context eq 'upload_embedded') && 8616: ($mapping->{$embed_file} eq $embed_file)) { 8617: $output .=' 8618: <input name="embedded_ref_'.$num.'" type="hidden" value="'.&escape($mapping->{$embed_file}).'" />'; 8619: } 8620: my $attrib; 8621: if (ref($allfiles->{$mapping->{$embed_file}}) eq 'ARRAY') { 8622: $attrib = &escape(join(':',@{$allfiles->{$mapping->{$embed_file}}})); 8623: } 8624: $output .= 8625: "\n\t\t". 8626: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'. 8627: $attrib.'" />'; 8628: if (exists($codebase->{$mapping->{$embed_file}})) { 8629: $output .= 8630: "\n\t\t". 8631: '<input name="codebase_'.$num.'" type="hidden" value="'. 8632: &escape($codebase->{$mapping->{$embed_file}}).'" />'; 8633: } 8634: return $output; 8635: } 8636: 8637: sub upload_embedded { 8638: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota, 8639: $current_disk_usage,$hiddenstate,$actionurl) = @_; 8640: my (%pathchange,$output,$modifyform,$footer,$returnflag); 8641: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) { 8642: next if (!exists($env{'form.embedded_item_'.$i.'.filename'})); 8643: my $orig_uploaded_filename = 8644: $env{'form.embedded_item_'.$i.'.filename'}; 8645: foreach my $type ('orig','ref','attrib','codebase') { 8646: if ($env{'form.embedded_'.$type.'_'.$i} ne '') { 8647: $env{'form.embedded_'.$type.'_'.$i} = 8648: &unescape($env{'form.embedded_'.$type.'_'.$i}); 8649: } 8650: } 8651: my ($path,$fname) = 8652: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)}); 8653: # no path, whole string is fname 8654: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} }; 8655: $fname = &Apache::lonnet::clean_filename($fname); 8656: # See if there is anything left 8657: next if ($fname eq ''); 8658: 8659: # Check if file already exists as a file or directory. 8660: my ($state,$msg); 8661: if ($context eq 'portfolio') { 8662: my $port_path = $dirpath; 8663: if ($group ne '') { 8664: $port_path = "groups/$group/$port_path"; 8665: } 8666: ($state,$msg) = &check_for_upload($env{'form.currentpath'}.$path, 8667: $fname,$group,'embedded_item_'.$i, 8668: $dir_root,$port_path,$disk_quota, 8669: $current_disk_usage,$uname,$udom); 8670: if ($state eq 'will_exceed_quota' 8671: || $state eq 'file_locked') { 8672: $output .= $msg; 8673: next; 8674: } 8675: } elsif (($context eq 'author') || ($context eq 'testbank')) { 8676: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i); 8677: if ($state eq 'exists') { 8678: $output .= $msg; 8679: next; 8680: } 8681: } 8682: # Check if extension is valid 8683: if (($fname =~ /\.(\w+)$/) && 8684: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) { 8685: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1).'<br />'; 8686: next; 8687: } elsif (($fname =~ /\.(\w+)$/) && 8688: (!defined(&Apache::loncommon::fileembstyle($1)))) { 8689: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1).'<br />'; 8690: next; 8691: } elsif ($fname=~/\.(\d+)\.(\w+)$/) { 8692: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2).'<br />'; 8693: next; 8694: } 8695: 8696: $env{'form.embedded_item_'.$i.'.filename'}=$fname; 8697: if ($context eq 'portfolio') { 8698: my $result; 8699: if ($state eq 'existingfile') { 8700: $result= 8701: &Apache::lonnet::userfileupload('embedded_item_'.$i,'existingfile', 8702: $dirpath.$env{'form.currentpath'}.$path); 8703: } else { 8704: $result= 8705: &Apache::lonnet::userfileupload('embedded_item_'.$i,'', 8706: $dirpath. 8707: $env{'form.currentpath'}.$path); 8708: if ($result !~ m|^/uploaded/|) { 8709: $output .= '<span class="LC_error">' 8710: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].' 8711: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}) 8712: .'</span><br />'; 8713: next; 8714: } else { 8715: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'. 8716: $path.$fname.'</span>').'<br />'; 8717: } 8718: } 8719: } elsif ($context eq 'coursedoc') { 8720: my $result = 8721: &Apache::lonnet::userfileupload('embedded_item_'.$i,'coursedoc', 8722: $dirpath.'/'.$path); 8723: if ($result !~ m|^/uploaded/|) { 8724: $output .= '<span class="LC_error">' 8725: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].' 8726: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}) 8727: .'</span><br />'; 8728: next; 8729: } else { 8730: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'. 8731: $path.$fname.'</span>').'<br />'; 8732: } 8733: } else { 8734: # Save the file 8735: my $target = $env{'form.embedded_item_'.$i}; 8736: my $fullpath = $dir_root.$dirpath.'/'.$path; 8737: my $dest = $fullpath.$fname; 8738: my $url = $url_root.$dirpath.'/'.$path.$fname; 8739: my @parts=split(/\//,$fullpath); 8740: my $count; 8741: my $filepath = $dir_root; 8742: for ($count=4;$count<=$#parts;$count++) { 8743: $filepath .= "/$parts[$count]"; 8744: if ((-e $filepath)!=1) { 8745: mkdir($filepath,0770); 8746: } 8747: } 8748: my $fh; 8749: if (!open($fh,'>'.$dest)) { 8750: &Apache::lonnet::logthis('Failed to create '.$dest); 8751: $output .= '<span class="LC_error">'. 8752: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}). 8753: '</span><br />'; 8754: } else { 8755: if (!print $fh $env{'form.embedded_item_'.$i}) { 8756: &Apache::lonnet::logthis('Failed to write to '.$dest); 8757: $output .= '<span class="LC_error">'. 8758: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}). 8759: '</span><br />'; 8760: } else { 8761: $output .= &mt('Uploaded [_1]','<span class="LC_filename">'. 8762: $url.'</span>').'<br />'; 8763: unless ($context eq 'testbank') { 8764: $footer .= &mt('View embedded file: [_1]', 8765: '<a href="'.$url.'">'.$fname.'</a>').'<br />'; 8766: } 8767: } 8768: close($fh); 8769: } 8770: } 8771: if ($env{'form.embedded_ref_'.$i}) { 8772: $pathchange{$i} = 1; 8773: } 8774: } 8775: if ($output) { 8776: $output = '<p>'.$output.'</p>'; 8777: } 8778: $output .= &modify_html_form('upload_embedded',$actionurl,$hiddenstate,\%pathchange); 8779: $returnflag = 'ok'; 8780: if (keys(%pathchange) > 0) { 8781: if ($context eq 'portfolio') { 8782: $output .= '<p>'.&mt('or').'</p>'; 8783: } elsif ($context eq 'testbank') { 8784: $output .= '<p>'.&mt('Or [_1]continue[_2] the testbank import without modifying the reference(s).','<a href="javascript:document.testbankForm.submit();">','</a>').'</p>'; 8785: $returnflag = 'modify_orightml'; 8786: } 8787: } 8788: return ($output.$footer,$returnflag); 8789: } 8790: 8791: sub modify_html_form { 8792: my ($context,$actionurl,$hiddenstate,$pathchange,$pathchgtable) = @_; 8793: my $end = 0; 8794: my $modifyform; 8795: if ($context eq 'upload_embedded') { 8796: return unless (ref($pathchange) eq 'HASH'); 8797: if ($env{'form.number_embedded_items'}) { 8798: $end += $env{'form.number_embedded_items'}; 8799: } 8800: if ($env{'form.number_pathchange_items'}) { 8801: $end += $env{'form.number_pathchange_items'}; 8802: } 8803: if ($end) { 8804: for (my $i=0; $i<$end; $i++) { 8805: if ($i < $env{'form.number_embedded_items'}) { 8806: next unless($pathchange->{$i}); 8807: } 8808: $modifyform .= 8809: &start_data_table_row(). 8810: '<td><input type ="checkbox" name="namechange" value="'.$i.'" '. 8811: 'checked="checked" /></td>'. 8812: '<td>'.$env{'form.embedded_ref_'.$i}. 8813: '<input type="hidden" name="embedded_ref_'.$i.'" value="'. 8814: &escape($env{'form.embedded_ref_'.$i}).'" />'. 8815: '<input type="hidden" name="embedded_codebase_'.$i.'" value="'. 8816: &escape($env{'form.embedded_codebase_'.$i}).'" />'. 8817: '<input type="hidden" name="embedded_attrib_'.$i.'" value="'. 8818: &escape($env{'form.embedded_attrib_'.$i}).'" /></td>'. 8819: '<td>'.$env{'form.embedded_orig_'.$i}. 8820: '<input type="hidden" name="embedded_orig_'.$i.'" value="'. 8821: &escape($env{'form.embedded_orig_'.$i}).'" /></td>'. 8822: &end_data_table_row(); 8823: } 8824: } 8825: } else { 8826: $modifyform = $pathchgtable; 8827: if (($actionurl eq '/adm/upload') || ($actionurl eq '/adm/testbank')) { 8828: $hiddenstate .= '<input type="hidden" name="phase" value="four" />'; 8829: } elsif (($actionurl eq '/adm/portfolio') || ($actionurl eq '/adm/coursegrp_portfolio')) { 8830: $hiddenstate .= '<input type="hidden" name="action" value="modify_orightml" />'; 8831: } 8832: } 8833: if ($modifyform) { 8834: return '<h3>'.&mt('Changes in content of HTML file required').'</h3>'."\n". 8835: '<p>'.&mt('Changes need to be made to the reference(s) used for one or more of the dependencies, if your HTML file is to work correctly:').'<ol>'."\n". 8836: '<li>'.&mt('For consistency between the reference(s) and the location of the corresponding stored file within LON-CAPA.').'</li>'."\n". 8837: '<li>'.&mt('To change absolute paths to relative paths, or replace directory traversal via "../" within the original reference.').'</li>'."\n". 8838: '</ol></p>'."\n".'<p>'. 8839: &mt('LON-CAPA can make the required changes to your HTML file.').'</p>'."\n". 8840: '<form method="post" name="refchanger" action="'.$actionurl.'">'. 8841: &start_data_table()."\n". 8842: &start_data_table_header_row(). 8843: '<th>'.&mt('Change?').'</th>'. 8844: '<th>'.&mt('Current reference').'</th>'. 8845: '<th>'.&mt('Required reference').'</th>'. 8846: &end_data_table_header_row()."\n". 8847: $modifyform. 8848: &end_data_table().'<br />'."\n".$hiddenstate. 8849: '<input type="submit" name="pathchanges" value="'.&mt('Modify HTML file').'" />'. 8850: '</form>'."\n"; 8851: } 8852: return; 8853: } 8854: 8855: sub modify_html_refs { 8856: my ($context,$dirpath,$uname,$udom,$dir_root) = @_; 8857: my $container; 8858: if ($context eq 'portfolio') { 8859: $container = $env{'form.container'}; 8860: } elsif ($context eq 'coursedoc') { 8861: $container = $env{'form.primaryurl'}; 8862: } else { 8863: $container = $env{'form.filename'}; 8864: $container =~ s{^/priv/(\Q$uname\E)/(.*)}{/home/$1/public_html/$2}; 8865: } 8866: my (%allfiles,%codebase,$output,$content); 8867: my @changes = &get_env_multiple('form.namechange'); 8868: return unless (@changes > 0); 8869: if (($context eq 'portfolio') || ($context eq 'coursedoc')) { 8870: return unless ($container =~ m{^/uploaded/\Q$udom\E/\Q$uname\E/}); 8871: $content = &Apache::lonnet::getfile($container); 8872: return if ($content eq '-1'); 8873: } else { 8874: return unless ($container =~ /^\Q$dir_root\E/); 8875: if (open(my $fh,"<$container")) { 8876: $content = join('', <$fh>); 8877: close($fh); 8878: } else { 8879: return; 8880: } 8881: } 8882: my ($count,$codebasecount) = (0,0); 8883: my $mm = new File::MMagic; 8884: my $mime_type = $mm->checktype_contents($content); 8885: if ($mime_type eq 'text/html') { 8886: my $parse_result = 8887: &Apache::lonnet::extract_embedded_items($container,\%allfiles, 8888: \%codebase,\$content); 8889: if ($parse_result eq 'ok') { 8890: foreach my $i (@changes) { 8891: my $orig = &unescape($env{'form.embedded_orig_'.$i}); 8892: my $ref = &unescape($env{'form.embedded_ref_'.$i}); 8893: if ($allfiles{$ref}) { 8894: my $newname = $orig; 8895: my ($attrib_regexp,$codebase); 8896: my $attrib_regexp = &unescape($env{'form.embedded_attrib_'.$i}); 8897: if ($attrib_regexp =~ /:/) { 8898: $attrib_regexp =~ s/\:/|/g; 8899: } 8900: if ($content =~ m{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}) { 8901: my $numchg = ($content =~ s{($attrib_regexp\s*=\s*['"]?)\Q$ref\E(['"]?)}{$1$newname$2}gi); 8902: $count += $numchg; 8903: } 8904: if ($env{'form.embedded_codebase_'.$i} ne '') { 8905: my $codebase = &unescape($env{'form.embedded_codebase_'.$i}); 8906: my $numchg = ($content =~ s/(codebase\s*=\s*["']?)\Q$codebase\E(["']?)/$1.$2/i); #' stupid emacs 8907: $codebasecount ++; 8908: } 8909: } 8910: } 8911: if ($count || $codebasecount) { 8912: my $saveresult; 8913: if ($context eq 'portfolio' || $context eq 'coursedoc') { 8914: my $url = &Apache::lonnet::store_edited_file($container,$content,$udom,$uname,\$saveresult); 8915: if ($url eq $container) { 8916: my ($fname) = ($container =~ m{/([^/]+)$}); 8917: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].', 8918: $count,'<span class="LC_filename">'. 8919: $fname.'</span>').'</p>'; 8920: } else { 8921: $output = '<p class="LC_error">'. 8922: &mt('Error: update failed for: [_1].', 8923: '<span class="LC_filename">'. 8924: $container.'</span>').'</p>'; 8925: } 8926: } else { 8927: if (open(my $fh,">$container")) { 8928: print $fh $content; 8929: close($fh); 8930: $output = '<p>'.&mt('Updated [quant,_1,reference] in [_2].', 8931: $count,'<span class="LC_filename">'. 8932: $container.'</span>').'</p>'; 8933: } else { 8934: $output = '<p class="LC_error">'. 8935: &mt('Error: could not update [_1].', 8936: '<span class="LC_filename">'. 8937: $container.'</span>').'</p>'; 8938: } 8939: } 8940: } 8941: } else { 8942: &logthis('Failed to parse '.$container. 8943: ' to modify references: '.$parse_result); 8944: } 8945: } 8946: return $output; 8947: } 8948: 8949: sub check_for_existing { 8950: my ($path,$fname,$element) = @_; 8951: my ($state,$msg); 8952: if (-d $path.'/'.$fname) { 8953: $state = 'exists'; 8954: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path); 8955: } elsif (-e $path.'/'.$fname) { 8956: $state = 'exists'; 8957: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path); 8958: } 8959: if ($state eq 'exists') { 8960: $msg = '<span class="LC_error">'.$msg.'</span><br />'; 8961: } 8962: return ($state,$msg); 8963: } 8964: 8965: sub check_for_upload { 8966: my ($path,$fname,$group,$element,$portfolio_root,$port_path, 8967: $disk_quota,$current_disk_usage,$uname,$udom) = @_; 8968: my $filesize = length($env{'form.'.$element}); 8969: if (!$filesize) { 8970: my $msg = '<span class="LC_error">'. 8971: &mt('Unable to upload [_1]. (size = [_2] bytes)', 8972: '<span class="LC_filename">'.$fname.'</span>', 8973: $filesize).'<br />'. 8974: &mt('Either the file you attempted to upload was empty, or your web browser was unable to read its contents.').'<br />'; 8975: '</span>'; 8976: return ('zero_bytes',$msg); 8977: } 8978: $filesize = $filesize/1000; #express in k (1024?) 8979: my $getpropath = 1; 8980: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname, 8981: $getpropath); 8982: my $found_file = 0; 8983: my $locked_file = 0; 8984: my @lockers; 8985: my $navmap; 8986: if ($env{'request.course.id'}) { 8987: $navmap = Apache::lonnavmaps::navmap->new(); 8988: } 8989: foreach my $line (@dir_list) { 8990: my ($file_name,$rest)=split(/\&/,$line,2); 8991: if ($file_name eq $fname){ 8992: $file_name = $path.$file_name; 8993: if ($group ne '') { 8994: $file_name = $group.$file_name; 8995: } 8996: $found_file = 1; 8997: if (&Apache::lonnet::is_locked($file_name,$udom,$uname,\@lockers) eq 'true') { 8998: foreach my $lock (@lockers) { 8999: if (ref($lock) eq 'ARRAY') { 9000: my ($symb,$crsid) = @{$lock}; 9001: if ($crsid eq $env{'request.course.id'}) { 9002: if (ref($navmap)) { 9003: my $res = $navmap->getBySymb($symb); 9004: foreach my $part (@{$res->parts()}) { 9005: my ($slot_status,$slot_time,$slot_name)=$res->check_for_slot($part); 9006: unless (($slot_status == $res->RESERVED) || 9007: ($slot_status == $res->RESERVED_LOCATION)) { 9008: $locked_file = 1; 9009: } 9010: } 9011: } else { 9012: $locked_file = 1; 9013: } 9014: } else { 9015: $locked_file = 1; 9016: } 9017: } 9018: } 9019: } else { 9020: my @info = split(/\&/,$rest); 9021: my $currsize = $info[6]/1000; 9022: if ($currsize < $filesize) { 9023: my $extra = $filesize - $currsize; 9024: if (($current_disk_usage + $extra) > $disk_quota) { 9025: my $msg = '<span class="LC_error">'. 9026: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded if existing (smaller) file with same name (size = [_3] kilobytes) is replaced.', 9027: '<span class="LC_filename">'.$fname.'</span>',$filesize,$currsize).'</span>'. 9028: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.', 9029: $disk_quota,$current_disk_usage); 9030: return ('will_exceed_quota',$msg); 9031: } 9032: } 9033: } 9034: } 9035: } 9036: if (($current_disk_usage + $filesize) > $disk_quota){ 9037: my $msg = '<span class="LC_error">'. 9038: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'. 9039: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage); 9040: return ('will_exceed_quota',$msg); 9041: } elsif ($found_file) { 9042: if ($locked_file) { 9043: my $msg = '<span class="LC_error">'; 9044: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>'); 9045: $msg .= '</span><br />'; 9046: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>'); 9047: return ('file_locked',$msg); 9048: } else { 9049: my $msg = '<span class="LC_error">'; 9050: $msg .= &mt(' A file by that name: [_1] was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'}); 9051: $msg .= '</span>'; 9052: return ('existingfile',$msg); 9053: } 9054: } 9055: } 9056: 9057: sub check_for_traversal { 9058: my ($path,$url,$toplevel) = @_; 9059: my @parts=split(/\//,$path); 9060: my $cleanpath; 9061: my $fullpath = $url; 9062: for (my $i=0;$i<@parts;$i++) { 9063: next if ($parts[$i] eq '.'); 9064: if ($parts[$i] eq '..') { 9065: $fullpath =~ s{([^/]+/)$}{}; 9066: } else { 9067: $fullpath .= $parts[$i].'/'; 9068: } 9069: } 9070: if ($fullpath =~ /^\Q$url\E(.*)$/) { 9071: $cleanpath = $1; 9072: } elsif ($fullpath =~ /^\Q$toplevel\E(.*)$/) { 9073: my $curr_toprel = $1; 9074: my @parts = split(/\//,$curr_toprel); 9075: my ($url_toprel) = ($url =~ /^\Q$toplevel\E(.*)$/); 9076: my @urlparts = split(/\//,$url_toprel); 9077: my $doubledots; 9078: my $startdiff = -1; 9079: for (my $i=0; $i<@urlparts; $i++) { 9080: if ($startdiff == -1) { 9081: unless ($urlparts[$i] eq $parts[$i]) { 9082: $startdiff = $i; 9083: $doubledots .= '../'; 9084: } 9085: } else { 9086: $doubledots .= '../'; 9087: } 9088: } 9089: if ($startdiff > -1) { 9090: $cleanpath = $doubledots; 9091: for (my $i=$startdiff; $i<@parts; $i++) { 9092: $cleanpath .= $parts[$i].'/'; 9093: } 9094: } 9095: } 9096: $cleanpath =~ s{(/)$}{}; 9097: return $cleanpath; 9098: } 9099: 9100: =pod 9101: 9102: =back 9103: 9104: =head1 CSV Upload/Handling functions 9105: 9106: =over 4 9107: 9108: =item * &upfile_store($r) 9109: 9110: Store uploaded file, $r should be the HTTP Request object, 9111: needs $env{'form.upfile'} 9112: returns $datatoken to be put into hidden field 9113: 9114: =cut 9115: 9116: sub upfile_store { 9117: my $r=shift; 9118: $env{'form.upfile'}=~s/\r/\n/gs; 9119: $env{'form.upfile'}=~s/\f/\n/gs; 9120: $env{'form.upfile'}=~s/\n+/\n/gs; 9121: $env{'form.upfile'}=~s/\n+$//gs; 9122: 9123: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}. 9124: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$; 9125: { 9126: my $datafile = $r->dir_config('lonDaemons'). 9127: '/tmp/'.$datatoken.'.tmp'; 9128: if ( open(my $fh,">$datafile") ) { 9129: print $fh $env{'form.upfile'}; 9130: close($fh); 9131: } 9132: } 9133: return $datatoken; 9134: } 9135: 9136: =pod 9137: 9138: =item * &load_tmp_file($r) 9139: 9140: Load uploaded file from tmp, $r should be the HTTP Request object, 9141: needs $env{'form.datatoken'}, 9142: sets $env{'form.upfile'} to the contents of the file 9143: 9144: =cut 9145: 9146: sub load_tmp_file { 9147: my $r=shift; 9148: my @studentdata=(); 9149: { 9150: my $studentfile = $r->dir_config('lonDaemons'). 9151: '/tmp/'.$env{'form.datatoken'}.'.tmp'; 9152: if ( open(my $fh,"<$studentfile") ) { 9153: @studentdata=<$fh>; 9154: close($fh); 9155: } 9156: } 9157: $env{'form.upfile'}=join('',@studentdata); 9158: } 9159: 9160: =pod 9161: 9162: =item * &upfile_record_sep() 9163: 9164: Separate uploaded file into records 9165: returns array of records, 9166: needs $env{'form.upfile'} and $env{'form.upfiletype'} 9167: 9168: =cut 9169: 9170: sub upfile_record_sep { 9171: if ($env{'form.upfiletype'} eq 'xml') { 9172: } else { 9173: my @records; 9174: foreach my $line (split(/\n/,$env{'form.upfile'})) { 9175: if ($line=~/^\s*$/) { next; } 9176: push(@records,$line); 9177: } 9178: return @records; 9179: } 9180: } 9181: 9182: =pod 9183: 9184: =item * &record_sep($record) 9185: 9186: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'} 9187: 9188: =cut 9189: 9190: sub takeleft { 9191: my $index=shift; 9192: return substr('0000'.$index,-4,4); 9193: } 9194: 9195: sub record_sep { 9196: my $record=shift; 9197: my %components=(); 9198: if ($env{'form.upfiletype'} eq 'xml') { 9199: } elsif ($env{'form.upfiletype'} eq 'space') { 9200: my $i=0; 9201: foreach my $field (split(/\s+/,$record)) { 9202: $field=~s/^(\"|\')//; 9203: $field=~s/(\"|\')$//; 9204: $components{&takeleft($i)}=$field; 9205: $i++; 9206: } 9207: } elsif ($env{'form.upfiletype'} eq 'tab') { 9208: my $i=0; 9209: foreach my $field (split(/\t/,$record)) { 9210: $field=~s/^(\"|\')//; 9211: $field=~s/(\"|\')$//; 9212: $components{&takeleft($i)}=$field; 9213: $i++; 9214: } 9215: } else { 9216: my $separator=','; 9217: if ($env{'form.upfiletype'} eq 'semisv') { 9218: $separator=';'; 9219: } 9220: my $i=0; 9221: # the character we are looking for to indicate the end of a quote or a record 9222: my $looking_for=$separator; 9223: # do not add the characters to the fields 9224: my $ignore=0; 9225: # we just encountered a separator (or the beginning of the record) 9226: my $just_found_separator=1; 9227: # store the field we are working on here 9228: my $field=''; 9229: # work our way through all characters in record 9230: foreach my $character ($record=~/(.)/g) { 9231: if ($character eq $looking_for) { 9232: if ($character ne $separator) { 9233: # Found the end of a quote, again looking for separator 9234: $looking_for=$separator; 9235: $ignore=1; 9236: } else { 9237: # Found a separator, store away what we got 9238: $components{&takeleft($i)}=$field; 9239: $i++; 9240: $just_found_separator=1; 9241: $ignore=0; 9242: $field=''; 9243: } 9244: next; 9245: } 9246: # single or double quotation marks after a separator indicate beginning of a quote 9247: # we are now looking for the end of the quote and need to ignore separators 9248: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) { 9249: $looking_for=$character; 9250: next; 9251: } 9252: # ignore would be true after we reached the end of a quote 9253: if ($ignore) { next; } 9254: if (($just_found_separator) && ($character=~/\s/)) { next; } 9255: $field.=$character; 9256: $just_found_separator=0; 9257: } 9258: # catch the very last entry, since we never encountered the separator 9259: $components{&takeleft($i)}=$field; 9260: } 9261: return %components; 9262: } 9263: 9264: ###################################################### 9265: ###################################################### 9266: 9267: =pod 9268: 9269: =item * &upfile_select_html() 9270: 9271: Return HTML code to select a file from the users machine and specify 9272: the file type. 9273: 9274: =cut 9275: 9276: ###################################################### 9277: ###################################################### 9278: sub upfile_select_html { 9279: my %Types = ( 9280: csv => &mt('CSV (comma separated values, spreadsheet)'), 9281: semisv => &mt('Semicolon separated values'), 9282: space => &mt('Space separated'), 9283: tab => &mt('Tabulator separated'), 9284: # xml => &mt('HTML/XML'), 9285: ); 9286: my $Str = '<input type="file" name="upfile" size="50" />'. 9287: '<br />'.&mt('Type').': <select name="upfiletype">'; 9288: foreach my $type (sort(keys(%Types))) { 9289: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n"; 9290: } 9291: $Str .= "</select>\n"; 9292: return $Str; 9293: } 9294: 9295: sub get_samples { 9296: my ($records,$toget) = @_; 9297: my @samples=({}); 9298: my $got=0; 9299: foreach my $rec (@$records) { 9300: my %temp = &record_sep($rec); 9301: if (! grep(/\S/, values(%temp))) { next; } 9302: if (%temp) { 9303: $samples[$got]=\%temp; 9304: $got++; 9305: if ($got == $toget) { last; } 9306: } 9307: } 9308: return \@samples; 9309: } 9310: 9311: ###################################################### 9312: ###################################################### 9313: 9314: =pod 9315: 9316: =item * &csv_print_samples($r,$records) 9317: 9318: Prints a table of sample values from each column uploaded $r is an 9319: Apache Request ref, $records is an arrayref from 9320: &Apache::loncommon::upfile_record_sep 9321: 9322: =cut 9323: 9324: ###################################################### 9325: ###################################################### 9326: sub csv_print_samples { 9327: my ($r,$records) = @_; 9328: my $samples = &get_samples($records,5); 9329: 9330: $r->print(&mt('Samples').'<br />'.&start_data_table(). 9331: &start_data_table_header_row()); 9332: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 9333: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); } 9334: $r->print(&end_data_table_header_row()); 9335: foreach my $hash (@$samples) { 9336: $r->print(&start_data_table_row()); 9337: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 9338: $r->print('<td>'); 9339: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); } 9340: $r->print('</td>'); 9341: } 9342: $r->print(&end_data_table_row()); 9343: } 9344: $r->print(&end_data_table().'<br />'."\n"); 9345: } 9346: 9347: ###################################################### 9348: ###################################################### 9349: 9350: =pod 9351: 9352: =item * &csv_print_select_table($r,$records,$d) 9353: 9354: Prints a table to create associations between values and table columns. 9355: 9356: $r is an Apache Request ref, 9357: $records is an arrayref from &Apache::loncommon::upfile_record_sep, 9358: $d is an array of 2 element arrays (internal name, displayed name,defaultcol) 9359: 9360: =cut 9361: 9362: ###################################################### 9363: ###################################################### 9364: sub csv_print_select_table { 9365: my ($r,$records,$d) = @_; 9366: my $i=0; 9367: my $samples = &get_samples($records,1); 9368: $r->print(&mt('Associate columns with student attributes.')."\n". 9369: &start_data_table().&start_data_table_header_row(). 9370: '<th>'.&mt('Attribute').'</th>'. 9371: '<th>'.&mt('Column').'</th>'. 9372: &end_data_table_header_row()."\n"); 9373: foreach my $array_ref (@$d) { 9374: my ($value,$display,$defaultcol)=@{ $array_ref }; 9375: $r->print(&start_data_table_row().'<td>'.$display.'</td>'); 9376: 9377: $r->print('<td><select name="f'.$i.'"'. 9378: ' onchange="javascript:flip(this.form,'.$i.');">'); 9379: $r->print('<option value="none"></option>'); 9380: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 9381: $r->print('<option value="'.$sample.'"'. 9382: ($sample eq $defaultcol ? ' selected="selected" ' : ''). 9383: '>'.&mt('Column [_1]',($sample+1)).'</option>'); 9384: } 9385: $r->print('</select></td>'.&end_data_table_row()."\n"); 9386: $i++; 9387: } 9388: $r->print(&end_data_table()); 9389: $i--; 9390: return $i; 9391: } 9392: 9393: ###################################################### 9394: ###################################################### 9395: 9396: =pod 9397: 9398: =item * &csv_samples_select_table($r,$records,$d) 9399: 9400: Prints a table of sample values from the upload and can make associate samples to internal names. 9401: 9402: $r is an Apache Request ref, 9403: $records is an arrayref from &Apache::loncommon::upfile_record_sep, 9404: $d is an array of 2 element arrays (internal name, displayed name) 9405: 9406: =cut 9407: 9408: ###################################################### 9409: ###################################################### 9410: sub csv_samples_select_table { 9411: my ($r,$records,$d) = @_; 9412: my $i=0; 9413: # 9414: my $max_samples = 5; 9415: my $samples = &get_samples($records,$max_samples); 9416: $r->print(&start_data_table(). 9417: &start_data_table_header_row().'<th>'. 9418: &mt('Field').'</th><th>'.&mt('Samples').'</th>'. 9419: &end_data_table_header_row()); 9420: 9421: foreach my $key (sort(keys(%{ $samples->[0] }))) { 9422: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'. 9423: ' onchange="javascript:flip(this.form,'.$i.');">'); 9424: foreach my $option (@$d) { 9425: my ($value,$display,$defaultcol)=@{ $option }; 9426: $r->print('<option value="'.$value.'"'. 9427: ($i eq $defaultcol ? ' selected="selected" ':'').'>'. 9428: $display.'</option>'); 9429: } 9430: $r->print('</select></td><td>'); 9431: foreach my $line (0..($max_samples-1)) { 9432: if (defined($samples->[$line]{$key})) { 9433: $r->print($samples->[$line]{$key}."<br />\n"); 9434: } 9435: } 9436: $r->print('</td>'.&end_data_table_row()); 9437: $i++; 9438: } 9439: $r->print(&end_data_table()); 9440: $i--; 9441: return($i); 9442: } 9443: 9444: ###################################################### 9445: ###################################################### 9446: 9447: =pod 9448: 9449: =item * &clean_excel_name($name) 9450: 9451: Returns a replacement for $name which does not contain any illegal characters. 9452: 9453: =cut 9454: 9455: ###################################################### 9456: ###################################################### 9457: sub clean_excel_name { 9458: my ($name) = @_; 9459: $name =~ s/[:\*\?\/\\]//g; 9460: if (length($name) > 31) { 9461: $name = substr($name,0,31); 9462: } 9463: return $name; 9464: } 9465: 9466: =pod 9467: 9468: =item * &check_if_partid_hidden($id,$symb,$udom,$uname) 9469: 9470: Returns either 1 or undef 9471: 9472: 1 if the part is to be hidden, undef if it is to be shown 9473: 9474: Arguments are: 9475: 9476: $id the id of the part to be checked 9477: $symb, optional the symb of the resource to check 9478: $udom, optional the domain of the user to check for 9479: $uname, optional the username of the user to check for 9480: 9481: =cut 9482: 9483: sub check_if_partid_hidden { 9484: my ($id,$symb,$udom,$uname) = @_; 9485: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts', 9486: $symb,$udom,$uname); 9487: my $truth=1; 9488: #if the string starts with !, then the list is the list to show not hide 9489: if ($hiddenparts=~s/^\s*!//) { $truth=undef; } 9490: my @hiddenlist=split(/,/,$hiddenparts); 9491: foreach my $checkid (@hiddenlist) { 9492: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; } 9493: } 9494: return !$truth; 9495: } 9496: 9497: 9498: ############################################################ 9499: ############################################################ 9500: 9501: =pod 9502: 9503: =back 9504: 9505: =head1 cgi-bin script and graphing routines 9506: 9507: =over 4 9508: 9509: =item * &get_cgi_id() 9510: 9511: Inputs: none 9512: 9513: Returns an id which can be used to pass environment variables 9514: to various cgi-bin scripts. These environment variables will 9515: be removed from the users environment after a given time by 9516: the routine &Apache::lonnet::transfer_profile_to_env. 9517: 9518: =cut 9519: 9520: ############################################################ 9521: ############################################################ 9522: my $uniq=0; 9523: sub get_cgi_id { 9524: $uniq=($uniq+1)%100000; 9525: return (time.'_'.$$.'_'.$uniq); 9526: } 9527: 9528: ############################################################ 9529: ############################################################ 9530: 9531: =pod 9532: 9533: =item * &DrawBarGraph() 9534: 9535: Facilitates the plotting of data in a (stacked) bar graph. 9536: Puts plot definition data into the users environment in order for 9537: graph.png to plot it. Returns an <img> tag for the plot. 9538: The bars on the plot are labeled '1','2',...,'n'. 9539: 9540: Inputs: 9541: 9542: =over 4 9543: 9544: =item $Title: string, the title of the plot 9545: 9546: =item $xlabel: string, text describing the X-axis of the plot 9547: 9548: =item $ylabel: string, text describing the Y-axis of the plot 9549: 9550: =item $Max: scalar, the maximum Y value to use in the plot 9551: If $Max is < any data point, the graph will not be rendered. 9552: 9553: =item $colors: array ref holding the colors to be used for the data sets when 9554: they are plotted. If undefined, default values will be used. 9555: 9556: =item $labels: array ref holding the labels to use on the x-axis for the bars. 9557: 9558: =item @Values: An array of array references. Each array reference holds data 9559: to be plotted in a stacked bar chart. 9560: 9561: =item If the final element of @Values is a hash reference the key/value 9562: pairs will be added to the graph definition. 9563: 9564: =back 9565: 9566: Returns: 9567: 9568: An <img> tag which references graph.png and the appropriate identifying 9569: information for the plot. 9570: 9571: =cut 9572: 9573: ############################################################ 9574: ############################################################ 9575: sub DrawBarGraph { 9576: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_; 9577: # 9578: if (! defined($colors)) { 9579: $colors = ['#33ff00', 9580: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933', 9581: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66', 9582: ]; 9583: } 9584: my $extra_settings = {}; 9585: if (ref($Values[-1]) eq 'HASH') { 9586: $extra_settings = pop(@Values); 9587: } 9588: # 9589: my $identifier = &get_cgi_id(); 9590: my $id = 'cgi.'.$identifier; 9591: if (! @Values || ref($Values[0]) ne 'ARRAY') { 9592: return ''; 9593: } 9594: # 9595: my @Labels; 9596: if (defined($labels)) { 9597: @Labels = @$labels; 9598: } else { 9599: for (my $i=0;$i<@{$Values[0]};$i++) { 9600: push (@Labels,$i+1); 9601: } 9602: } 9603: # 9604: my $NumBars = scalar(@{$Values[0]}); 9605: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); } 9606: my %ValuesHash; 9607: my $NumSets=1; 9608: foreach my $array (@Values) { 9609: next if (! ref($array)); 9610: $ValuesHash{$id.'.data.'.$NumSets++} = 9611: join(',',@$array); 9612: } 9613: # 9614: my ($height,$width,$xskip,$bar_width) = (200,120,1,15); 9615: if ($NumBars < 3) { 9616: $width = 120+$NumBars*32; 9617: $xskip = 1; 9618: $bar_width = 30; 9619: } elsif ($NumBars < 5) { 9620: $width = 120+$NumBars*20; 9621: $xskip = 1; 9622: $bar_width = 20; 9623: } elsif ($NumBars < 10) { 9624: $width = 120+$NumBars*15; 9625: $xskip = 1; 9626: $bar_width = 15; 9627: } elsif ($NumBars <= 25) { 9628: $width = 120+$NumBars*11; 9629: $xskip = 5; 9630: $bar_width = 8; 9631: } elsif ($NumBars <= 50) { 9632: $width = 120+$NumBars*8; 9633: $xskip = 5; 9634: $bar_width = 4; 9635: } else { 9636: $width = 120+$NumBars*8; 9637: $xskip = 5; 9638: $bar_width = 4; 9639: } 9640: # 9641: $Max = 1 if ($Max < 1); 9642: if ( int($Max) < $Max ) { 9643: $Max++; 9644: $Max = int($Max); 9645: } 9646: $Title = '' if (! defined($Title)); 9647: $xlabel = '' if (! defined($xlabel)); 9648: $ylabel = '' if (! defined($ylabel)); 9649: $ValuesHash{$id.'.title'} = &escape($Title); 9650: $ValuesHash{$id.'.xlabel'} = &escape($xlabel); 9651: $ValuesHash{$id.'.ylabel'} = &escape($ylabel); 9652: $ValuesHash{$id.'.y_max_value'} = $Max; 9653: $ValuesHash{$id.'.NumBars'} = $NumBars; 9654: $ValuesHash{$id.'.NumSets'} = $NumSets; 9655: $ValuesHash{$id.'.PlotType'} = 'bar'; 9656: $ValuesHash{$id.'.Colors'} = join(',',@{$colors}); 9657: $ValuesHash{$id.'.height'} = $height; 9658: $ValuesHash{$id.'.width'} = $width; 9659: $ValuesHash{$id.'.xskip'} = $xskip; 9660: $ValuesHash{$id.'.bar_width'} = $bar_width; 9661: $ValuesHash{$id.'.labels'} = join(',',@Labels); 9662: # 9663: # Deal with other parameters 9664: while (my ($key,$value) = each(%$extra_settings)) { 9665: $ValuesHash{$id.'.'.$key} = $value; 9666: } 9667: # 9668: &Apache::lonnet::appenv(\%ValuesHash); 9669: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />'; 9670: } 9671: 9672: ############################################################ 9673: ############################################################ 9674: 9675: =pod 9676: 9677: =item * &DrawXYGraph() 9678: 9679: Facilitates the plotting of data in an XY graph. 9680: Puts plot definition data into the users environment in order for 9681: graph.png to plot it. Returns an <img> tag for the plot. 9682: 9683: Inputs: 9684: 9685: =over 4 9686: 9687: =item $Title: string, the title of the plot 9688: 9689: =item $xlabel: string, text describing the X-axis of the plot 9690: 9691: =item $ylabel: string, text describing the Y-axis of the plot 9692: 9693: =item $Max: scalar, the maximum Y value to use in the plot 9694: If $Max is < any data point, the graph will not be rendered. 9695: 9696: =item $colors: Array ref containing the hex color codes for the data to be 9697: plotted in. If undefined, default values will be used. 9698: 9699: =item $Xlabels: Array ref containing the labels to be used for the X-axis. 9700: 9701: =item $Ydata: Array ref containing Array refs. 9702: Each of the contained arrays will be plotted as a separate curve. 9703: 9704: =item %Values: hash indicating or overriding any default values which are 9705: passed to graph.png. 9706: Possible values are: width, xskip, x_ticks, x_tick_offset, among others. 9707: 9708: =back 9709: 9710: Returns: 9711: 9712: An <img> tag which references graph.png and the appropriate identifying 9713: information for the plot. 9714: 9715: =cut 9716: 9717: ############################################################ 9718: ############################################################ 9719: sub DrawXYGraph { 9720: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_; 9721: # 9722: # Create the identifier for the graph 9723: my $identifier = &get_cgi_id(); 9724: my $id = 'cgi.'.$identifier; 9725: # 9726: $Title = '' if (! defined($Title)); 9727: $xlabel = '' if (! defined($xlabel)); 9728: $ylabel = '' if (! defined($ylabel)); 9729: my %ValuesHash = 9730: ( 9731: $id.'.title' => &escape($Title), 9732: $id.'.xlabel' => &escape($xlabel), 9733: $id.'.ylabel' => &escape($ylabel), 9734: $id.'.y_max_value'=> $Max, 9735: $id.'.labels' => join(',',@$Xlabels), 9736: $id.'.PlotType' => 'XY', 9737: ); 9738: # 9739: if (defined($colors) && ref($colors) eq 'ARRAY') { 9740: $ValuesHash{$id.'.Colors'} = join(',',@{$colors}); 9741: } 9742: # 9743: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') { 9744: return ''; 9745: } 9746: my $NumSets=1; 9747: foreach my $array (@{$Ydata}){ 9748: next if (! ref($array)); 9749: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array); 9750: } 9751: $ValuesHash{$id.'.NumSets'} = $NumSets-1; 9752: # 9753: # Deal with other parameters 9754: while (my ($key,$value) = each(%Values)) { 9755: $ValuesHash{$id.'.'.$key} = $value; 9756: } 9757: # 9758: &Apache::lonnet::appenv(\%ValuesHash); 9759: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />'; 9760: } 9761: 9762: ############################################################ 9763: ############################################################ 9764: 9765: =pod 9766: 9767: =item * &DrawXYYGraph() 9768: 9769: Facilitates the plotting of data in an XY graph with two Y axes. 9770: Puts plot definition data into the users environment in order for 9771: graph.png to plot it. Returns an <img> tag for the plot. 9772: 9773: Inputs: 9774: 9775: =over 4 9776: 9777: =item $Title: string, the title of the plot 9778: 9779: =item $xlabel: string, text describing the X-axis of the plot 9780: 9781: =item $ylabel: string, text describing the Y-axis of the plot 9782: 9783: =item $colors: Array ref containing the hex color codes for the data to be 9784: plotted in. If undefined, default values will be used. 9785: 9786: =item $Xlabels: Array ref containing the labels to be used for the X-axis. 9787: 9788: =item $Ydata1: The first data set 9789: 9790: =item $Min1: The minimum value of the left Y-axis 9791: 9792: =item $Max1: The maximum value of the left Y-axis 9793: 9794: =item $Ydata2: The second data set 9795: 9796: =item $Min2: The minimum value of the right Y-axis 9797: 9798: =item $Max2: The maximum value of the left Y-axis 9799: 9800: =item %Values: hash indicating or overriding any default values which are 9801: passed to graph.png. 9802: Possible values are: width, xskip, x_ticks, x_tick_offset, among others. 9803: 9804: =back 9805: 9806: Returns: 9807: 9808: An <img> tag which references graph.png and the appropriate identifying 9809: information for the plot. 9810: 9811: =cut 9812: 9813: ############################################################ 9814: ############################################################ 9815: sub DrawXYYGraph { 9816: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1, 9817: $Ydata2,$Min2,$Max2,%Values)=@_; 9818: # 9819: # Create the identifier for the graph 9820: my $identifier = &get_cgi_id(); 9821: my $id = 'cgi.'.$identifier; 9822: # 9823: $Title = '' if (! defined($Title)); 9824: $xlabel = '' if (! defined($xlabel)); 9825: $ylabel = '' if (! defined($ylabel)); 9826: my %ValuesHash = 9827: ( 9828: $id.'.title' => &escape($Title), 9829: $id.'.xlabel' => &escape($xlabel), 9830: $id.'.ylabel' => &escape($ylabel), 9831: $id.'.labels' => join(',',@$Xlabels), 9832: $id.'.PlotType' => 'XY', 9833: $id.'.NumSets' => 2, 9834: $id.'.two_axes' => 1, 9835: $id.'.y1_max_value' => $Max1, 9836: $id.'.y1_min_value' => $Min1, 9837: $id.'.y2_max_value' => $Max2, 9838: $id.'.y2_min_value' => $Min2, 9839: ); 9840: # 9841: if (defined($colors) && ref($colors) eq 'ARRAY') { 9842: $ValuesHash{$id.'.Colors'} = join(',',@{$colors}); 9843: } 9844: # 9845: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' || 9846: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){ 9847: return ''; 9848: } 9849: my $NumSets=1; 9850: foreach my $array ($Ydata1,$Ydata2){ 9851: next if (! ref($array)); 9852: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array); 9853: } 9854: # 9855: # Deal with other parameters 9856: while (my ($key,$value) = each(%Values)) { 9857: $ValuesHash{$id.'.'.$key} = $value; 9858: } 9859: # 9860: &Apache::lonnet::appenv(\%ValuesHash); 9861: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />'; 9862: } 9863: 9864: ############################################################ 9865: ############################################################ 9866: 9867: =pod 9868: 9869: =back 9870: 9871: =head1 Statistics helper routines? 9872: 9873: Bad place for them but what the hell. 9874: 9875: =over 4 9876: 9877: =item * &chartlink() 9878: 9879: Returns a link to the chart for a specific student. 9880: 9881: Inputs: 9882: 9883: =over 4 9884: 9885: =item $linktext: The text of the link 9886: 9887: =item $sname: The students username 9888: 9889: =item $sdomain: The students domain 9890: 9891: =back 9892: 9893: =back 9894: 9895: =cut 9896: 9897: ############################################################ 9898: ############################################################ 9899: sub chartlink { 9900: my ($linktext, $sname, $sdomain) = @_; 9901: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'. 9902: '&SelectedStudent='.&escape($sname.':'.$sdomain). 9903: '&chartoutputmode='.HTML::Entities::encode('html, with all links'). 9904: '">'.$linktext.'</a>'; 9905: } 9906: 9907: ####################################################### 9908: ####################################################### 9909: 9910: =pod 9911: 9912: =head1 Course Environment Routines 9913: 9914: =over 4 9915: 9916: =item * &restore_course_settings() 9917: 9918: =item * &store_course_settings() 9919: 9920: Restores/Store indicated form parameters from the course environment. 9921: Will not overwrite existing values of the form parameters. 9922: 9923: Inputs: 9924: a scalar describing the data (e.g. 'chart', 'problem_analysis') 9925: 9926: a hash ref describing the data to be stored. For example: 9927: 9928: %Save_Parameters = ('Status' => 'scalar', 9929: 'chartoutputmode' => 'scalar', 9930: 'chartoutputdata' => 'scalar', 9931: 'Section' => 'array', 9932: 'Group' => 'array', 9933: 'StudentData' => 'array', 9934: 'Maps' => 'array'); 9935: 9936: Returns: both routines return nothing 9937: 9938: =back 9939: 9940: =cut 9941: 9942: ####################################################### 9943: ####################################################### 9944: sub store_course_settings { 9945: return &store_settings($env{'request.course.id'},@_); 9946: } 9947: 9948: sub store_settings { 9949: # save to the environment 9950: # appenv the same items, just to be safe 9951: my $udom = $env{'user.domain'}; 9952: my $uname = $env{'user.name'}; 9953: my ($context,$prefix,$Settings) = @_; 9954: my %SaveHash; 9955: my %AppHash; 9956: while (my ($setting,$type) = each(%$Settings)) { 9957: my $basename = join('.','internal',$context,$prefix,$setting); 9958: my $envname = 'environment.'.$basename; 9959: if (exists($env{'form.'.$setting})) { 9960: # Save this value away 9961: if ($type eq 'scalar' && 9962: (! exists($env{$envname}) || 9963: $env{$envname} ne $env{'form.'.$setting})) { 9964: $SaveHash{$basename} = $env{'form.'.$setting}; 9965: $AppHash{$envname} = $env{'form.'.$setting}; 9966: } elsif ($type eq 'array') { 9967: my $stored_form; 9968: if (ref($env{'form.'.$setting})) { 9969: $stored_form = join(',', 9970: map { 9971: &escape($_); 9972: } sort(@{$env{'form.'.$setting}})); 9973: } else { 9974: $stored_form = 9975: &escape($env{'form.'.$setting}); 9976: } 9977: # Determine if the array contents are the same. 9978: if ($stored_form ne $env{$envname}) { 9979: $SaveHash{$basename} = $stored_form; 9980: $AppHash{$envname} = $stored_form; 9981: } 9982: } 9983: } 9984: } 9985: my $put_result = &Apache::lonnet::put('environment',\%SaveHash, 9986: $udom,$uname); 9987: if ($put_result !~ /^(ok|delayed)/) { 9988: &Apache::lonnet::logthis('unable to save form parameters, '. 9989: 'got error:'.$put_result); 9990: } 9991: # Make sure these settings stick around in this session, too 9992: &Apache::lonnet::appenv(\%AppHash); 9993: return; 9994: } 9995: 9996: sub restore_course_settings { 9997: return &restore_settings($env{'request.course.id'},@_); 9998: } 9999: 10000: sub restore_settings { 10001: my ($context,$prefix,$Settings) = @_; 10002: while (my ($setting,$type) = each(%$Settings)) { 10003: next if (exists($env{'form.'.$setting})); 10004: my $envname = 'environment.internal.'.$context.'.'.$prefix. 10005: '.'.$setting; 10006: if (exists($env{$envname})) { 10007: if ($type eq 'scalar') { 10008: $env{'form.'.$setting} = $env{$envname}; 10009: } elsif ($type eq 'array') { 10010: $env{'form.'.$setting} = [ 10011: map { 10012: &unescape($_); 10013: } split(',',$env{$envname}) 10014: ]; 10015: } 10016: } 10017: } 10018: } 10019: 10020: ####################################################### 10021: ####################################################### 10022: 10023: =pod 10024: 10025: =head1 Domain E-mail Routines 10026: 10027: =over 4 10028: 10029: =item * &build_recipient_list() 10030: 10031: Build recipient lists for five types of e-mail: 10032: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors 10033: (d) Help requests, (e) Course requests needing approval, generated by 10034: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and 10035: loncoursequeueadmin.pm respectively. 10036: 10037: Inputs: 10038: defmail (scalar - email address of default recipient), 10039: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 10040: defdom (domain for which to retrieve configuration settings), 10041: origmail (scalar - email address of recipient from loncapa.conf, 10042: i.e., predates configuration by DC via domainprefs.pm 10043: 10044: Returns: comma separated list of addresses to which to send e-mail. 10045: 10046: =back 10047: 10048: =cut 10049: 10050: ############################################################ 10051: ############################################################ 10052: sub build_recipient_list { 10053: my ($defmail,$mailing,$defdom,$origmail) = @_; 10054: my @recipients; 10055: my $otheremails; 10056: my %domconfig = 10057: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom); 10058: if (ref($domconfig{'contacts'}) eq 'HASH') { 10059: if (exists($domconfig{'contacts'}{$mailing})) { 10060: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') { 10061: my @contacts = ('adminemail','supportemail'); 10062: foreach my $item (@contacts) { 10063: if ($domconfig{'contacts'}{$mailing}{$item}) { 10064: my $addr = $domconfig{'contacts'}{$item}; 10065: if (!grep(/^\Q$addr\E$/,@recipients)) { 10066: push(@recipients,$addr); 10067: } 10068: } 10069: $otheremails = $domconfig{'contacts'}{$mailing}{'others'}; 10070: } 10071: } 10072: } elsif ($origmail ne '') { 10073: push(@recipients,$origmail); 10074: } 10075: } elsif ($origmail ne '') { 10076: push(@recipients,$origmail); 10077: } 10078: if (defined($defmail)) { 10079: if ($defmail ne '') { 10080: push(@recipients,$defmail); 10081: } 10082: } 10083: if ($otheremails) { 10084: my @others; 10085: if ($otheremails =~ /,/) { 10086: @others = split(/,/,$otheremails); 10087: } else { 10088: push(@others,$otheremails); 10089: } 10090: foreach my $addr (@others) { 10091: if (!grep(/^\Q$addr\E$/,@recipients)) { 10092: push(@recipients,$addr); 10093: } 10094: } 10095: } 10096: my $recipientlist = join(',',@recipients); 10097: return $recipientlist; 10098: } 10099: 10100: ############################################################ 10101: ############################################################ 10102: 10103: =pod 10104: 10105: =head1 Course Catalog Routines 10106: 10107: =over 4 10108: 10109: =item * &gather_categories() 10110: 10111: Converts category definitions - keys of categories hash stored in 10112: coursecategories in configuration.db on the primary library server in a 10113: domain - to an array. Also generates javascript and idx hash used to 10114: generate Domain Coordinator interface for editing Course Categories. 10115: 10116: Inputs: 10117: 10118: categories (reference to hash of category definitions). 10119: 10120: cats (reference to array of arrays/hashes which encapsulates hierarchy of 10121: categories and subcategories). 10122: 10123: idx (reference to hash of counters used in Domain Coordinator interface for 10124: editing Course Categories). 10125: 10126: jsarray (reference to array of categories used to create Javascript arrays for 10127: Domain Coordinator interface for editing Course Categories). 10128: 10129: Returns: nothing 10130: 10131: Side effects: populates cats, idx and jsarray. 10132: 10133: =cut 10134: 10135: sub gather_categories { 10136: my ($categories,$cats,$idx,$jsarray) = @_; 10137: my %counters; 10138: my $num = 0; 10139: foreach my $item (keys(%{$categories})) { 10140: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item); 10141: if ($container eq '' && $depth == 0) { 10142: $cats->[$depth][$categories->{$item}] = $cat; 10143: } else { 10144: $cats->[$depth]{$container}[$categories->{$item}] = $cat; 10145: } 10146: my ($escitem,$tail) = split(/:/,$item,2); 10147: if ($counters{$tail} eq '') { 10148: $counters{$tail} = $num; 10149: $num ++; 10150: } 10151: if (ref($idx) eq 'HASH') { 10152: $idx->{$item} = $counters{$tail}; 10153: } 10154: if (ref($jsarray) eq 'ARRAY') { 10155: push(@{$jsarray->[$counters{$tail}]},$item); 10156: } 10157: } 10158: return; 10159: } 10160: 10161: =pod 10162: 10163: =item * &extract_categories() 10164: 10165: Used to generate breadcrumb trails for course categories. 10166: 10167: Inputs: 10168: 10169: categories (reference to hash of category definitions). 10170: 10171: cats (reference to array of arrays/hashes which encapsulates hierarchy of 10172: categories and subcategories). 10173: 10174: trails (reference to array of breacrumb trails for each category). 10175: 10176: allitems (reference to hash - key is category key 10177: (format: escaped(name):escaped(parent category):depth in hierarchy). 10178: 10179: idx (reference to hash of counters used in Domain Coordinator interface for 10180: editing Course Categories). 10181: 10182: jsarray (reference to array of categories used to create Javascript arrays for 10183: Domain Coordinator interface for editing Course Categories). 10184: 10185: subcats (reference to hash of arrays containing all subcategories within each 10186: category, -recursive) 10187: 10188: Returns: nothing 10189: 10190: Side effects: populates trails and allitems hash references. 10191: 10192: =cut 10193: 10194: sub extract_categories { 10195: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_; 10196: if (ref($categories) eq 'HASH') { 10197: &gather_categories($categories,$cats,$idx,$jsarray); 10198: if (ref($cats->[0]) eq 'ARRAY') { 10199: for (my $i=0; $i<@{$cats->[0]}; $i++) { 10200: my $name = $cats->[0][$i]; 10201: my $item = &escape($name).'::0'; 10202: my $trailstr; 10203: if ($name eq 'instcode') { 10204: $trailstr = &mt('Official courses (with institutional codes)'); 10205: } elsif ($name eq 'communities') { 10206: $trailstr = &mt('Communities'); 10207: } else { 10208: $trailstr = $name; 10209: } 10210: if ($allitems->{$item} eq '') { 10211: push(@{$trails},$trailstr); 10212: $allitems->{$item} = scalar(@{$trails})-1; 10213: } 10214: my @parents = ($name); 10215: if (ref($cats->[1]{$name}) eq 'ARRAY') { 10216: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) { 10217: my $category = $cats->[1]{$name}[$j]; 10218: if (ref($subcats) eq 'HASH') { 10219: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1'); 10220: } 10221: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats); 10222: } 10223: } else { 10224: if (ref($subcats) eq 'HASH') { 10225: $subcats->{$item} = []; 10226: } 10227: } 10228: } 10229: } 10230: } 10231: return; 10232: } 10233: 10234: =pod 10235: 10236: =item *&recurse_categories() 10237: 10238: Recursively used to generate breadcrumb trails for course categories. 10239: 10240: Inputs: 10241: 10242: cats (reference to array of arrays/hashes which encapsulates hierarchy of 10243: categories and subcategories). 10244: 10245: depth (current depth in hierarchy of categories and sub-categories - 0 indexed). 10246: 10247: category (current course category, for which breadcrumb trail is being generated). 10248: 10249: trails (reference to array of breadcrumb trails for each category). 10250: 10251: allitems (reference to hash - key is category key 10252: (format: escaped(name):escaped(parent category):depth in hierarchy). 10253: 10254: parents (array containing containers directories for current category, 10255: back to top level). 10256: 10257: Returns: nothing 10258: 10259: Side effects: populates trails and allitems hash references 10260: 10261: =cut 10262: 10263: sub recurse_categories { 10264: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_; 10265: my $shallower = $depth - 1; 10266: if (ref($cats->[$depth]{$category}) eq 'ARRAY') { 10267: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) { 10268: my $name = $cats->[$depth]{$category}[$k]; 10269: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower; 10270: my $trailstr = join(' -> ',(@{$parents},$category)); 10271: if ($allitems->{$item} eq '') { 10272: push(@{$trails},$trailstr); 10273: $allitems->{$item} = scalar(@{$trails})-1; 10274: } 10275: my $deeper = $depth+1; 10276: push(@{$parents},$category); 10277: if (ref($subcats) eq 'HASH') { 10278: my $subcat = &escape($name).':'.$category.':'.$depth; 10279: for (my $j=@{$parents}; $j>=0; $j--) { 10280: my $higher; 10281: if ($j > 0) { 10282: $higher = &escape($parents->[$j]).':'. 10283: &escape($parents->[$j-1]).':'.$j; 10284: } else { 10285: $higher = &escape($parents->[$j]).'::'.$j; 10286: } 10287: push(@{$subcats->{$higher}},$subcat); 10288: } 10289: } 10290: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents, 10291: $subcats); 10292: pop(@{$parents}); 10293: } 10294: } else { 10295: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower; 10296: my $trailstr = join(' -> ',(@{$parents},$category)); 10297: if ($allitems->{$item} eq '') { 10298: push(@{$trails},$trailstr); 10299: $allitems->{$item} = scalar(@{$trails})-1; 10300: } 10301: } 10302: return; 10303: } 10304: 10305: =pod 10306: 10307: =item *&assign_categories_table() 10308: 10309: Create a datatable for display of hierarchical categories in a domain, 10310: with checkboxes to allow a course to be categorized. 10311: 10312: Inputs: 10313: 10314: cathash - reference to hash of categories defined for the domain (from 10315: configuration.db) 10316: 10317: currcat - scalar with an & separated list of categories assigned to a course. 10318: 10319: type - scalar contains course type (Course or Community). 10320: 10321: Returns: $output (markup to be displayed) 10322: 10323: =cut 10324: 10325: sub assign_categories_table { 10326: my ($cathash,$currcat,$type) = @_; 10327: my $output; 10328: if (ref($cathash) eq 'HASH') { 10329: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth); 10330: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray); 10331: $maxdepth = scalar(@cats); 10332: if (@cats > 0) { 10333: my $itemcount = 0; 10334: if (ref($cats[0]) eq 'ARRAY') { 10335: my @currcategories; 10336: if ($currcat ne '') { 10337: @currcategories = split('&',$currcat); 10338: } 10339: my $table; 10340: for (my $i=0; $i<@{$cats[0]}; $i++) { 10341: my $parent = $cats[0][$i]; 10342: next if ($parent eq 'instcode'); 10343: if ($type eq 'Community') { 10344: next unless ($parent eq 'communities'); 10345: } else { 10346: next if ($parent eq 'communities'); 10347: } 10348: my $css_class = $itemcount%2?' class="LC_odd_row"':''; 10349: my $item = &escape($parent).'::0'; 10350: my $checked = ''; 10351: if (@currcategories > 0) { 10352: if (grep(/^\Q$item\E$/,@currcategories)) { 10353: $checked = ' checked="checked"'; 10354: } 10355: } 10356: my $parent_title = $parent; 10357: if ($parent eq 'communities') { 10358: $parent_title = &mt('Communities'); 10359: } 10360: $table .= '<tr '.$css_class.'><td><span class="LC_nobreak">'. 10361: '<input type="checkbox" name="usecategory" value="'. 10362: $item.'"'.$checked.' />'.$parent_title.'</span>'. 10363: '<input type="hidden" name="catname" value="'.$parent.'" /></td>'; 10364: my $depth = 1; 10365: push(@path,$parent); 10366: $table .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories); 10367: pop(@path); 10368: $table .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>'; 10369: $itemcount ++; 10370: } 10371: if ($itemcount) { 10372: $output = &Apache::loncommon::start_data_table(). 10373: $table. 10374: &Apache::loncommon::end_data_table(); 10375: } 10376: } 10377: } 10378: } 10379: return $output; 10380: } 10381: 10382: =pod 10383: 10384: =item *&assign_category_rows() 10385: 10386: Create a datatable row for display of nested categories in a domain, 10387: with checkboxes to allow a course to be categorized,called recursively. 10388: 10389: Inputs: 10390: 10391: itemcount - track row number for alternating colors 10392: 10393: cats - reference to array of arrays/hashes which encapsulates hierarchy of 10394: categories and subcategories. 10395: 10396: depth - current depth in hierarchy of categories and sub-categories - 0 indexed. 10397: 10398: parent - parent of current category item 10399: 10400: path - Array containing all categories back up through the hierarchy from the 10401: current category to the top level. 10402: 10403: currcategories - reference to array of current categories assigned to the course 10404: 10405: Returns: $output (markup to be displayed). 10406: 10407: =cut 10408: 10409: sub assign_category_rows { 10410: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_; 10411: my ($text,$name,$item,$chgstr); 10412: if (ref($cats) eq 'ARRAY') { 10413: my $maxdepth = scalar(@{$cats}); 10414: if (ref($cats->[$depth]) eq 'HASH') { 10415: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') { 10416: my $numchildren = @{$cats->[$depth]{$parent}}; 10417: my $css_class = $itemcount%2?' class="LC_odd_row"':''; 10418: $text .= '<td><table class="LC_datatable">'; 10419: for (my $j=0; $j<$numchildren; $j++) { 10420: $name = $cats->[$depth]{$parent}[$j]; 10421: $item = &escape($name).':'.&escape($parent).':'.$depth; 10422: my $deeper = $depth+1; 10423: my $checked = ''; 10424: if (ref($currcategories) eq 'ARRAY') { 10425: if (@{$currcategories} > 0) { 10426: if (grep(/^\Q$item\E$/,@{$currcategories})) { 10427: $checked = ' checked="checked"'; 10428: } 10429: } 10430: } 10431: $text .= '<tr><td><span class="LC_nobreak"><label>'. 10432: '<input type="checkbox" name="usecategory" value="'. 10433: $item.'"'.$checked.' />'.$name.'</label></span>'. 10434: '<input type="hidden" name="catname" value="'.$name.'" />'. 10435: '</td><td>'; 10436: if (ref($path) eq 'ARRAY') { 10437: push(@{$path},$name); 10438: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories); 10439: pop(@{$path}); 10440: } 10441: $text .= '</td></tr>'; 10442: } 10443: $text .= '</table></td>'; 10444: } 10445: } 10446: } 10447: return $text; 10448: } 10449: 10450: ############################################################ 10451: ############################################################ 10452: 10453: 10454: sub commit_customrole { 10455: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_; 10456: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url. 10457: ($start?', '.&mt('starting').' '.localtime($start):''). 10458: ($end?', ending '.localtime($end):'').': <b>'. 10459: &Apache::lonnet::assigncustomrole( 10460: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context). 10461: '</b><br />'; 10462: return $output; 10463: } 10464: 10465: sub commit_standardrole { 10466: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_; 10467: my ($output,$logmsg,$linefeed); 10468: if ($context eq 'auto') { 10469: $linefeed = "\n"; 10470: } else { 10471: $linefeed = "<br />\n"; 10472: } 10473: if ($three eq 'st') { 10474: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end, 10475: $one,$two,$sec,$context); 10476: if (($result =~ /^error/) || ($result eq 'not_in_class') || 10477: ($result eq 'unknown_course') || ($result eq 'refused')) { 10478: $output = $logmsg.' '.&mt('Error: ').$result."\n"; 10479: } else { 10480: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url. 10481: ($start?', '.&mt('starting').' '.localtime($start):''). 10482: ($end?', '.&mt('ending').' '.localtime($end):'').': '; 10483: if ($context eq 'auto') { 10484: $output .= $result.$linefeed.&mt('Add to classlist').': ok'; 10485: } else { 10486: $output .= '<b>'.$result.'</b>'.$linefeed. 10487: &mt('Add to classlist').': <b>ok</b>'; 10488: } 10489: $output .= $linefeed; 10490: } 10491: } else { 10492: $output = &mt('Assigning').' '.$three.' in '.$url. 10493: ($start?', '.&mt('starting').' '.localtime($start):''). 10494: ($end?', '.&mt('ending').' '.localtime($end):'').': '; 10495: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context); 10496: if ($context eq 'auto') { 10497: $output .= $result.$linefeed; 10498: } else { 10499: $output .= '<b>'.$result.'</b>'.$linefeed; 10500: } 10501: } 10502: return $output; 10503: } 10504: 10505: sub commit_studentrole { 10506: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_; 10507: my ($result,$linefeed,$oldsecurl,$newsecurl); 10508: if ($context eq 'auto') { 10509: $linefeed = "\n"; 10510: } else { 10511: $linefeed = '<br />'."\n"; 10512: } 10513: if (defined($one) && defined($two)) { 10514: my $cid=$one.'_'.$two; 10515: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid); 10516: my $secchange = 0; 10517: my $expire_role_result; 10518: my $modify_section_result; 10519: if ($oldsec ne '-1') { 10520: if ($oldsec ne $sec) { 10521: $secchange = 1; 10522: my $now = time; 10523: my $uurl='/'.$cid; 10524: $uurl=~s/\_/\//g; 10525: if ($oldsec) { 10526: $uurl.='/'.$oldsec; 10527: } 10528: $oldsecurl = $uurl; 10529: $expire_role_result = 10530: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context); 10531: if ($env{'request.course.sec'} ne '') { 10532: if ($expire_role_result eq 'refused') { 10533: my @roles = ('st'); 10534: my @statuses = ('previous'); 10535: my @roledoms = ($one); 10536: my $withsec = 1; 10537: my %roleshash = 10538: &Apache::lonnet::get_my_roles($uname,$udom,'userroles', 10539: \@statuses,\@roles,\@roledoms,$withsec); 10540: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) { 10541: my ($oldstart,$oldend) = 10542: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec}); 10543: if ($oldend > 0 && $oldend <= $now) { 10544: $expire_role_result = 'ok'; 10545: } 10546: } 10547: } 10548: } 10549: $result = $expire_role_result; 10550: } 10551: } 10552: if (($expire_role_result eq 'ok') || ($secchange == 0)) { 10553: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context); 10554: if ($modify_section_result =~ /^ok/) { 10555: if ($secchange == 1) { 10556: if ($sec eq '') { 10557: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed; 10558: } else { 10559: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed; 10560: } 10561: } elsif ($oldsec eq '-1') { 10562: if ($sec eq '') { 10563: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed; 10564: } else { 10565: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed; 10566: } 10567: } else { 10568: if ($sec eq '') { 10569: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed; 10570: } else { 10571: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed; 10572: } 10573: } 10574: } else { 10575: if ($secchange) { 10576: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed; 10577: } else { 10578: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed; 10579: } 10580: } 10581: $result = $modify_section_result; 10582: } elsif ($secchange == 1) { 10583: if ($oldsec eq '') { 10584: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed; 10585: } else { 10586: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed; 10587: } 10588: if ($expire_role_result eq 'refused') { 10589: my $newsecurl = '/'.$cid; 10590: $newsecurl =~ s/\_/\//g; 10591: if ($sec ne '') { 10592: $newsecurl.='/'.$sec; 10593: } 10594: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) { 10595: if ($sec eq '') { 10596: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed; 10597: } else { 10598: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed; 10599: } 10600: } 10601: } 10602: } 10603: } else { 10604: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed; 10605: $result = "error: incomplete course id\n"; 10606: } 10607: return $result; 10608: } 10609: 10610: ############################################################ 10611: ############################################################ 10612: 10613: sub check_clone { 10614: my ($args,$linefeed) = @_; 10615: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'}; 10616: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid); 10617: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom); 10618: my $clonemsg; 10619: my $can_clone = 0; 10620: my $lctype = lc($args->{'crstype'}); 10621: if ($lctype ne 'community') { 10622: $lctype = 'course'; 10623: } 10624: if ($clonehome eq 'no_host') { 10625: if ($args->{'crstype'} eq 'Community') { 10626: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'}); 10627: } else { 10628: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'}); 10629: } 10630: } else { 10631: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1}); 10632: if ($args->{'crstype'} eq 'Community') { 10633: if ($clonedesc{'type'} ne 'Community') { 10634: $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'}); 10635: return ($can_clone, $clonemsg, $cloneid, $clonehome); 10636: } 10637: } 10638: if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 10639: (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) { 10640: $can_clone = 1; 10641: } else { 10642: my %clonehash = &Apache::lonnet::get('environment',['cloners'], 10643: $args->{'clonedomain'},$args->{'clonecourse'}); 10644: my @cloners = split(/,/,$clonehash{'cloners'}); 10645: if (grep(/^\*$/,@cloners)) { 10646: $can_clone = 1; 10647: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) { 10648: $can_clone = 1; 10649: } else { 10650: my $ccrole = 'cc'; 10651: if ($args->{'crstype'} eq 'Community') { 10652: $ccrole = 'co'; 10653: } 10654: my %roleshash = 10655: &Apache::lonnet::get_my_roles($args->{'ccuname'}, 10656: $args->{'ccdomain'}, 10657: 'userroles',['active'],[$ccrole], 10658: [$args->{'clonedomain'}]); 10659: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) { 10660: $can_clone = 1; 10661: } elsif (&Apache::lonnet::is_course_owner($args->{'clonedomain'},$args->{'clonecourse'},$args->{'ccuname'},$args->{'ccdomain'})) { 10662: $can_clone = 1; 10663: } else { 10664: if ($args->{'crstype'} eq 'Community') { 10665: $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}); 10666: } else { 10667: $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'}); 10668: } 10669: } 10670: } 10671: } 10672: } 10673: return ($can_clone, $clonemsg, $cloneid, $clonehome); 10674: } 10675: 10676: sub construct_course { 10677: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_; 10678: my $outcome; 10679: my $linefeed = '<br />'."\n"; 10680: if ($context eq 'auto') { 10681: $linefeed = "\n"; 10682: } 10683: 10684: # 10685: # Are we cloning? 10686: # 10687: my ($can_clone, $clonemsg, $cloneid, $clonehome); 10688: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) { 10689: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed); 10690: if ($context ne 'auto') { 10691: if ($clonemsg ne '') { 10692: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>'; 10693: } 10694: } 10695: $outcome .= $clonemsg.$linefeed; 10696: 10697: if (!$can_clone) { 10698: return (0,$outcome); 10699: } 10700: } 10701: 10702: # 10703: # Open course 10704: # 10705: my $crstype = lc($args->{'crstype'}); 10706: my %cenv=(); 10707: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'}, 10708: $args->{'cdescr'}, 10709: $args->{'curl'}, 10710: $args->{'course_home'}, 10711: $args->{'nonstandard'}, 10712: $args->{'crscode'}, 10713: $args->{'ccuname'}.':'. 10714: $args->{'ccdomain'}, 10715: $args->{'crstype'}, 10716: $cnum,$context,$category); 10717: 10718: # Note: The testing routines depend on this being output; see 10719: # Utils::Course. This needs to at least be output as a comment 10720: # if anyone ever decides to not show this, and Utils::Course::new 10721: # will need to be suitably modified. 10722: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed; 10723: if ($$courseid =~ /^error:/) { 10724: return (0,$outcome); 10725: } 10726: 10727: # 10728: # Check if created correctly 10729: # 10730: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid); 10731: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom); 10732: if ($crsuhome eq 'no_host') { 10733: $outcome .= &mt('Course creation failed, unrecognized course home server.').$linefeed; 10734: return (0,$outcome); 10735: } 10736: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed; 10737: 10738: # 10739: # Do the cloning 10740: # 10741: if ($can_clone && $cloneid) { 10742: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome); 10743: if ($context ne 'auto') { 10744: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>'; 10745: } 10746: $outcome .= $clonemsg.$linefeed; 10747: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum); 10748: # Copy all files 10749: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'}); 10750: # Restore URL 10751: $cenv{'url'}=$oldcenv{'url'}; 10752: # Restore title 10753: $cenv{'description'}=$oldcenv{'description'}; 10754: # Restore creation date, creator and creation context. 10755: $cenv{'internal.created'}=$oldcenv{'internal.created'}; 10756: $cenv{'internal.creator'}=$oldcenv{'internal.creator'}; 10757: $cenv{'internal.creationcontext'}=$oldcenv{'internal.creationcontext'}; 10758: # Mark as cloned 10759: $cenv{'clonedfrom'}=$cloneid; 10760: # Need to clone grading mode 10761: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum); 10762: $cenv{'grading'}=$newenv{'grading'}; 10763: # Do not clone these environment entries 10764: &Apache::lonnet::del('environment', 10765: ['default_enrollment_start_date', 10766: 'default_enrollment_end_date', 10767: 'question.email', 10768: 'policy.email', 10769: 'comment.email', 10770: 'pch.users.denied', 10771: 'plc.users.denied', 10772: 'hidefromcat', 10773: 'categories'], 10774: $$crsudom,$$crsunum); 10775: } 10776: 10777: # 10778: # Set environment (will override cloned, if existing) 10779: # 10780: my @sections = (); 10781: my @xlists = (); 10782: if ($args->{'crstype'}) { 10783: $cenv{'type'}=$args->{'crstype'}; 10784: } 10785: if ($args->{'crsid'}) { 10786: $cenv{'courseid'}=$args->{'crsid'}; 10787: } 10788: if ($args->{'crscode'}) { 10789: $cenv{'internal.coursecode'}=$args->{'crscode'}; 10790: } 10791: if ($args->{'crsquota'} ne '') { 10792: $cenv{'internal.coursequota'}=$args->{'crsquota'}; 10793: } else { 10794: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20; 10795: } 10796: if ($args->{'ccuname'}) { 10797: $cenv{'internal.courseowner'} = $args->{'ccuname'}. 10798: ':'.$args->{'ccdomain'}; 10799: } else { 10800: $cenv{'internal.courseowner'} = $args->{'curruser'}; 10801: } 10802: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner. 10803: if ($args->{'crssections'}) { 10804: $cenv{'internal.sectionnums'} = ''; 10805: if ($args->{'crssections'} =~ m/,/) { 10806: @sections = split/,/,$args->{'crssections'}; 10807: } else { 10808: $sections[0] = $args->{'crssections'}; 10809: } 10810: if (@sections > 0) { 10811: foreach my $item (@sections) { 10812: my ($sec,$gp) = split/:/,$item; 10813: my $class = $args->{'crscode'}.$sec; 10814: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'}); 10815: $cenv{'internal.sectionnums'} .= $item.','; 10816: unless ($addcheck eq 'ok') { 10817: push @badclasses, $class; 10818: } 10819: } 10820: $cenv{'internal.sectionnums'} =~ s/,$//; 10821: } 10822: } 10823: # do not hide course coordinator from staff listing, 10824: # even if privileged 10825: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'}; 10826: # add crosslistings 10827: if ($args->{'crsxlist'}) { 10828: $cenv{'internal.crosslistings'}=''; 10829: if ($args->{'crsxlist'} =~ m/,/) { 10830: @xlists = split/,/,$args->{'crsxlist'}; 10831: } else { 10832: $xlists[0] = $args->{'crsxlist'}; 10833: } 10834: if (@xlists > 0) { 10835: foreach my $item (@xlists) { 10836: my ($xl,$gp) = split/:/,$item; 10837: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'}); 10838: $cenv{'internal.crosslistings'} .= $item.','; 10839: unless ($addcheck eq 'ok') { 10840: push @badclasses, $xl; 10841: } 10842: } 10843: $cenv{'internal.crosslistings'} =~ s/,$//; 10844: } 10845: } 10846: if ($args->{'autoadds'}) { 10847: $cenv{'internal.autoadds'}=$args->{'autoadds'}; 10848: } 10849: if ($args->{'autodrops'}) { 10850: $cenv{'internal.autodrops'}=$args->{'autodrops'}; 10851: } 10852: # check for notification of enrollment changes 10853: my @notified = (); 10854: if ($args->{'notify_owner'}) { 10855: if ($args->{'ccuname'} ne '') { 10856: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'}); 10857: } 10858: } 10859: if ($args->{'notify_dc'}) { 10860: if ($uname ne '') { 10861: push(@notified,$uname.':'.$udom); 10862: } 10863: } 10864: if (@notified > 0) { 10865: my $notifylist; 10866: if (@notified > 1) { 10867: $notifylist = join(',',@notified); 10868: } else { 10869: $notifylist = $notified[0]; 10870: } 10871: $cenv{'internal.notifylist'} = $notifylist; 10872: } 10873: if (@badclasses > 0) { 10874: my %lt=&Apache::lonlocal::texthash( 10875: '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', 10876: 'dnhr' => 'does not have rights to access enrollment in these classes', 10877: 'adby' => 'as determined by the policies of your institution on access to official classlists' 10878: ); 10879: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}. 10880: ' ('.$lt{'adby'}.')'; 10881: if ($context eq 'auto') { 10882: $outcome .= $badclass_msg.$linefeed; 10883: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n"; 10884: foreach my $item (@badclasses) { 10885: if ($context eq 'auto') { 10886: $outcome .= " - $item\n"; 10887: } else { 10888: $outcome .= "<li>$item</li>\n"; 10889: } 10890: } 10891: if ($context eq 'auto') { 10892: $outcome .= $linefeed; 10893: } else { 10894: $outcome .= "</ul><br /><br /></div>\n"; 10895: } 10896: } 10897: } 10898: if ($args->{'no_end_date'}) { 10899: $args->{'endaccess'} = 0; 10900: } 10901: $cenv{'internal.autostart'}=$args->{'enrollstart'}; 10902: $cenv{'internal.autoend'}=$args->{'enrollend'}; 10903: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'}; 10904: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'}; 10905: if ($args->{'showphotos'}) { 10906: $cenv{'internal.showphotos'}=$args->{'showphotos'}; 10907: } 10908: $cenv{'internal.authtype'} = $args->{'authtype'}; 10909: $cenv{'internal.autharg'} = $args->{'autharg'}; 10910: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) { 10911: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') { 10912: my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student'); 10913: if ($context eq 'auto') { 10914: $outcome .= $krb_msg; 10915: } else { 10916: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>'; 10917: } 10918: $outcome .= $linefeed; 10919: } 10920: } 10921: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) { 10922: if ($args->{'setpolicy'}) { 10923: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'}; 10924: } 10925: if ($args->{'setcontent'}) { 10926: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'}; 10927: } 10928: } 10929: if ($args->{'reshome'}) { 10930: $cenv{'reshome'}=$args->{'reshome'}.'/'; 10931: $cenv{'reshome'}=~s/\/+$/\//; 10932: } 10933: # 10934: # course has keyed access 10935: # 10936: if ($args->{'setkeys'}) { 10937: $cenv{'keyaccess'}='yes'; 10938: } 10939: # if specified, key authority is not course, but user 10940: # only active if keyaccess is yes 10941: if ($args->{'keyauth'}) { 10942: my ($user,$domain) = split(':',$args->{'keyauth'}); 10943: $user = &LONCAPA::clean_username($user); 10944: $domain = &LONCAPA::clean_username($domain); 10945: if ($user ne '' && $domain ne '') { 10946: $cenv{'keyauth'}=$user.':'.$domain; 10947: } 10948: } 10949: 10950: if ($args->{'disresdis'}) { 10951: $cenv{'pch.roles.denied'}='st'; 10952: } 10953: if ($args->{'disablechat'}) { 10954: $cenv{'plc.roles.denied'}='st'; 10955: } 10956: 10957: # Record we've not yet viewed the Course Initialization Helper for this 10958: # course 10959: $cenv{'course.helper.not.run'} = 1; 10960: # 10961: # Use new Randomseed 10962: # 10963: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();; 10964: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();; 10965: # 10966: # The encryption code and receipt prefix for this course 10967: # 10968: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999)); 10969: $cenv{'internal.encpref'}=100+int(9*rand(99)); 10970: # 10971: # By default, use standard grading 10972: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; } 10973: 10974: $outcome .= $linefeed.&mt('Setting environment').': '. 10975: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed; 10976: # 10977: # Open all assignments 10978: # 10979: if ($args->{'openall'}) { 10980: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate'; 10981: my %storecontent = ($storeunder => time, 10982: $storeunder.'.type' => 'date_start'); 10983: 10984: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput 10985: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed; 10986: } 10987: # 10988: # Set first page 10989: # 10990: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank') 10991: || ($cloneid)) { 10992: use LONCAPA::map; 10993: $outcome .= &mt('Setting first resource').': '; 10994: 10995: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence'; 10996: my ($errtext,$fatal)=&LONCAPA::map::mapread($map); 10997: 10998: $outcome .= ($fatal?$errtext:'read ok').' - '; 10999: my $title; my $url; 11000: if ($args->{'firstres'} eq 'syl') { 11001: $title=&mt('Syllabus'); 11002: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus'; 11003: } else { 11004: $title=&mt('Table of Contents'); 11005: $url='/adm/navmaps'; 11006: } 11007: 11008: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res'; 11009: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1); 11010: 11011: if ($errtext) { $fatal=2; } 11012: $outcome .= ($fatal?$errtext:'write ok').$linefeed; 11013: } 11014: 11015: return (1,$outcome); 11016: } 11017: 11018: ############################################################ 11019: ############################################################ 11020: 11021: #SD 11022: # only Community and Course, or anything else? 11023: sub course_type { 11024: my ($cid) = @_; 11025: if (!defined($cid)) { 11026: $cid = $env{'request.course.id'}; 11027: } 11028: if (defined($env{'course.'.$cid.'.type'})) { 11029: return $env{'course.'.$cid.'.type'}; 11030: } else { 11031: return 'Course'; 11032: } 11033: } 11034: 11035: sub group_term { 11036: my $crstype = &course_type(); 11037: my %names = ( 11038: 'Course' => 'group', 11039: 'Community' => 'group', 11040: ); 11041: return $names{$crstype}; 11042: } 11043: 11044: sub course_types { 11045: my @types = ('official','unofficial','community'); 11046: my %typename = ( 11047: official => 'Official course', 11048: unofficial => 'Unofficial course', 11049: community => 'Community', 11050: ); 11051: return (\@types,\%typename); 11052: } 11053: 11054: sub icon { 11055: my ($file)=@_; 11056: my $curfext = lc((split(/\./,$file))[-1]); 11057: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif'; 11058: my $embstyle = &Apache::loncommon::fileembstyle($curfext); 11059: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) { 11060: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'. 11061: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'. 11062: $curfext.".gif") { 11063: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'. 11064: $curfext.".gif"; 11065: } 11066: } 11067: return &lonhttpdurl($iconname); 11068: } 11069: 11070: sub lonhttpdurl { 11071: # 11072: # Had been used for "small fry" static images on separate port 8080. 11073: # Modify here if lightweight http functionality desired again. 11074: # Currently eliminated due to increasing firewall issues. 11075: # 11076: my ($url)=@_; 11077: return $url; 11078: } 11079: 11080: sub connection_aborted { 11081: my ($r)=@_; 11082: $r->print(" ");$r->rflush(); 11083: my $c = $r->connection; 11084: return $c->aborted(); 11085: } 11086: 11087: # Escapes strings that may have embedded 's that will be put into 11088: # strings as 'strings'. 11089: sub escape_single { 11090: my ($input) = @_; 11091: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)> 11092: $input =~ s/\'/\\\'/g; # Esacpe the 's.... 11093: return $input; 11094: } 11095: 11096: # Same as escape_single, but escape's "'s This 11097: # can be used for "strings" 11098: sub escape_double { 11099: my ($input) = @_; 11100: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)> 11101: $input =~ s/\"/\\\"/g; # Esacpe the "s.... 11102: return $input; 11103: } 11104: 11105: # Escapes the last element of a full URL. 11106: sub escape_url { 11107: my ($url) = @_; 11108: my @urlslices = split(/\//, $url,-1); 11109: my $lastitem = &escape(pop(@urlslices)); 11110: return join('/',@urlslices).'/'.$lastitem; 11111: } 11112: 11113: sub compare_arrays { 11114: my ($arrayref1,$arrayref2) = @_; 11115: my (@difference,%count); 11116: @difference = (); 11117: %count = (); 11118: if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) { 11119: foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; } 11120: foreach my $element (keys(%count)) { 11121: if ($count{$element} == 1) { 11122: push(@difference,$element); 11123: } 11124: } 11125: } 11126: return @difference; 11127: } 11128: 11129: # -------------------------------------------------------- Initialize user login 11130: sub init_user_environment { 11131: my ($r, $username, $domain, $authhost, $form, $args) = @_; 11132: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'}; 11133: 11134: my $public=($username eq 'public' && $domain eq 'public'); 11135: 11136: # See if old ID present, if so, remove 11137: 11138: my ($filename,$cookie,$userroles); 11139: my $now=time; 11140: 11141: if ($public) { 11142: my $max_public=100; 11143: my $oldest; 11144: my $oldest_time=0; 11145: for(my $next=1;$next<=$max_public;$next++) { 11146: if (-e $lonids."/publicuser_$next.id") { 11147: my $mtime=(stat($lonids."/publicuser_$next.id"))[9]; 11148: if ($mtime<$oldest_time || !$oldest_time) { 11149: $oldest_time=$mtime; 11150: $oldest=$next; 11151: } 11152: } else { 11153: $cookie="publicuser_$next"; 11154: last; 11155: } 11156: } 11157: if (!$cookie) { $cookie="publicuser_$oldest"; } 11158: } else { 11159: # if this isn't a robot, kill any existing non-robot sessions 11160: if (!$args->{'robot'}) { 11161: opendir(DIR,$lonids); 11162: while ($filename=readdir(DIR)) { 11163: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) { 11164: unlink($lonids.'/'.$filename); 11165: } 11166: } 11167: closedir(DIR); 11168: } 11169: # Give them a new cookie 11170: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'} 11171: : $now.$$.int(rand(10000))); 11172: $cookie="$username\_$id\_$domain\_$authhost"; 11173: 11174: # Initialize roles 11175: 11176: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost); 11177: } 11178: # ------------------------------------ Check browser type and MathML capability 11179: 11180: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml, 11181: $clientunicode,$clientos) = &decode_user_agent($r); 11182: 11183: # ------------------------------------------------------------- Get environment 11184: 11185: my %userenv = &Apache::lonnet::dump('environment',$domain,$username); 11186: my ($tmp) = keys(%userenv); 11187: if ($tmp !~ /^(con_lost|error|no_such_host)/i) { 11188: } else { 11189: undef(%userenv); 11190: } 11191: if (($userenv{'interface'}) && (!$form->{'interface'})) { 11192: $form->{'interface'}=$userenv{'interface'}; 11193: } 11194: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; } 11195: 11196: # --------------- Do not trust query string to be put directly into environment 11197: foreach my $option ('interface','localpath','localres') { 11198: $form->{$option}=~s/[\n\r\=]//gs; 11199: } 11200: # --------------------------------------------------------- Write first profile 11201: 11202: { 11203: my %initial_env = 11204: ("user.name" => $username, 11205: "user.domain" => $domain, 11206: "user.home" => $authhost, 11207: "browser.type" => $clientbrowser, 11208: "browser.version" => $clientversion, 11209: "browser.mathml" => $clientmathml, 11210: "browser.unicode" => $clientunicode, 11211: "browser.os" => $clientos, 11212: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'}, 11213: "request.course.fn" => '', 11214: "request.course.uri" => '', 11215: "request.course.sec" => '', 11216: "request.role" => 'cm', 11217: "request.role.adv" => $env{'user.adv'}, 11218: "request.host" => $ENV{'REMOTE_ADDR'},); 11219: 11220: if ($form->{'localpath'}) { 11221: $initial_env{"browser.localpath"} = $form->{'localpath'}; 11222: $initial_env{"browser.localres"} = $form->{'localres'}; 11223: } 11224: 11225: if ($form->{'interface'}) { 11226: $form->{'interface'}=~s/\W//gs; 11227: $initial_env{"browser.interface"} = $form->{'interface'}; 11228: $env{'browser.interface'}=$form->{'interface'}; 11229: } 11230: 11231: my %is_adv = ( is_adv => $env{'user.adv'} ); 11232: my %domdef = &Apache::lonnet::get_domain_defaults($domain); 11233: 11234: foreach my $tool ('aboutme','blog','portfolio') { 11235: $userenv{'availabletools.'.$tool} = 11236: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload', 11237: undef,\%userenv,\%domdef,\%is_adv); 11238: } 11239: 11240: foreach my $crstype ('official','unofficial','community') { 11241: $userenv{'canrequest.'.$crstype} = 11242: &Apache::lonnet::usertools_access($username,$domain,$crstype, 11243: 'reload','requestcourses', 11244: \%userenv,\%domdef,\%is_adv); 11245: } 11246: 11247: $env{'user.environment'} = "$lonids/$cookie.id"; 11248: 11249: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id", 11250: &GDBM_WRCREAT(),0640)) { 11251: &_add_to_env(\%disk_env,\%initial_env); 11252: &_add_to_env(\%disk_env,\%userenv,'environment.'); 11253: &_add_to_env(\%disk_env,$userroles); 11254: if (ref($args->{'extra_env'})) { 11255: &_add_to_env(\%disk_env,$args->{'extra_env'}); 11256: } 11257: untie(%disk_env); 11258: } else { 11259: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ". 11260: 'Could not create environment storage in lonauth: '.$!.'</span>'); 11261: return 'error: '.$!; 11262: } 11263: } 11264: $env{'request.role'}='cm'; 11265: $env{'request.role.adv'}=$env{'user.adv'}; 11266: $env{'browser.type'}=$clientbrowser; 11267: 11268: return $cookie; 11269: 11270: } 11271: 11272: sub _add_to_env { 11273: my ($idf,$env_data,$prefix) = @_; 11274: if (ref($env_data) eq 'HASH') { 11275: while (my ($key,$value) = each(%$env_data)) { 11276: $idf->{$prefix.$key} = $value; 11277: $env{$prefix.$key} = $value; 11278: } 11279: } 11280: } 11281: 11282: # --- Get the symbolic name of a problem and the url 11283: sub get_symb { 11284: my ($request,$silent) = @_; 11285: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--; 11286: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url))); 11287: if ($symb eq '') { 11288: if (!$silent) { 11289: $request->print("Unable to handle ambiguous references:$url:."); 11290: return (); 11291: } 11292: } 11293: &Apache::lonenc::check_decrypt(\$symb); 11294: return ($symb); 11295: } 11296: 11297: # --------------------------------------------------------------Get annotation 11298: 11299: sub get_annotation { 11300: my ($symb,$enc) = @_; 11301: 11302: my $key = $symb; 11303: if (!$enc) { 11304: $key = 11305: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]); 11306: } 11307: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]); 11308: return $annotation{$key}; 11309: } 11310: 11311: sub clean_symb { 11312: my ($symb,$delete_enc) = @_; 11313: 11314: &Apache::lonenc::check_decrypt(\$symb); 11315: my $enc = $env{'request.enc'}; 11316: if ($delete_enc) { 11317: delete($env{'request.enc'}); 11318: } 11319: 11320: return ($symb,$enc); 11321: } 11322: 11323: sub build_release_hashes { 11324: my ($checkparms,$checkresponsetypes,$checkcrstypes,$anonsurvey,$randomizetry) = @_; 11325: return unless((ref($checkparms) eq 'HASH') && (ref($checkresponsetypes) eq 'HASH') && 11326: (ref($checkcrstypes) eq 'HASH') && (ref($anonsurvey) eq 'HASH') && 11327: (ref($randomizetry) eq 'HASH')); 11328: foreach my $key (keys(%Apache::lonnet::needsrelease)) { 11329: my ($item,$name,$value) = split(/:/,$key); 11330: if ($item eq 'parameter') { 11331: if (ref($checkparms->{$name}) eq 'ARRAY') { 11332: unless(grep(/^\Q$name\E$/,@{$checkparms->{$name}})) { 11333: push(@{$checkparms->{$name}},$value); 11334: } 11335: } else { 11336: push(@{$checkparms->{$name}},$value); 11337: } 11338: } elsif ($item eq 'resourcetag') { 11339: if ($name eq 'responsetype') { 11340: $checkresponsetypes->{$value} = $Apache::lonnet::needsrelease{$key} 11341: } 11342: } elsif ($item eq 'course') { 11343: if ($name eq 'crstype') { 11344: $checkcrstypes->{$value} = $Apache::lonnet::needsrelease{$key}; 11345: } 11346: } 11347: } 11348: ($anonsurvey->{major},$anonsurvey->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:anonsurvey'}); 11349: ($randomizetry->{major},$randomizetry->{minor}) = split(/\./,$Apache::lonnet::needsrelease{'parameter:type:randomizetry'}); 11350: return; 11351: } 11352: 11353: =pod 11354: 11355: =back 11356: 11357: =cut 11358: 11359: 1; 11360: __END__; 11361: