Annotation of loncom/interface/loncommon.pm, revision 1.286

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.286   ! banghart    4: # $Id: loncommon.pm,v 1.285 2005/11/08 20:23:41 albertel Exp $
1.10      albertel    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: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.99      www        61: use Apache::Constants qw(:common :http :methods);
1.82      www        62: use Apache::lonmenu();
1.117     www        63: use Apache::lonlocal;
1.139     matthew    64: use HTML::Entities;
1.117     www        65: 
1.22      www        66: my $readit;
                     67: 
1.157     matthew    68: ##
                     69: ## Global Variables
                     70: ##
1.46      matthew    71: 
1.20      www        72: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41   73: my %language;
1.124     www        74: my %supported_language;
1.12      harris41   75: my %cprtag;
1.192     taceyjo1   76: my %scprtag;
1.12      harris41   77: my %fe; my %fd;
1.41      ng         78: my %category_extensions;
1.12      harris41   79: 
1.63      www        80: # ---------------------------------------------- Designs
                     81: 
                     82: my %designhash;
                     83: 
1.46      matthew    84: # ---------------------------------------------- Thesaurus variables
1.144     matthew    85: #
                     86: # %Keywords:
                     87: #      A hash used by &keyword to determine if a word is considered a keyword.
                     88: # $thesaurus_db_file 
                     89: #      Scalar containing the full path to the thesaurus database.
1.46      matthew    90: 
                     91: my %Keywords;
                     92: my $thesaurus_db_file;
                     93: 
1.144     matthew    94: #
                     95: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                     96: # thesaurus.tab, and filecategories.tab.
                     97: #
1.18      www        98: BEGIN {
1.46      matthew    99:     # Variable initialization
                    100:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    101:     #
1.22      www       102:     unless ($readit) {
1.12      harris41  103: # ------------------------------------------------------------------- languages
                    104:     {
1.158     raeburn   105:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    106:                                    '/language.tab';
                    107:         if ( open(my $fh,"<$langtabfile") ) {
                    108:             while (<$fh>) {
                    109:                 next if /^\#/;
                    110:                 chomp;
                    111:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
                    112:                 $language{$key}=$val.' - '.$enc;
                    113:                 if ($sup) {
                    114:                     $supported_language{$key}=$sup;
                    115:                 }
                    116:             }
                    117:             close($fh);
                    118:         }
1.12      harris41  119:     }
                    120: # ------------------------------------------------------------------ copyrights
                    121:     {
1.158     raeburn   122:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    123:                                   '/copyright.tab';
                    124:         if ( open (my $fh,"<$copyrightfile") ) {
                    125:             while (<$fh>) {
                    126:                 next if /^\#/;
                    127:                 chomp;
                    128:                 my ($key,$val)=(split(/\s+/,$_,2));
                    129:                 $cprtag{$key}=$val;
                    130:             }
                    131:             close($fh);
                    132:         }
1.12      harris41  133:     }
1.192     taceyjo1  134: # ------------------------------------------------------------------ source copyrights
                    135:     {
                    136:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    137:                                   '/source_copyright.tab';
                    138:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
                    139:             while (<$fh>) {
                    140:                 next if /^\#/;
                    141:                 chomp;
                    142:                 my ($key,$val)=(split(/\s+/,$_,2));
                    143:                 $scprtag{$key}=$val;
                    144:             }
                    145:             close($fh);
                    146:         }
                    147:     }
1.63      www       148: 
                    149: # -------------------------------------------------------------- domain designs
                    150: 
                    151:     my $filename;
                    152:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                    153:     opendir(DIR,$designdir);
                    154:     while ($filename=readdir(DIR)) {
1.271     albertel  155: 	if ($filename!~/\.tab$/) { next; }
1.63      www       156: 	my ($domain)=($filename=~/^(\w+)\./);
1.271     albertel  157: 	{
                    158: 	    my $designfile = $designdir.'/'.$filename;
                    159: 	    if ( open (my $fh,"<$designfile") ) {
                    160: 		while (<$fh>) {
                    161: 		    next if /^\#/;
                    162: 		    chomp;
                    163: 		    my ($key,$val)=(split(/\=/,$_));
                    164: 		    if ($val) { $designhash{$domain.'.'.$key}=$val; }
                    165: 		}
                    166: 		close($fh);
                    167: 	    }
                    168: 	}
1.63      www       169: 
                    170:     }
                    171:     closedir(DIR);
                    172: 
                    173: 
1.15      harris41  174: # ------------------------------------------------------------- file categories
                    175:     {
1.158     raeburn   176:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    177:                                   '/filecategories.tab';
                    178:         if ( open (my $fh,"<$categoryfile") ) {
                    179:             while (<$fh>) {
                    180:                 next if /^\#/;
                    181:                 chomp;
                    182:                 my ($extension,$category)=(split(/\s+/,$_,2));
                    183:                 push @{$category_extensions{lc($category)}},$extension;
                    184:             }
                    185:             close($fh);
                    186:         }
                    187: 
1.15      harris41  188:     }
1.12      harris41  189: # ------------------------------------------------------------------ file types
                    190:     {
1.158     raeburn   191:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    192:                '/filetypes.tab';
                    193:         if ( open (my $fh,"<$typesfile") ) {
1.16      harris41  194:             while (<$fh>) {
1.158     raeburn   195:                 next if (/^\#/);
                    196:                 chomp;
                    197:                 my ($ending,$emb,$descr)=split(/\s+/,$_,3);
                    198:                 if ($descr ne '') {
                    199:                     $fe{$ending}=lc($emb);
                    200:                     $fd{$ending}=$descr;
                    201:                 }
                    202:             }
                    203:             close($fh);
                    204:         }
1.12      harris41  205:     }
1.22      www       206:     &Apache::lonnet::logthis(
1.46      matthew   207:               "<font color=yellow>INFO: Read file types</font>");
1.22      www       208:     $readit=1;
1.46      matthew   209:     }  # end of unless($readit) 
1.32      matthew   210:     
                    211: }
1.112     bowersj2  212: 
1.42      matthew   213: ###############################################################
                    214: ##           HTML and Javascript Helper Functions            ##
                    215: ###############################################################
                    216: 
                    217: =pod 
                    218: 
1.112     bowersj2  219: =head1 HTML and Javascript Functions
1.42      matthew   220: 
1.112     bowersj2  221: =over 4
                    222: 
                    223: =item * browser_and_searcher_javascript ()
                    224: 
                    225: X<browsing, javascript>X<searching, javascript>Returns a string
                    226: containing javascript with two functions, C<openbrowser> and
                    227: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    228: tags.
1.42      matthew   229: 
1.112     bowersj2  230: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   231: 
                    232: inputs: formname, elementname, only, omit
                    233: 
                    234: formname and elementname indicate the name of the html form and name of
                    235: the element that the results of the browsing selection are to be placed in. 
                    236: 
                    237: Specifying 'only' will restrict the browser to displaying only files
1.185     www       238: with the given extension.  Can be a comma separated list.
1.42      matthew   239: 
                    240: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       241: with the given extension.  Can be a comma separated list.
1.42      matthew   242: 
1.112     bowersj2  243: =item * opensearcher(formname, elementname) [javascript]
1.42      matthew   244: 
                    245: Inputs: formname, elementname
                    246: 
                    247: formname and elementname specify the name of the html form and the name
                    248: of the element the selection from the search results will be placed in.
                    249: 
                    250: =cut
                    251: 
                    252: sub browser_and_searcher_javascript {
1.199     albertel  253:     my ($mode)=@_;
                    254:     if (!defined($mode)) { $mode='edit'; }
1.170     www       255:     my $resurl=&lastresurl();
1.42      matthew   256:     return <<END;
1.219     albertel  257: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   258:     var editbrowser = null;
1.135     albertel  259:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       260:         var url = '$resurl/?';
1.42      matthew   261:         if (editbrowser == null) {
                    262:             url += 'launch=1&';
                    263:         }
                    264:         url += 'catalogmode=interactive&';
1.199     albertel  265:         url += 'mode=$mode&';
1.42      matthew   266:         url += 'form=' + formname + '&';
                    267:         if (only != null) {
                    268:             url += 'only=' + only + '&';
1.217     albertel  269:         } else {
                    270:             url += 'only=&';
                    271: 	}
1.42      matthew   272:         if (omit != null) {
                    273:             url += 'omit=' + omit + '&';
1.217     albertel  274:         } else {
                    275:             url += 'omit=&';
                    276: 	}
1.135     albertel  277:         if (titleelement != null) {
                    278:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  279:         } else {
                    280: 	    url += 'titleelement=&';
                    281: 	}
1.42      matthew   282:         url += 'element=' + elementname + '';
                    283:         var title = 'Browser';
1.217     albertel  284:         var options = 'scrollbars=1,resizable=1,menubar=1,location=1';
1.42      matthew   285:         options += ',width=700,height=600';
                    286:         editbrowser = open(url,title,options,'1');
                    287:         editbrowser.focus();
                    288:     }
                    289:     var editsearcher;
1.135     albertel  290:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   291:         var url = '/adm/searchcat?';
                    292:         if (editsearcher == null) {
                    293:             url += 'launch=1&';
                    294:         }
                    295:         url += 'catalogmode=interactive&';
1.199     albertel  296:         url += 'mode=$mode&';
1.42      matthew   297:         url += 'form=' + formname + '&';
1.135     albertel  298:         if (titleelement != null) {
                    299:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  300:         } else {
                    301: 	    url += 'titleelement=&';
                    302: 	}
1.42      matthew   303:         url += 'element=' + elementname + '';
                    304:         var title = 'Search';
                    305:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    306:         options += ',width=700,height=600';
                    307:         editsearcher = open(url,title,options,'1');
                    308:         editsearcher.focus();
                    309:     }
1.219     albertel  310: // END LON-CAPA Internal -->
1.42      matthew   311: END
1.170     www       312: }
                    313: 
                    314: sub lastresurl {
1.258     albertel  315:     if ($env{'environment.lastresurl'}) {
                    316: 	return $env{'environment.lastresurl'}
1.170     www       317:     } else {
                    318: 	return '/res';
                    319:     }
                    320: }
                    321: 
                    322: sub storeresurl {
                    323:     my $resurl=&Apache::lonnet::clutter(shift);
                    324:     unless ($resurl=~/^\/res/) { return 0; }
                    325:     $resurl=~s/\/$//;
                    326:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
                    327:     &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
                    328:     return 1;
1.42      matthew   329: }
                    330: 
1.74      www       331: sub studentbrowser_javascript {
1.111     www       332:    unless (
1.258     albertel  333:             (($env{'request.course.id'}) && 
                    334:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})))
                    335:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       336:           ) { return ''; }  
1.74      www       337:    return (<<'ENDSTDBRW');
                    338: <script type="text/javascript" language="Javascript" >
                    339:     var stdeditbrowser;
1.111     www       340:     function openstdbrowser(formname,uname,udom,roleflag) {
1.74      www       341:         var url = '/adm/pickstudent?';
                    342:         var filter;
                    343:         eval('filter=document.'+formname+'.'+uname+'.value;');
                    344:         if (filter != null) {
                    345:            if (filter != '') {
                    346:                url += 'filter='+filter+'&';
                    347: 	   }
                    348:         }
                    349:         url += 'form=' + formname + '&unameelement='+uname+
                    350:                                     '&udomelement='+udom;
1.111     www       351: 	if (roleflag) { url+="&roles=1"; }
1.102     www       352:         var title = 'Student_Browser';
1.74      www       353:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    354:         options += ',width=700,height=600';
                    355:         stdeditbrowser = open(url,title,options,'1');
                    356:         stdeditbrowser.focus();
                    357:     }
                    358: </script>
                    359: ENDSTDBRW
                    360: }
1.42      matthew   361: 
1.74      www       362: sub selectstudent_link {
1.111     www       363:    my ($form,$unameele,$udomele)=@_;
1.258     albertel  364:    if ($env{'request.course.id'}) {  
                    365:        unless (&Apache::lonnet::allowed('srm',$env{'request.course.id'})) {
1.111     www       366: 	   return '';
                    367:        }
                    368:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       369:         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74      www       370:    }
1.258     albertel  371:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111     www       372:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       373:         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111     www       374:    }
                    375:    return '';
1.91      www       376: }
                    377: 
                    378: sub coursebrowser_javascript {
1.234     raeburn   379:     my ($domainfilter)=@_;
1.128     albertel  380:    return (<<ENDSTDBRW);
1.91      www       381: <script type="text/javascript" language="Javascript" >
                    382:     var stdeditbrowser;
1.234     raeburn   383:     function opencrsbrowser(formname,uname,udom,desc,extra_element) {
1.91      www       384:         var url = '/adm/pickcourse?';
                    385:         var filter;
                    386:         if (filter != null) {
                    387:            if (filter != '') {
                    388:                url += 'filter='+filter+'&';
                    389: 	   }
                    390:         }
1.128     albertel  391:         var domainfilter='$domainfilter';
                    392:         if (domainfilter != null) {
                    393:            if (domainfilter != '') {
                    394:                url += 'domainfilter='+domainfilter+'&';
                    395: 	   }
                    396:         }
1.91      www       397:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  398: 	                            '&cdomelement='+udom+
                    399:                                     '&cnameelement='+desc;
1.234     raeburn   400:         if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
                    401:             url += '&roleelement='+extra_element;
                    402:             if (domainfilter == null || domainfilter == '') {
                    403:                 url += '&domainfilter='+extra_element;
                    404:             }
1.230     raeburn   405:         }
1.102     www       406:         var title = 'Course_Browser';
1.91      www       407:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    408:         options += ',width=700,height=600';
                    409:         stdeditbrowser = open(url,title,options,'1');
                    410:         stdeditbrowser.focus();
                    411:     }
                    412: </script>
                    413: ENDSTDBRW
                    414: }
                    415: 
                    416: sub selectcourse_link {
1.234     raeburn   417:    my ($form,$unameele,$udomele,$desc,$extra_element)=@_;
1.91      www       418:     return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
1.234     raeburn   419:         '","'.$udomele.'","'.$desc.'","'.$extra_element.'");'."'>".&mt('Select Course')."</a>";
1.74      www       420: }
1.42      matthew   421: 
1.273     raeburn   422: sub check_uncheck_jscript {
                    423:     my $jscript = <<"ENDSCRT";
                    424: function checkAll(field) {
                    425:     if (field.length > 0) {
                    426:         for (i = 0; i < field.length; i++) {
                    427:             field[i].checked = true ;
                    428:         }
                    429:     } else {
                    430:         field.checked = true
                    431:     }
                    432: }
                    433:  
                    434: function uncheckAll(field) {
                    435:     if (field.length > 0) {
                    436:         for (i = 0; i < field.length; i++) {
                    437:             field[i].checked = false ;
                    438:         }     } else {
                    439:         field.checked = false ;
                    440:     }
                    441: }
                    442: ENDSCRT
                    443:     return $jscript;
                    444: }
                    445: 
                    446: 
1.42      matthew   447: =pod
1.36      matthew   448: 
1.112     bowersj2  449: =item * linked_select_forms(...)
1.36      matthew   450: 
                    451: linked_select_forms returns a string containing a <script></script> block
                    452: and html for two <select> menus.  The select menus will be linked in that
                    453: changing the value of the first menu will result in new values being placed
                    454: in the second menu.  The values in the select menu will appear in alphabetical
                    455: order.
                    456: 
                    457: linked_select_forms takes the following ordered inputs:
                    458: 
                    459: =over 4
                    460: 
1.112     bowersj2  461: =item * $formname, the name of the <form> tag
1.36      matthew   462: 
1.112     bowersj2  463: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   464: 
1.112     bowersj2  465: =item * $firstdefault, the default value for the first menu
1.36      matthew   466: 
1.112     bowersj2  467: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   468: 
1.112     bowersj2  469: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   470: 
1.112     bowersj2  471: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   472: 
1.41      ng        473: =back 
                    474: 
1.36      matthew   475: Below is an example of such a hash.  Only the 'text', 'default', and 
                    476: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    477: values for the first select menu.  The text that coincides with the 
1.41      ng        478: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   479: and text for the second menu are given in the hash pointed to by 
                    480: $menu{$choice1}->{'select2'}.  
                    481: 
1.112     bowersj2  482:  my %menu = ( A1 => { text =>"Choice A1" ,
                    483:                        default => "B3",
                    484:                        select2 => { 
                    485:                            B1 => "Choice B1",
                    486:                            B2 => "Choice B2",
                    487:                            B3 => "Choice B3",
                    488:                            B4 => "Choice B4"
                    489:                            }
                    490:                    },
                    491:                A2 => { text =>"Choice A2" ,
                    492:                        default => "C2",
                    493:                        select2 => { 
                    494:                            C1 => "Choice C1",
                    495:                            C2 => "Choice C2",
                    496:                            C3 => "Choice C3"
                    497:                            }
                    498:                    },
                    499:                A3 => { text =>"Choice A3" ,
                    500:                        default => "D6",
                    501:                        select2 => { 
                    502:                            D1 => "Choice D1",
                    503:                            D2 => "Choice D2",
                    504:                            D3 => "Choice D3",
                    505:                            D4 => "Choice D4",
                    506:                            D5 => "Choice D5",
                    507:                            D6 => "Choice D6",
                    508:                            D7 => "Choice D7"
                    509:                            }
                    510:                    }
                    511:                );
1.36      matthew   512: 
                    513: =cut
                    514: 
                    515: sub linked_select_forms {
                    516:     my ($formname,
                    517:         $middletext,
                    518:         $firstdefault,
                    519:         $firstselectname,
                    520:         $secondselectname, 
                    521:         $hashref
                    522:         ) = @_;
                    523:     my $second = "document.$formname.$secondselectname";
                    524:     my $first = "document.$formname.$firstselectname";
                    525:     # output the javascript to do the changing
                    526:     my $result = '';
1.219     albertel  527:     $result.="<script type=\"text/javascript\">\n";
1.36      matthew   528:     $result.="var select2data = new Object();\n";
                    529:     $" = '","';
                    530:     my $debug = '';
                    531:     foreach my $s1 (sort(keys(%$hashref))) {
                    532:         $result.="select2data.d_$s1 = new Object();\n";        
                    533:         $result.="select2data.d_$s1.def = new String('".
                    534:             $hashref->{$s1}->{'default'}."');\n";
                    535:         $result.="select2data.d_$s1.values = new Array(";        
                    536:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
                    537:         $result.="\"@s2values\");\n";
                    538:         $result.="select2data.d_$s1.texts = new Array(";        
                    539:         my @s2texts;
                    540:         foreach my $value (@s2values) {
                    541:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    542:         }
                    543:         $result.="\"@s2texts\");\n";
                    544:     }
                    545:     $"=' ';
                    546:     $result.= <<"END";
                    547: 
                    548: function select1_changed() {
                    549:     // Determine new choice
                    550:     var newvalue = "d_" + $first.value;
                    551:     // update select2
                    552:     var values     = select2data[newvalue].values;
                    553:     var texts      = select2data[newvalue].texts;
                    554:     var select2def = select2data[newvalue].def;
                    555:     var i;
                    556:     // out with the old
                    557:     for (i = 0; i < $second.options.length; i++) {
                    558:         $second.options[i] = null;
                    559:     }
                    560:     // in with the nuclear
                    561:     for (i=0;i<values.length; i++) {
                    562:         $second.options[i] = new Option(values[i]);
1.143     matthew   563:         $second.options[i].value = values[i];
1.36      matthew   564:         $second.options[i].text = texts[i];
                    565:         if (values[i] == select2def) {
                    566:             $second.options[i].selected = true;
                    567:         }
                    568:     }
                    569: }
                    570: </script>
                    571: END
                    572:     # output the initial values for the selection lists
                    573:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
                    574:     foreach my $value (sort(keys(%$hashref))) {
                    575:         $result.="    <option value=\"$value\" ";
1.253     albertel  576:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       577:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   578:     }
                    579:     $result .= "</select>\n";
                    580:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    581:     $result .= $middletext;
                    582:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    583:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
                    584:     foreach my $value (sort(keys(%select2))) {
                    585:         $result.="    <option value=\"$value\" ";        
1.253     albertel  586:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       587:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   588:     }
                    589:     $result .= "</select>\n";
                    590:     #    return $debug;
                    591:     return $result;
                    592: }   #  end of sub linked_select_forms {
                    593: 
1.45      matthew   594: =pod
1.44      bowersj2  595: 
1.112     bowersj2  596: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44      bowersj2  597: 
1.112     bowersj2  598: Returns a string corresponding to an HTML link to the given help
                    599: $topic, where $topic corresponds to the name of a .tex file in
                    600: /home/httpd/html/adm/help/tex, with underscores replaced by
                    601: spaces. 
                    602: 
                    603: $text will optionally be linked to the same topic, allowing you to
                    604: link text in addition to the graphic. If you do not want to link
                    605: text, but wish to specify one of the later parameters, pass an
                    606: empty string. 
                    607: 
                    608: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    609: the link will not open a new window. If false, the link will open
                    610: a new window using Javascript. (Default is false.) 
                    611: 
                    612: $width and $height are optional numerical parameters that will
                    613: override the width and height of the popped up window, which may
                    614: be useful for certain help topics with big pictures included. 
1.44      bowersj2  615: 
                    616: =cut
                    617: 
                    618: sub help_open_topic {
1.48      bowersj2  619:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    620:     $text = "" if (not defined $text);
1.44      bowersj2  621:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  622:     if ($env{'browser.interface'} eq 'textual' ||
                    623: 	$env{'environment.remote'} eq 'off' ) {
1.79      www       624: 	$stayOnPage=1;
                    625:     }
1.44      bowersj2  626:     $width = 350 if (not defined $width);
                    627:     $height = 400 if (not defined $height);
                    628:     my $filename = $topic;
                    629:     $filename =~ s/ /_/g;
                    630: 
1.48      bowersj2  631:     my $template = "";
                    632:     my $link;
1.159     www       633: 
                    634:     $topic=~s/\W/\_/g;
1.44      bowersj2  635: 
                    636:     if (!$stayOnPage)
                    637:     {
1.72      bowersj2  638: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.44      bowersj2  639:     }
                    640:     else
                    641:     {
1.48      bowersj2  642: 	$link = "/adm/help/${filename}.hlp";
                    643:     }
                    644: 
                    645:     # Add the text
                    646:     if ($text ne "")
                    647:     {
1.77      www       648: 	$template .= 
                    649:   "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.78      www       650:   "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48      bowersj2  651:     }
                    652: 
                    653:     # Add the graphic
1.179     matthew   654:     my $title = &mt('Online Help');
1.215     albertel  655:     my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48      bowersj2  656:     $template .= <<"ENDTEMPLATE";
1.218     albertel  657:  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44      bowersj2  658: ENDTEMPLATE
1.78      www       659:     if ($text ne '') { $template.='</td></tr></table>' };
1.44      bowersj2  660:     return $template;
                    661: 
1.106     bowersj2  662: }
                    663: 
                    664: # This is a quicky function for Latex cheatsheet editing, since it 
                    665: # appears in at least four places
                    666: sub helpLatexCheatsheet {
                    667:     my $other = shift;
                    668:     my $addOther = '';
                    669:     if ($other) {
                    670: 	$addOther = Apache::loncommon::help_open_topic($other, shift,
                    671: 						       undef, undef, 600) .
                    672: 							   '</td><td>';
                    673:     }
                    674:     return '<table><tr><td>'.
                    675: 	$addOther .
                    676: 	&Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
                    677: 					    undef,undef,600)
                    678: 	.'</td><td>'.
                    679: 	&Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
                    680: 					    undef,undef,600)
                    681: 	.'</td></tr></table>';
1.172     www       682: }
                    683: 
1.193     raeburn   684: sub help_open_menu {
                    685:     my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;
                    686:     $text = "" if (not defined $text);
                    687:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  688:     if ($env{'browser.interface'} eq 'textual' ||
                    689:         $env{'environment.remote'} eq 'off' ) {
1.193     raeburn   690:         $stayOnPage=1;
                    691:     }
                    692:     $width = 620 if (not defined $width);
                    693:     $height = 600 if (not defined $height);
                    694:     my $link='';
1.201     raeburn   695:     my $title = &mt('Get help');
1.193     raeburn   696:     my $origurl = $ENV{'REQUEST_URI'};
1.227     albertel  697:     $origurl=~s|^/~|/priv/|;
1.193     raeburn   698:     my $timestamp = time;
                    699:     foreach (\$color,\$function,\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                    700:         $$_ = &Apache::lonnet::escape($$_);
                    701:     }
1.195     albertel  702:     if (!$stayOnPage) {
1.193     raeburn   703:          $link = "javascript:helpMenu('open')";
1.195     albertel  704:     } else {
1.193     raeburn   705:         $link = "javascript:helpMenu('display')";
                    706:     }
1.198     raeburn   707:     my $banner_link = "/adm/helpmenu?page=banner&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1.193     raeburn   708:     my $details_link = "/adm/helpmenu?page=body&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp";
1.196     albertel  709:     my $template;
                    710:     if ($text ne "") {
                    711: 	$template .= 
1.265     albertel  712:   "<table bgcolor='#CC3300' cellspacing='1' cellpadding='1' border='0'><tr>".
                    713:   "<td bgcolor='#CC6600'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.196     albertel  714:     }
1.261     albertel  715:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.250     albertel  716:     my $html=&Apache::lonxml::xmlbegin();
1.215     albertel  717:     my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
1.196     albertel  718:     $template .= <<"ENDTEMPLATE";
1.219     albertel  719:  <script type="text/javascript">
1.253     albertel  720: // <!-- BEGIN LON-CAPA Internal
                    721: // <![CDATA[
1.243     raeburn   722: function helpMenu(target) {
                    723:     var caller = this;
                    724:     if (target == 'open') {
                    725:         var newWindow = null;
                    726:         try {
1.262     albertel  727:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn   728:         }
                    729:         catch(error) {
                    730:             writeHelp(caller);
                    731:             return;
                    732:         }
                    733:         if (newWindow) {
                    734:             caller = newWindow;
                    735:         }
1.193     raeburn   736:     }
1.243     raeburn   737:     writeHelp(caller);
                    738:     return;
                    739: }
                    740: function writeHelp(caller) {
1.264     www       741:     caller.document.writeln('$html<head><title>LON-CAPA Help Menu</title><meta http-equiv="pragma" content="no-cache"></head>')
                    742:     caller.document.writeln("<frameset rows='105,*' border='0'><frame name='bannerframe'  src='$banner_link'><frame name='bodyframe' src='$details_link'></frameset>")
                    743:     caller.document.writeln("</html>")
1.243     raeburn   744:     caller.document.close()
                    745:     caller.focus()
1.193     raeburn   746: }
1.253     albertel  747: // ]]>
1.219     albertel  748: // END LON-CAPA Internal -->
1.193     raeburn   749:  </script>
1.218     albertel  750:  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>
1.193     raeburn   751: ENDTEMPLATE
1.203     albertel  752:     if ($component_help) {
                    753: 	if (!$text) {
                    754: 	    $template=&help_open_topic($component_help,undef,$stayOnPage,
                    755: 				       $width,$height).' '.$template;
                    756: 	} else {
                    757: 	    my $help_text;
                    758: 	    $help_text=&Apache::lonnet::unescape($topic);
                    759: 	    $template='<table><tr><td>'.
                    760: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                    761: 				 $width,$height).'</td><td>'.$template.
                    762: 				 '</td></tr></table>';
                    763: 	}
                    764:     }
1.196     albertel  765:     if ($text ne '') { $template.='</td></tr></table>' };
1.193     raeburn   766:     return $template;
                    767: }
                    768: 
1.172     www       769: sub help_open_bug {
                    770:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel  771:     unless ($env{'user.adv'}) { return ''; }
1.172     www       772:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                    773:     $text = "" if (not defined $text);
                    774:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  775:     if ($env{'browser.interface'} eq 'textual' ||
                    776: 	$env{'environment.remote'} eq 'off' ) {
1.172     www       777: 	$stayOnPage=1;
                    778:     }
1.184     albertel  779:     $width = 600 if (not defined $width);
                    780:     $height = 600 if (not defined $height);
1.172     www       781: 
                    782:     $topic=~s/\W+/\+/g;
                    783:     my $link='';
                    784:     my $template='';
                    785:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
                    786: 	&Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;
                    787:     if (!$stayOnPage)
                    788:     {
                    789: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                    790:     }
                    791:     else
                    792:     {
                    793: 	$link = $url;
                    794:     }
                    795:     # Add the text
                    796:     if ($text ne "")
                    797:     {
                    798: 	$template .= 
                    799:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
                    800:   "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
                    801:     }
                    802: 
                    803:     # Add the graphic
1.179     matthew   804:     my $title = &mt('Report a Bug');
1.215     albertel  805:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www       806:     $template .= <<"ENDTEMPLATE";
1.218     albertel  807:  <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www       808: ENDTEMPLATE
                    809:     if ($text ne '') { $template.='</td></tr></table>' };
                    810:     return $template;
                    811: 
                    812: }
                    813: 
                    814: sub help_open_faq {
                    815:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel  816:     unless ($env{'user.adv'}) { return ''; }
1.172     www       817:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                    818:     $text = "" if (not defined $text);
                    819:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  820:     if ($env{'browser.interface'} eq 'textual' ||
                    821: 	$env{'environment.remote'} eq 'off' ) {
1.172     www       822: 	$stayOnPage=1;
                    823:     }
                    824:     $width = 350 if (not defined $width);
                    825:     $height = 400 if (not defined $height);
                    826: 
                    827:     $topic=~s/\W+/\+/g;
                    828:     my $link='';
                    829:     my $template='';
                    830:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                    831:     if (!$stayOnPage)
                    832:     {
                    833: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                    834:     }
                    835:     else
                    836:     {
                    837: 	$link = $url;
                    838:     }
                    839: 
                    840:     # Add the text
                    841:     if ($text ne "")
                    842:     {
                    843: 	$template .= 
1.173     www       844:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
                    845:   "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172     www       846:     }
                    847: 
                    848:     # Add the graphic
1.179     matthew   849:     my $title = &mt('View the FAQ');
1.215     albertel  850:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www       851:     $template .= <<"ENDTEMPLATE";
1.218     albertel  852:  <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www       853: ENDTEMPLATE
                    854:     if ($text ne '') { $template.='</td></tr></table>' };
                    855:     return $template;
                    856: 
1.44      bowersj2  857: }
1.37      matthew   858: 
1.180     matthew   859: ###############################################################
                    860: ###############################################################
                    861: 
1.45      matthew   862: =pod
                    863: 
1.256     matthew   864: =item * change_content_javascript():
                    865: 
                    866: This and the next function allow you to create small sections of an
                    867: otherwise static HTML page that you can update on the fly with
                    868: Javascript, even in Netscape 4.
                    869: 
                    870: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                    871: must be written to the HTML page once. It will prove the Javascript
                    872: function "change(name, content)". Calling the change function with the
                    873: name of the section 
                    874: you want to update, matching the name passed to C<changable_area>, and
                    875: the new content you want to put in there, will put the content into
                    876: that area.
                    877: 
                    878: B<Note>: Netscape 4 only reserves enough space for the changable area
                    879: to contain room for the original contents. You need to "make space"
                    880: for whatever changes you wish to make, and be B<sure> to check your
                    881: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                    882: it's adequate for updating a one-line status display, but little more.
                    883: This script will set the space to 100% width, so you only need to
                    884: worry about height in Netscape 4.
                    885: 
                    886: Modern browsers are much less limiting, and if you can commit to the
                    887: user not using Netscape 4, this feature may be used freely with
                    888: pretty much any HTML.
                    889: 
                    890: =cut
                    891: 
                    892: sub change_content_javascript {
                    893:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel  894:     if ($env{'browser.type'} eq 'netscape' &&
                    895: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew   896: 	return (<<NETSCAPE4);
                    897: 	function change(name, content) {
                    898: 	    doc = document.layers[name+"___escape"].layers[0].document;
                    899: 	    doc.open();
                    900: 	    doc.write(content);
                    901: 	    doc.close();
                    902: 	}
                    903: NETSCAPE4
                    904:     } else {
                    905: 	# Otherwise, we need to use semi-standards-compliant code
                    906: 	# (technically, "innerHTML" isn't standard but the equivalent
                    907: 	# is really scary, and every useful browser supports it
                    908: 	return (<<DOMBASED);
                    909: 	function change(name, content) {
                    910: 	    element = document.getElementById(name);
                    911: 	    element.innerHTML = content;
                    912: 	}
                    913: DOMBASED
                    914:     }
                    915: }
                    916: 
                    917: =pod
                    918: 
                    919: =item * changable_area($name, $origContent):
                    920: 
                    921: This provides a "changable area" that can be modified on the fly via
                    922: the Javascript code provided in C<change_content_javascript>. $name is
                    923: the name you will use to reference the area later; do not repeat the
                    924: same name on a given HTML page more then once. $origContent is what
                    925: the area will originally contain, which can be left blank.
                    926: 
                    927: =cut
                    928: 
                    929: sub changable_area {
                    930:     my ($name, $origContent) = @_;
                    931: 
1.258     albertel  932:     if ($env{'browser.type'} eq 'netscape' &&
                    933: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew   934: 	# If this is netscape 4, we need to use the Layer tag
                    935: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                    936:     } else {
                    937: 	return "<span id='$name'>$origContent</span>";
                    938:     }
                    939: }
                    940: 
                    941: =pod
                    942: 
                    943: =back
                    944: 
                    945: =head1 Excel and CSV file utility routines
                    946: 
                    947: =over 4
                    948: 
                    949: =cut
                    950: 
                    951: ###############################################################
                    952: ###############################################################
                    953: 
                    954: =pod
                    955: 
1.112     bowersj2  956: =item * csv_translate($text) 
1.37      matthew   957: 
1.185     www       958: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew   959: format.
                    960: 
                    961: =cut
                    962: 
1.180     matthew   963: ###############################################################
                    964: ###############################################################
1.37      matthew   965: sub csv_translate {
                    966:     my $text = shift;
                    967:     $text =~ s/\"/\"\"/g;
1.209     albertel  968:     $text =~ s/\n/ /g;
1.37      matthew   969:     return $text;
                    970: }
1.180     matthew   971: 
                    972: ###############################################################
                    973: ###############################################################
                    974: 
                    975: =pod
                    976: 
                    977: =item * define_excel_formats
                    978: 
                    979: Define some commonly used Excel cell formats.
                    980: 
                    981: Currently supported formats:
                    982: 
                    983: =over 4
                    984: 
                    985: =item header
                    986: 
                    987: =item bold
                    988: 
                    989: =item h1
                    990: 
                    991: =item h2
                    992: 
                    993: =item h3
                    994: 
1.256     matthew   995: =item h4
                    996: 
                    997: =item i
                    998: 
1.180     matthew   999: =item date
                   1000: 
                   1001: =back
                   1002: 
                   1003: Inputs: $workbook
                   1004: 
                   1005: Returns: $format, a hash reference.
                   1006: 
                   1007: =cut
                   1008: 
                   1009: ###############################################################
                   1010: ###############################################################
                   1011: sub define_excel_formats {
                   1012:     my ($workbook) = @_;
                   1013:     my $format;
                   1014:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1015:                                                 bottom    => 1,
                   1016:                                                 align     => 'center');
                   1017:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1018:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1019:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1020:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1021:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1022:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1023:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1024:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1025:     return $format;
                   1026: }
                   1027: 
                   1028: ###############################################################
                   1029: ###############################################################
1.113     bowersj2 1030: 
                   1031: =pod
                   1032: 
1.256     matthew  1033: =item * create_workbook
1.255     matthew  1034: 
                   1035: Create an Excel worksheet.  If it fails, output message on the
                   1036: request object and return undefs.
                   1037: 
                   1038: Inputs: Apache request object
                   1039: 
                   1040: Returns (undef) on failure, 
                   1041:     Excel worksheet object, scalar with filename, and formats 
                   1042:     from &Apache::loncommon::define_excel_formats on success
                   1043: 
                   1044: =cut
                   1045: 
                   1046: ###############################################################
                   1047: ###############################################################
                   1048: sub create_workbook {
                   1049:     my ($r) = @_;
                   1050:         #
                   1051:     # Create the excel spreadsheet
                   1052:     my $filename = '/prtspool/'.
1.258     albertel 1053:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1054:         time.'_'.rand(1000000000).'.xls';
                   1055:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1056:     if (! defined($workbook)) {
                   1057:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1058:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1059:                             "This error has been logged.  ".
                   1060:                             "Please alert your LON-CAPA administrator").
                   1061:                   '</p>');
                   1062:         return (undef);
                   1063:     }
                   1064:     #
                   1065:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1066:     #
                   1067:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1068:     return ($workbook,$filename,$format);
                   1069: }
                   1070: 
                   1071: ###############################################################
                   1072: ###############################################################
                   1073: 
                   1074: =pod
                   1075: 
1.256     matthew  1076: =item * create_text_file
1.113     bowersj2 1077: 
1.256     matthew  1078: Create a file to write to and eventually make available to the usre.
                   1079: If file creation fails, outputs an error message on the request object and 
                   1080: return undefs.
1.113     bowersj2 1081: 
1.256     matthew  1082: Inputs: Apache request object, and file suffix
1.113     bowersj2 1083: 
1.256     matthew  1084: Returns (undef) on failure, 
                   1085:     Filehandle and filename on success.
1.113     bowersj2 1086: 
                   1087: =cut
                   1088: 
1.256     matthew  1089: ###############################################################
                   1090: ###############################################################
                   1091: sub create_text_file {
                   1092:     my ($r,$suffix) = @_;
                   1093:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1094:     my $fh;
                   1095:     my $filename = '/prtspool/'.
1.258     albertel 1096:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1097:         time.'_'.rand(1000000000).'.'.$suffix;
                   1098:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1099:     if (! defined($fh)) {
                   1100:         $r->log_error("Couldn't open $filename for output $!");
                   1101:         $r->print("Problems occured in creating the output file.  ".
                   1102:                   "This error has been logged.  ".
                   1103:                   "Please alert your LON-CAPA administrator.");
1.113     bowersj2 1104:     }
1.256     matthew  1105:     return ($fh,$filename)
1.113     bowersj2 1106: }
                   1107: 
                   1108: 
1.256     matthew  1109: =pod 
1.113     bowersj2 1110: 
                   1111: =back
                   1112: 
                   1113: =cut
1.37      matthew  1114: 
                   1115: ###############################################################
1.33      matthew  1116: ##        Home server <option> list generating code          ##
                   1117: ###############################################################
1.35      matthew  1118: 
1.45      matthew  1119: =pod
                   1120: 
1.112     bowersj2 1121: =head1 Home Server option list generating code
                   1122: 
                   1123: =over 4
                   1124: 
                   1125: =item * get_domains()
1.35      matthew  1126: 
                   1127: Returns an array containing each of the domains listed in the hosts.tab
                   1128: file.
                   1129: 
                   1130: =cut
                   1131: 
                   1132: #-------------------------------------------
1.34      matthew  1133: sub get_domains {
                   1134:     # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
                   1135:     my @domains;
                   1136:     my %seen;
                   1137:     foreach (sort values(%Apache::lonnet::hostdom)) {
1.169     www      1138: 	push (@domains,$_) unless $seen{$_}++;
1.34      matthew  1139:     }
                   1140:     return @domains;
                   1141: }
1.88      www      1142: 
1.169     www      1143: # ------------------------------------------
                   1144: 
                   1145: sub domain_select {
                   1146:     my ($name,$value,$multiple)=@_;
                   1147:     my %domains=map { 
                   1148: 	$_ => $_.' '.$Apache::lonnet::domaindescription{$_} 
                   1149:     } &get_domains;
                   1150:     if ($multiple) {
                   1151: 	$domains{''}=&mt('Any domain');
1.191     matthew  1152: 	return &multiple_select_form($name,$value,4,%domains);
1.169     www      1153:     } else {
                   1154: 	return &select_form($name,$value,%domains);
                   1155:     }
                   1156: }
                   1157: 
1.282     albertel 1158: #-------------------------------------------
                   1159: 
                   1160: =pod
                   1161: 
                   1162: =item * multiple_select_form($name,$value,$size,%hash)
                   1163: 
                   1164: Returns a string containing a <select> element int multiple mode
                   1165: 
                   1166: 
                   1167: Args:
                   1168:   $name - name of the <select> element
                   1169:   $value - sclara or array ref of values that should already be selected
                   1170:   $size - number of rows long the select element is
1.283     albertel 1171:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1172:           (shown text should already have been &mt())
1.284     albertel 1173:   $order - (optional) array ref of the order to show the elments in
1.283     albertel 1174: 
1.282     albertel 1175: =cut
                   1176: 
                   1177: #-------------------------------------------
1.169     www      1178: sub multiple_select_form {
1.284     albertel 1179:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1180:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1181:     my $output='';
1.191     matthew  1182:     if (! defined($size)) {
                   1183:         $size = 4;
1.283     albertel 1184:         if (scalar(keys(%$hash))<4) {
                   1185:             $size = scalar(keys(%$hash));
1.191     matthew  1186:         }
                   1187:     }
1.169     www      1188:     $output.="\n<select name='$name' size='$size' multiple='1'>";
1.286   ! banghart 1189:     my @order = ref($order) ? @$order
1.284     albertel 1190:                             : sort(keys(%$hash));
                   1191:     foreach my $key (@order) {
                   1192:         $output.='<option value="'.$key.'" ';
                   1193:         $output.='selected="selected" ' if ($selected{$key});
                   1194:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1195:     }
                   1196:     $output.="</select>\n";
                   1197:     return $output;
                   1198: }
                   1199: 
1.88      www      1200: #-------------------------------------------
                   1201: 
                   1202: =pod
                   1203: 
1.112     bowersj2 1204: =item * select_form($defdom,$name,%hash)
1.88      www      1205: 
                   1206: Returns a string containing a <select name='$name' size='1'> form to 
                   1207: allow a user to select options from a hash option_name => displayed text.  
                   1208: See lonrights.pm for an example invocation and use.
                   1209: 
                   1210: =cut
                   1211: 
                   1212: #-------------------------------------------
                   1213: sub select_form {
                   1214:     my ($def,$name,%hash) = @_;
                   1215:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1216:     my @keys;
                   1217:     if (exists($hash{'select_form_order'})) {
                   1218: 	@keys=@{$hash{'select_form_order'}};
                   1219:     } else {
                   1220: 	@keys=sort(keys(%hash));
                   1221:     }
                   1222:     foreach (@keys) {
1.88      www      1223:         $selectform.="<option value=\"$_\" ".
1.253     albertel 1224:             ($_ eq $def ? 'selected="selected" ' : '').
1.119     www      1225:                 ">".&mt($hash{$_})."</option>\n";
1.88      www      1226:     }
                   1227:     $selectform.="</select>";
                   1228:     return $selectform;
                   1229: }
                   1230: 
1.167     www      1231: sub gradeleveldescription {
                   1232:     my $gradelevel=shift;
                   1233:     my %gradelevels=(0 => 'Not specified',
                   1234: 		     1 => 'Grade 1',
                   1235: 		     2 => 'Grade 2',
                   1236: 		     3 => 'Grade 3',
                   1237: 		     4 => 'Grade 4',
                   1238: 		     5 => 'Grade 5',
                   1239: 		     6 => 'Grade 6',
                   1240: 		     7 => 'Grade 7',
                   1241: 		     8 => 'Grade 8',
                   1242: 		     9 => 'Grade 9',
                   1243: 		     10 => 'Grade 10',
                   1244: 		     11 => 'Grade 11',
                   1245: 		     12 => 'Grade 12',
                   1246: 		     13 => 'Grade 13',
                   1247: 		     14 => '100 Level',
                   1248: 		     15 => '200 Level',
                   1249: 		     16 => '300 Level',
                   1250: 		     17 => '400 Level',
                   1251: 		     18 => 'Graduate Level');
                   1252:     return &mt($gradelevels{$gradelevel});
                   1253: }
                   1254: 
1.163     www      1255: sub select_level_form {
                   1256:     my ($deflevel,$name)=@_;
                   1257:     unless ($deflevel) { $deflevel=0; }
1.167     www      1258:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1259:     for (my $i=0; $i<=18; $i++) {
                   1260:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1261:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1262:                 ">".&gradeleveldescription($i)."</option>\n";
                   1263:     }
                   1264:     $selectform.="</select>";
                   1265:     return $selectform;
1.163     www      1266: }
1.167     www      1267: 
1.35      matthew  1268: #-------------------------------------------
                   1269: 
1.45      matthew  1270: =pod
                   1271: 
1.112     bowersj2 1272: =item * select_dom_form($defdom,$name,$includeempty)
1.35      matthew  1273: 
                   1274: Returns a string containing a <select name='$name' size='1'> form to 
                   1275: allow a user to select the domain to preform an operation in.  
                   1276: See loncreateuser.pm for an example invocation and use.
                   1277: 
1.90      www      1278: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1279: selected");
                   1280: 
1.35      matthew  1281: =cut
                   1282: 
                   1283: #-------------------------------------------
1.34      matthew  1284: sub select_dom_form {
1.90      www      1285:     my ($defdom,$name,$includeempty) = @_;
1.34      matthew  1286:     my @domains = get_domains();
1.90      www      1287:     if ($includeempty) { @domains=('',@domains); }
1.34      matthew  1288:     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
                   1289:     foreach (@domains) {
                   1290:         $selectdomain.="<option value=\"$_\" ".
1.253     albertel 1291:             ($_ eq $defdom ? 'selected="selected" ' : '').
1.34      matthew  1292:                 ">$_</option>\n";
                   1293:     }
                   1294:     $selectdomain.="</select>";
                   1295:     return $selectdomain;
                   1296: }
                   1297: 
1.35      matthew  1298: #-------------------------------------------
                   1299: 
1.45      matthew  1300: =pod
                   1301: 
1.112     bowersj2 1302: =item * get_library_servers($domain)
1.35      matthew  1303: 
                   1304: Returns a hash which contains keys like '103l3' and values like 
                   1305: 'kirk.lite.msu.edu'.  All of the keys will be for machines in the
                   1306: given $domain.
                   1307: 
                   1308: =cut
                   1309: 
                   1310: #-------------------------------------------
1.52      matthew  1311: sub get_library_servers {
1.33      matthew  1312:     my $domain = shift;
1.52      matthew  1313:     my %library_servers;
1.33      matthew  1314:     foreach (keys(%Apache::lonnet::libserv)) {
                   1315:         if ($Apache::lonnet::hostdom{$_} eq $domain) {
1.52      matthew  1316:             $library_servers{$_} = $Apache::lonnet::hostname{$_};
1.33      matthew  1317:         }
                   1318:     }
1.52      matthew  1319:     return %library_servers;
1.33      matthew  1320: }
                   1321: 
1.35      matthew  1322: #-------------------------------------------
                   1323: 
1.45      matthew  1324: =pod
                   1325: 
1.112     bowersj2 1326: =item * home_server_option_list($domain)
1.35      matthew  1327: 
                   1328: returns a string which contains an <option> list to be used in a 
                   1329: <select> form input.  See loncreateuser.pm for an example.
                   1330: 
                   1331: =cut
                   1332: 
                   1333: #-------------------------------------------
1.33      matthew  1334: sub home_server_option_list {
                   1335:     my $domain = shift;
1.52      matthew  1336:     my %servers = &get_library_servers($domain);
1.33      matthew  1337:     my $result = '';
                   1338:     foreach (sort keys(%servers)) {
                   1339:         $result.=
                   1340:             '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
                   1341:     }
                   1342:     return $result;
                   1343: }
1.112     bowersj2 1344: 
                   1345: =pod
                   1346: 
                   1347: =back
                   1348: 
                   1349: =cut
1.87      matthew  1350: 
                   1351: ###############################################################
1.112     bowersj2 1352: ##                  Decoding User Agent                      ##
1.87      matthew  1353: ###############################################################
                   1354: 
                   1355: =pod
                   1356: 
1.112     bowersj2 1357: =head1 Decoding the User Agent
                   1358: 
                   1359: =over 4
                   1360: 
                   1361: =item * &decode_user_agent()
1.87      matthew  1362: 
                   1363: Inputs: $r
                   1364: 
                   1365: Outputs:
                   1366: 
                   1367: =over 4
                   1368: 
1.112     bowersj2 1369: =item * $httpbrowser
1.87      matthew  1370: 
1.112     bowersj2 1371: =item * $clientbrowser
1.87      matthew  1372: 
1.112     bowersj2 1373: =item * $clientversion
1.87      matthew  1374: 
1.112     bowersj2 1375: =item * $clientmathml
1.87      matthew  1376: 
1.112     bowersj2 1377: =item * $clientunicode
1.87      matthew  1378: 
1.112     bowersj2 1379: =item * $clientos
1.87      matthew  1380: 
                   1381: =back
                   1382: 
1.157     matthew  1383: =back 
                   1384: 
1.87      matthew  1385: =cut
                   1386: 
                   1387: ###############################################################
                   1388: ###############################################################
                   1389: sub decode_user_agent {
1.247     albertel 1390:     my ($r)=@_;
1.87      matthew  1391:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1392:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1393:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1394:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1395:     my $clientbrowser='unknown';
                   1396:     my $clientversion='0';
                   1397:     my $clientmathml='';
                   1398:     my $clientunicode='0';
                   1399:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1400:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1401: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1402: 	    $clientbrowser=$bname;
                   1403:             $httpbrowser=~/$vreg/i;
                   1404: 	    $clientversion=$1;
                   1405:             $clientmathml=($clientversion>=$minv);
                   1406:             $clientunicode=($clientversion>=$univ);
                   1407: 	}
                   1408:     }
                   1409:     my $clientos='unknown';
                   1410:     if (($httpbrowser=~/linux/i) ||
                   1411:         ($httpbrowser=~/unix/i) ||
                   1412:         ($httpbrowser=~/ux/i) ||
                   1413:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1414:     if (($httpbrowser=~/vax/i) ||
                   1415:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1416:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1417:     if (($httpbrowser=~/mac/i) ||
                   1418:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1419:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1420:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1421:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1422:             $clientunicode,$clientos,);
                   1423: }
                   1424: 
1.32      matthew  1425: ###############################################################
                   1426: ##    Authentication changing form generation subroutines    ##
                   1427: ###############################################################
                   1428: ##
                   1429: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1430: ## hash, and have reasonable default values.
                   1431: ##
                   1432: ##    formname = the name given in the <form> tag.
1.35      matthew  1433: #-------------------------------------------
                   1434: 
1.45      matthew  1435: =pod
                   1436: 
1.112     bowersj2 1437: =head1 Authentication Routines
                   1438: 
                   1439: =over 4
                   1440: 
                   1441: =item * authform_xxxxxx
1.35      matthew  1442: 
                   1443: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1444: handle some of the conveniences required for authentication forms.  
                   1445: This is not an optimal method, but it works.  
                   1446: 
                   1447: See loncreateuser.pm for invocation and use examples.
                   1448: 
                   1449: =over 4
                   1450: 
1.112     bowersj2 1451: =item * authform_header
1.35      matthew  1452: 
1.112     bowersj2 1453: =item * authform_authorwarning
1.35      matthew  1454: 
1.112     bowersj2 1455: =item * authform_nochange
1.35      matthew  1456: 
1.112     bowersj2 1457: =item * authform_kerberos
1.35      matthew  1458: 
1.112     bowersj2 1459: =item * authform_internal
1.35      matthew  1460: 
1.112     bowersj2 1461: =item * authform_filesystem
1.35      matthew  1462: 
                   1463: =back
                   1464: 
1.157     matthew  1465: =back 
                   1466: 
1.35      matthew  1467: =cut
                   1468: 
                   1469: #-------------------------------------------
1.32      matthew  1470: sub authform_header{  
                   1471:     my %in = (
                   1472:         formname => 'cu',
1.80      albertel 1473:         kerb_def_dom => '',
1.32      matthew  1474:         @_,
                   1475:     );
                   1476:     $in{'formname'} = 'document.' . $in{'formname'};
                   1477:     my $result='';
1.80      albertel 1478: 
                   1479: #---------------------------------------------- Code for upper case translation
                   1480:     my $Javascript_toUpperCase;
                   1481:     unless ($in{kerb_def_dom}) {
                   1482:         $Javascript_toUpperCase =<<"END";
                   1483:         switch (choice) {
                   1484:            case 'krb': currentform.elements[choicearg].value =
                   1485:                currentform.elements[choicearg].value.toUpperCase();
                   1486:                break;
                   1487:            default:
                   1488:         }
                   1489: END
                   1490:     } else {
                   1491:         $Javascript_toUpperCase = "";
                   1492:     }
                   1493: 
1.165     raeburn  1494:     my $radioval = "'nochange'";
1.174     matthew  1495:     if (exists($in{'curr_authtype'}) &&
                   1496:         defined($in{'curr_authtype'}) &&
                   1497:         $in{'curr_authtype'} ne '') {
                   1498:         $radioval = "'$in{'curr_authtype'}arg'";
                   1499:     }
1.165     raeburn  1500:     my $argfield = 'null';
                   1501:     if ( grep/^mode$/,(keys %in) ) {
                   1502:         if ($in{'mode'} eq 'modifycourse')  {
                   1503:             if ( grep/^curr_authtype$/,(keys %in) ) {
                   1504:                 $radioval = "'$in{'curr_authtype'}'";
                   1505:             }
                   1506:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1507:                 unless ($in{'curr_autharg'} eq '') {
                   1508:                     $argfield = "'$in{'curr_autharg'}'";
                   1509:                 }
                   1510:             }
                   1511:         }
                   1512:     }
                   1513: 
1.32      matthew  1514:     $result.=<<"END";
                   1515: var current = new Object();
1.165     raeburn  1516: current.radiovalue = $radioval;
                   1517: current.argfield = $argfield;
1.32      matthew  1518: 
                   1519: function changed_radio(choice,currentform) {
                   1520:     var choicearg = choice + 'arg';
                   1521:     // If a radio button in changed, we need to change the argfield
                   1522:     if (current.radiovalue != choice) {
                   1523:         current.radiovalue = choice;
                   1524:         if (current.argfield != null) {
                   1525:             currentform.elements[current.argfield].value = '';
                   1526:         }
                   1527:         if (choice == 'nochange') {
                   1528:             current.argfield = null;
                   1529:         } else {
                   1530:             current.argfield = choicearg;
                   1531:             switch(choice) {
                   1532:                 case 'krb': 
                   1533:                     currentform.elements[current.argfield].value = 
                   1534:                         "$in{'kerb_def_dom'}";
                   1535:                 break;
                   1536:               default:
                   1537:                 break;
                   1538:             }
                   1539:         }
                   1540:     }
                   1541:     return;
                   1542: }
1.22      www      1543: 
1.32      matthew  1544: function changed_text(choice,currentform) {
                   1545:     var choicearg = choice + 'arg';
                   1546:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 1547:         $Javascript_toUpperCase
1.32      matthew  1548:         // clear old field
                   1549:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   1550:             currentform.elements[current.argfield].value = '';
                   1551:         }
                   1552:         current.argfield = choicearg;
                   1553:     }
                   1554:     set_auth_radio_buttons(choice,currentform);
                   1555:     return;
1.20      www      1556: }
1.32      matthew  1557: 
                   1558: function set_auth_radio_buttons(newvalue,currentform) {
                   1559:     var i=0;
                   1560:     while (i < currentform.login.length) {
                   1561:         if (currentform.login[i].value == newvalue) { break; }
                   1562:         i++;
                   1563:     }
                   1564:     if (i == currentform.login.length) {
                   1565:         return;
                   1566:     }
                   1567:     current.radiovalue = newvalue;
                   1568:     currentform.login[i].checked = true;
                   1569:     return;
                   1570: }
                   1571: END
                   1572:     return $result;
                   1573: }
                   1574: 
                   1575: sub authform_authorwarning{
                   1576:     my $result='';
1.144     matthew  1577:     $result='<i>'.
                   1578:         &mt('As a general rule, only authors or co-authors should be '.
                   1579:             'filesystem authenticated '.
                   1580:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  1581:     return $result;
                   1582: }
                   1583: 
                   1584: sub authform_nochange{  
                   1585:     my %in = (
                   1586:               formname => 'document.cu',
                   1587:               kerb_def_dom => 'MSU.EDU',
                   1588:               @_,
                   1589:           );
1.281     albertel 1590:     my $result = '<label>'.&mt('[_1] Do not change login data',
1.144     matthew  1591:                      '<input type="radio" name="login" value="nochange" '.
                   1592:                      'checked="checked" onclick="'.
1.281     albertel 1593:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   1594: 	    '</label>';
1.32      matthew  1595:     return $result;
                   1596: }
                   1597: 
                   1598: sub authform_kerberos{  
                   1599:     my %in = (
                   1600:               formname => 'document.cu',
                   1601:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 1602:               kerb_def_auth => 'krb4',
1.32      matthew  1603:               @_,
                   1604:               );
1.165     raeburn  1605:     my ($check4,$check5,$krbarg);
1.80      albertel 1606:     if ($in{'kerb_def_auth'} eq 'krb5') {
                   1607:        $check5 = " checked=\"on\"";
                   1608:     } else {
                   1609:        $check4 = " checked=\"on\"";
                   1610:     }
1.165     raeburn  1611:     $krbarg = $in{'kerb_def_dom'};
                   1612: 
                   1613:     my $krbcheck = "";
                   1614:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1615:         if ($in{'curr_authtype'} =~ m/^krb/) {
                   1616:             $krbcheck = " checked=\"on\"";
                   1617:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1618:                 $krbarg = $in{'curr_autharg'};
                   1619:             }
                   1620:         }
                   1621:     }
                   1622: 
1.144     matthew  1623:     my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   1624:     my $result .= &mt
                   1625:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 1626:          '[_3] Version 4 [_4] Version 5 [_5]',
                   1627:          '<label><input type="radio" name="login" value="krb" '.
1.165     raeburn  1628:              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.281     albertel 1629:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  1630:              'value="'.$krbarg.'" '.
1.144     matthew  1631:              'onchange="'.$jscall.'" />',
1.281     albertel 1632:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   1633:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   1634: 	 '</label>');
1.32      matthew  1635:     return $result;
                   1636: }
                   1637: 
                   1638: sub authform_internal{  
                   1639:     my %args = (
                   1640:                 formname => 'document.cu',
                   1641:                 kerb_def_dom => 'MSU.EDU',
                   1642:                 @_,
                   1643:                 );
1.165     raeburn  1644: 
                   1645:     my $intcheck = "";
                   1646:     my $intarg = 'value=""';
                   1647:     if ( grep/^curr_authtype$/,(keys %args) ) {
                   1648:         if ($args{'curr_authtype'} eq 'int') {
                   1649:             $intcheck = " checked=\"on\"";
                   1650:             if ( grep/^curr_autharg$/,(keys %args) ) {
                   1651:                 $intarg = "value=\"$args{'curr_autharg'}\"";
                   1652:             }
                   1653:         }
                   1654:     }
                   1655: 
1.144     matthew  1656:     my $jscall = "javascript:changed_radio('int',$args{'formname'});";
                   1657:     my $result.=&mt
                   1658:         ('[_1] Internally authenticated (with initial password [_2])',
1.281     albertel 1659:          '<label><input type="radio" name="login" value="int" '.$intcheck.
1.165     raeburn  1660:              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1661:          '</label><input type="text" size="10" name="intarg" '.$intarg.
1.165     raeburn  1662:              ' onchange="'.$jscall.'" />');
1.32      matthew  1663:     return $result;
                   1664: }
                   1665: 
                   1666: sub authform_local{  
                   1667:     my %in = (
                   1668:               formname => 'document.cu',
                   1669:               kerb_def_dom => 'MSU.EDU',
                   1670:               @_,
                   1671:               );
1.165     raeburn  1672: 
                   1673:     my $loccheck = "";
                   1674:     my $locarg = 'value=""';
                   1675:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1676:         if ($in{'curr_authtype'} eq 'loc') {
                   1677:             $loccheck = " checked=\"on\"";
                   1678:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1679:                 $locarg = "value=\"$in{'curr_autharg'}\"";
                   1680:             }
                   1681:         }
                   1682:     }
                   1683: 
1.144     matthew  1684:     my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160     matthew  1685:     my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.281     albertel 1686:                     '<label><input type="radio" name="login" value="loc" '.$loccheck.
1.165     raeburn  1687:                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1688:                     '</label><input type="text" size="10" name="locarg" '.$locarg.
1.165     raeburn  1689:                         ' onchange="'.$jscall.'" />');
1.32      matthew  1690:     return $result;
                   1691: }
                   1692: 
                   1693: sub authform_filesystem{  
                   1694:     my %in = (
                   1695:               formname => 'document.cu',
                   1696:               kerb_def_dom => 'MSU.EDU',
                   1697:               @_,
                   1698:               );
1.144     matthew  1699:     my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   1700:     my $result.= &mt
                   1701:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 1702:          '<label><input type="radio" name="login" value="fsys" '.
1.144     matthew  1703:          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1704:          '</label><input type="text" size="10" name="fsysarg" value="" '.
1.144     matthew  1705:                   'onchange="'.$jscall.'" />');
1.32      matthew  1706:     return $result;
                   1707: }
                   1708: 
1.80      albertel 1709: ###############################################################
                   1710: ##    Get Authentication Defaults for Domain                 ##
                   1711: ###############################################################
                   1712: 
                   1713: =pod
                   1714: 
1.112     bowersj2 1715: =head1 Domains and Authentication
                   1716: 
                   1717: Returns default authentication type and an associated argument as
                   1718: listed in file 'domain.tab'.
                   1719: 
                   1720: =over 4
                   1721: 
                   1722: =item * get_auth_defaults
1.80      albertel 1723: 
                   1724: get_auth_defaults($target_domain) returns the default authentication
                   1725: type and an associated argument (initial password or a kerberos domain).
                   1726: These values are stored in lonTabs/domain.tab
                   1727: 
                   1728: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
                   1729: 
                   1730: If target_domain is not found in domain.tab, returns nothing ('').
                   1731: 
                   1732: =cut
                   1733: 
                   1734: #-------------------------------------------
                   1735: sub get_auth_defaults {
                   1736:     my $domain=shift;
                   1737:     return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
                   1738: }
                   1739: ###############################################################
                   1740: ##   End Get Authentication Defaults for Domain              ##
                   1741: ###############################################################
                   1742: 
                   1743: ###############################################################
                   1744: ##    Get Kerberos Defaults for Domain                 ##
                   1745: ###############################################################
                   1746: ##
                   1747: ## Returns default kerberos version and an associated argument
                   1748: ## as listed in file domain.tab. If not listed, provides
                   1749: ## appropriate default domain and kerberos version.
                   1750: ##
                   1751: #-------------------------------------------
                   1752: 
                   1753: =pod
                   1754: 
1.112     bowersj2 1755: =item * get_kerberos_defaults
1.80      albertel 1756: 
                   1757: get_kerberos_defaults($target_domain) returns the default kerberos
                   1758: version and domain. If not found in domain.tabs, it defaults to
                   1759: version 4 and the domain of the server.
                   1760: 
                   1761: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   1762: 
                   1763: =cut
                   1764: 
                   1765: #-------------------------------------------
                   1766: sub get_kerberos_defaults {
                   1767:     my $domain=shift;
                   1768:     my ($krbdef,$krbdefdom) =
                   1769:         &Apache::loncommon::get_auth_defaults($domain);
                   1770:     unless ($krbdef =~/^krb/ && $krbdefdom) {
                   1771:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   1772:         my $krbdefdom=$1;
                   1773:         $krbdefdom=~tr/a-z/A-Z/;
                   1774:         $krbdef = "krb4";
                   1775:     }
                   1776:     return ($krbdef,$krbdefdom);
                   1777: }
1.112     bowersj2 1778: 
                   1779: =pod
                   1780: 
                   1781: =back
                   1782: 
                   1783: =cut
1.32      matthew  1784: 
1.46      matthew  1785: ###############################################################
                   1786: ##                Thesaurus Functions                        ##
                   1787: ###############################################################
1.20      www      1788: 
1.46      matthew  1789: =pod
1.20      www      1790: 
1.112     bowersj2 1791: =head1 Thesaurus Functions
                   1792: 
                   1793: =over 4
                   1794: 
                   1795: =item * initialize_keywords
1.46      matthew  1796: 
                   1797: Initializes the package variable %Keywords if it is empty.  Uses the
                   1798: package variable $thesaurus_db_file.
                   1799: 
                   1800: =cut
                   1801: 
                   1802: ###################################################
                   1803: 
                   1804: sub initialize_keywords {
                   1805:     return 1 if (scalar keys(%Keywords));
                   1806:     # If we are here, %Keywords is empty, so fill it up
                   1807:     #   Make sure the file we need exists...
                   1808:     if (! -e $thesaurus_db_file) {
                   1809:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   1810:                                  " failed because it does not exist");
                   1811:         return 0;
                   1812:     }
                   1813:     #   Set up the hash as a database
                   1814:     my %thesaurus_db;
                   1815:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1816:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1817:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   1818:                                  $thesaurus_db_file);
                   1819:         return 0;
                   1820:     } 
                   1821:     #  Get the average number of appearances of a word.
                   1822:     my $avecount = $thesaurus_db{'average.count'};
                   1823:     #  Put keywords (those that appear > average) into %Keywords
                   1824:     while (my ($word,$data)=each (%thesaurus_db)) {
                   1825:         my ($count,undef) = split /:/,$data;
                   1826:         $Keywords{$word}++ if ($count > $avecount);
                   1827:     }
                   1828:     untie %thesaurus_db;
                   1829:     # Remove special values from %Keywords.
                   1830:     foreach ('total.count','average.count') {
                   1831:         delete($Keywords{$_}) if (exists($Keywords{$_}));
                   1832:     }
                   1833:     return 1;
                   1834: }
                   1835: 
                   1836: ###################################################
                   1837: 
                   1838: =pod
                   1839: 
1.112     bowersj2 1840: =item * keyword($word)
1.46      matthew  1841: 
                   1842: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   1843: than the average number of times in the thesaurus database.  Calls 
                   1844: &initialize_keywords
                   1845: 
                   1846: =cut
                   1847: 
                   1848: ###################################################
1.20      www      1849: 
                   1850: sub keyword {
1.46      matthew  1851:     return if (!&initialize_keywords());
                   1852:     my $word=lc(shift());
                   1853:     $word=~s/\W//g;
                   1854:     return exists($Keywords{$word});
1.20      www      1855: }
1.46      matthew  1856: 
                   1857: ###############################################################
                   1858: 
                   1859: =pod 
1.20      www      1860: 
1.112     bowersj2 1861: =item * get_related_words
1.46      matthew  1862: 
1.160     matthew  1863: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  1864: an array of words.  If the keyword is not in the thesaurus, an empty array
                   1865: will be returned.  The order of the words returned is determined by the
                   1866: database which holds them.
                   1867: 
                   1868: Uses global $thesaurus_db_file.
                   1869: 
                   1870: =cut
                   1871: 
                   1872: ###############################################################
                   1873: sub get_related_words {
                   1874:     my $keyword = shift;
                   1875:     my %thesaurus_db;
                   1876:     if (! -e $thesaurus_db_file) {
                   1877:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   1878:                                  "failed because the file does not exist");
                   1879:         return ();
                   1880:     }
                   1881:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1882:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1883:         return ();
                   1884:     } 
                   1885:     my @Words=();
                   1886:     if (exists($thesaurus_db{$keyword})) {
                   1887:         $_ = $thesaurus_db{$keyword};
                   1888:         (undef,@Words) = split/:/;  # The first element is the number of times
                   1889:                                     # the word appears.  We do not need it now.
                   1890:         for (my $i=0;$i<=$#Words;$i++) {
                   1891:             ($Words[$i],undef)= split/\,/,$Words[$i];
1.20      www      1892:         }
                   1893:     }
1.46      matthew  1894:     untie %thesaurus_db;
                   1895:     return @Words;
1.14      harris41 1896: }
1.46      matthew  1897: 
1.112     bowersj2 1898: =pod
                   1899: 
                   1900: =back
                   1901: 
                   1902: =cut
1.61      www      1903: 
                   1904: # -------------------------------------------------------------- Plaintext name
1.81      albertel 1905: =pod
                   1906: 
1.112     bowersj2 1907: =head1 User Name Functions
                   1908: 
                   1909: =over 4
                   1910: 
1.226     albertel 1911: =item * plainname($uname,$udom,$first)
1.81      albertel 1912: 
1.112     bowersj2 1913: Takes a users logon name and returns it as a string in
1.226     albertel 1914: "first middle last generation" form 
                   1915: if $first is set to 'lastname' then it returns it as
                   1916: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 1917: 
                   1918: =cut
1.61      www      1919: 
1.81      albertel 1920: ###############################################################
1.61      www      1921: sub plainname {
1.226     albertel 1922:     my ($uname,$udom,$first)=@_;
1.61      www      1923:     my %names=&Apache::lonnet::get('environment',
                   1924:                     ['firstname','middlename','lastname','generation'],
                   1925: 					 $udom,$uname);
1.226     albertel 1926:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   1927: 					  $names{'middlename'},
                   1928: 					  $names{'lastname'},
                   1929: 					  $names{'generation'},$first);
                   1930:     $name=~s/^\s+//;
1.62      www      1931:     $name=~s/\s+$//;
                   1932:     $name=~s/\s+/ /g;
1.190     albertel 1933:     if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
1.62      www      1934:     return $name;
1.61      www      1935: }
1.66      www      1936: 
                   1937: # -------------------------------------------------------------------- Nickname
1.81      albertel 1938: =pod
                   1939: 
1.112     bowersj2 1940: =item * nickname($uname,$udom)
1.81      albertel 1941: 
                   1942: Gets a users name and returns it as a string as
                   1943: 
                   1944: "&quot;nickname&quot;"
1.66      www      1945: 
1.81      albertel 1946: if the user has a nickname or
                   1947: 
                   1948: "first middle last generation"
                   1949: 
                   1950: if the user does not
                   1951: 
                   1952: =cut
1.66      www      1953: 
                   1954: sub nickname {
                   1955:     my ($uname,$udom)=@_;
1.212     albertel 1956:     my %names;
1.258     albertel 1957:     if ($uname eq $env{'user.name'} &&
                   1958: 	$udom eq $env{'user.domain'}) {
                   1959: 	%names=('nickname'   => $env{'environment.nickname'}  ,
                   1960: 		'firstname'  => $env{'environment.firstname'} ,
                   1961: 		'middlename' => $env{'environment.middlename'},
                   1962: 		'lastname'   => $env{'environment.lastname'}  ,
                   1963: 		'generation' => $env{'environment.generation'});
1.212     albertel 1964:     } else {
                   1965: 	%names=&Apache::lonnet::get('environment',
                   1966: 				    ['nickname','firstname','middlename',
                   1967: 				     'lastname','generation'],$udom,$uname);
                   1968:     }
1.68      albertel 1969:     my $name=$names{'nickname'};
1.66      www      1970:     if ($name) {
                   1971:        $name='&quot;'.$name.'&quot;'; 
                   1972:     } else {
                   1973:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   1974: 	     $names{'lastname'}.' '.$names{'generation'};
                   1975:        $name=~s/\s+$//;
                   1976:        $name=~s/\s+/ /g;
                   1977:     }
                   1978:     return $name;
                   1979: }
                   1980: 
1.61      www      1981: 
                   1982: # ------------------------------------------------------------------ Screenname
1.81      albertel 1983: 
                   1984: =pod
                   1985: 
1.112     bowersj2 1986: =item * screenname($uname,$udom)
1.81      albertel 1987: 
                   1988: Gets a users screenname and returns it as a string
                   1989: 
                   1990: =cut
1.61      www      1991: 
                   1992: sub screenname {
                   1993:     my ($uname,$udom)=@_;
1.258     albertel 1994:     if ($uname eq $env{'user.name'} &&
                   1995: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 1996:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 1997:     return $names{'screenname'};
1.62      www      1998: }
                   1999: 
1.212     albertel 2000: 
1.62      www      2001: # ------------------------------------------------------------- Message Wrapper
                   2002: 
                   2003: sub messagewrapper {
1.200     matthew  2004:     my ($link,$username,$domain)=@_;
1.62      www      2005:     return 
1.200     matthew  2006:         '<a href="/adm/email?compose=individual&'.
                   2007:         'recname='.$username.'&recdom='.$domain.'" '.
                   2008:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2009: }
                   2010: # --------------------------------------------------------------- Notes Wrapper
                   2011: 
                   2012: sub noteswrapper {
                   2013:     my ($link,$un,$do)=@_;
                   2014:     return 
                   2015: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2016: }
                   2017: # ------------------------------------------------------------- Aboutme Wrapper
                   2018: 
                   2019: sub aboutmewrapper {
1.166     www      2020:     my ($link,$username,$domain,$target)=@_;
1.205     www      2021:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.200     matthew  2022: 	($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
1.62      www      2023: }
                   2024: 
                   2025: # ------------------------------------------------------------ Syllabus Wrapper
                   2026: 
                   2027: 
                   2028: sub syllabuswrapper {
1.109     matthew  2029:     my ($linktext,$coursedir,$domain,$fontcolor)=@_;
                   2030:     if ($fontcolor) { 
                   2031:         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
                   2032:     }
1.208     matthew  2033:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2034: }
1.14      harris41 2035: 
1.208     matthew  2036: sub track_student_link {
1.268     albertel 2037:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2038:     my $link ="/adm/trackstudent?";
1.208     matthew  2039:     my $title = 'View recent activity';
                   2040:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2041:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2042:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2043:         $title .= ' of this student';
1.268     albertel 2044:     } 
1.208     matthew  2045:     if (defined($target) && $target !~ /^\s*$/) {
                   2046:         $target = qq{target="$target"};
                   2047:     } else {
                   2048:         $target = '';
                   2049:     }
1.268     albertel 2050:     if ($start) { $link.='&amp;start='.$start; }
1.208     matthew  2051:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2052: }
                   2053: 
1.112     bowersj2 2054: =pod
                   2055: 
                   2056: =back
                   2057: 
                   2058: =head1 Access .tab File Data
                   2059: 
                   2060: =over 4
                   2061: 
                   2062: =item * languageids() 
                   2063: 
                   2064: returns list of all language ids
                   2065: 
                   2066: =cut
                   2067: 
1.14      harris41 2068: sub languageids {
1.16      harris41 2069:     return sort(keys(%language));
1.14      harris41 2070: }
                   2071: 
1.112     bowersj2 2072: =pod
                   2073: 
                   2074: =item * languagedescription() 
                   2075: 
                   2076: returns description of a specified language id
                   2077: 
                   2078: =cut
                   2079: 
1.14      harris41 2080: sub languagedescription {
1.125     www      2081:     my $code=shift;
                   2082:     return  ($supported_language{$code}?'* ':'').
                   2083:             $language{$code}.
1.126     www      2084: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2085: }
                   2086: 
                   2087: sub plainlanguagedescription {
                   2088:     my $code=shift;
                   2089:     return $language{$code};
                   2090: }
                   2091: 
                   2092: sub supportedlanguagecode {
                   2093:     my $code=shift;
                   2094:     return $supported_language{$code};
1.97      www      2095: }
                   2096: 
1.112     bowersj2 2097: =pod
                   2098: 
                   2099: =item * copyrightids() 
                   2100: 
                   2101: returns list of all copyrights
                   2102: 
                   2103: =cut
                   2104: 
                   2105: sub copyrightids {
                   2106:     return sort(keys(%cprtag));
                   2107: }
                   2108: 
                   2109: =pod
                   2110: 
                   2111: =item * copyrightdescription() 
                   2112: 
                   2113: returns description of a specified copyright id
                   2114: 
                   2115: =cut
                   2116: 
                   2117: sub copyrightdescription {
1.166     www      2118:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2119: }
1.197     matthew  2120: 
                   2121: =pod
                   2122: 
1.192     taceyjo1 2123: =item * source_copyrightids() 
                   2124: 
                   2125: returns list of all source copyrights
                   2126: 
                   2127: =cut
                   2128: 
                   2129: sub source_copyrightids {
                   2130:     return sort(keys(%scprtag));
                   2131: }
                   2132: 
                   2133: =pod
                   2134: 
                   2135: =item * source_copyrightdescription() 
                   2136: 
                   2137: returns description of a specified source copyright id
                   2138: 
                   2139: =cut
                   2140: 
                   2141: sub source_copyrightdescription {
                   2142:     return &mt($scprtag{shift(@_)});
                   2143: }
1.112     bowersj2 2144: 
                   2145: =pod
                   2146: 
                   2147: =item * filecategories() 
                   2148: 
                   2149: returns list of all file categories
                   2150: 
                   2151: =cut
                   2152: 
                   2153: sub filecategories {
                   2154:     return sort(keys(%category_extensions));
                   2155: }
                   2156: 
                   2157: =pod
                   2158: 
                   2159: =item * filecategorytypes() 
                   2160: 
                   2161: returns list of file types belonging to a given file
                   2162: category
                   2163: 
                   2164: =cut
                   2165: 
                   2166: sub filecategorytypes {
                   2167:     return @{$category_extensions{lc($_[0])}};
                   2168: }
                   2169: 
                   2170: =pod
                   2171: 
                   2172: =item * fileembstyle() 
                   2173: 
                   2174: returns embedding style for a specified file type
                   2175: 
                   2176: =cut
                   2177: 
                   2178: sub fileembstyle {
                   2179:     return $fe{lc(shift(@_))};
1.169     www      2180: }
                   2181: 
                   2182: 
                   2183: sub filecategoryselect {
                   2184:     my ($name,$value)=@_;
1.189     matthew  2185:     return &select_form($value,$name,
1.169     www      2186: 			'' => &mt('Any category'),
                   2187: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 2188: }
                   2189: 
                   2190: =pod
                   2191: 
                   2192: =item * filedescription() 
                   2193: 
                   2194: returns description for a specified file type
                   2195: 
                   2196: =cut
                   2197: 
                   2198: sub filedescription {
1.188     matthew  2199:     my $file_description = $fd{lc(shift())};
                   2200:     $file_description =~ s:([\[\]]):~$1:g;
                   2201:     return &mt($file_description);
1.112     bowersj2 2202: }
                   2203: 
                   2204: =pod
                   2205: 
                   2206: =item * filedescriptionex() 
                   2207: 
                   2208: returns description for a specified file type with
                   2209: extra formatting
                   2210: 
                   2211: =cut
                   2212: 
                   2213: sub filedescriptionex {
                   2214:     my $ex=shift;
1.188     matthew  2215:     my $file_description = $fd{lc($ex)};
                   2216:     $file_description =~ s:([\[\]]):~$1:g;
                   2217:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 2218: }
                   2219: 
                   2220: # End of .tab access
                   2221: =pod
                   2222: 
                   2223: =back
                   2224: 
                   2225: =cut
                   2226: 
                   2227: # ------------------------------------------------------------------ File Types
                   2228: sub fileextensions {
                   2229:     return sort(keys(%fe));
                   2230: }
                   2231: 
1.97      www      2232: # ----------------------------------------------------------- Display Languages
                   2233: # returns a hash with all desired display languages
                   2234: #
                   2235: 
                   2236: sub display_languages {
                   2237:     my %languages=();
1.118     www      2238:     foreach (&preferred_languages()) {
                   2239: 	$languages{$_}=1;
1.97      www      2240:     }
                   2241:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 2242:     if ($env{'form.displaylanguage'}) {
                   2243: 	foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
1.97      www      2244: 	    $languages{$_}=1;
                   2245:         }
                   2246:     }
                   2247:     return %languages;
1.14      harris41 2248: }
                   2249: 
1.117     www      2250: sub preferred_languages {
                   2251:     my @languages=();
1.258     albertel 2252:     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117     www      2253: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258     albertel 2254: 	         $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177     www      2255:     }
1.258     albertel 2256:     if ($env{'environment.languages'}) {
                   2257: 	@languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
1.118     www      2258:     }
1.162     www      2259:     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
                   2260:     if ($browser) {
                   2261: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
                   2262:     }
1.258     albertel 2263:     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
1.118     www      2264: 	@languages=(@languages,
1.258     albertel 2265: 		$Apache::lonnet::domain_lang_def{$env{'user.domain'}});
1.118     www      2266:     }
1.258     albertel 2267:     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
1.118     www      2268: 	@languages=(@languages,
1.258     albertel 2269: 		$Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
1.118     www      2270:     }
                   2271:     if ($Apache::lonnet::domain_lang_def{
                   2272: 	                          $Apache::lonnet::perlvar{'lonDefDomain'}}) {
                   2273: 	@languages=(@languages,
                   2274: 		$Apache::lonnet::domain_lang_def{
                   2275:                                   $Apache::lonnet::perlvar{'lonDefDomain'}});
                   2276:     }
                   2277: # turn "en-ca" into "en-ca,en"
                   2278:     my @genlanguages;
                   2279:     foreach (@languages) {
                   2280: 	unless ($_=~/\w/) { next; }
                   2281: 	push (@genlanguages,$_);
                   2282: 	if ($_=~/(\-|\_)/) {
                   2283: 	    push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
                   2284: 	}
                   2285:     }
                   2286:     return @genlanguages;
1.117     www      2287: }
                   2288: 
1.112     bowersj2 2289: ###############################################################
                   2290: ##               Student Answer Attempts                     ##
                   2291: ###############################################################
                   2292: 
                   2293: =pod
                   2294: 
                   2295: =head1 Alternate Problem Views
                   2296: 
                   2297: =over 4
                   2298: 
                   2299: =item * get_previous_attempt($symb, $username, $domain, $course,
                   2300:     $getattempt, $regexp, $gradesub)
                   2301: 
                   2302: Return string with previous attempt on problem. Arguments:
                   2303: 
                   2304: =over 4
                   2305: 
                   2306: =item * $symb: Problem, including path
                   2307: 
                   2308: =item * $username: username of the desired student
                   2309: 
                   2310: =item * $domain: domain of the desired student
1.14      harris41 2311: 
1.112     bowersj2 2312: =item * $course: Course ID
1.14      harris41 2313: 
1.112     bowersj2 2314: =item * $getattempt: Leave blank for all attempts, otherwise put
                   2315:     something
1.14      harris41 2316: 
1.112     bowersj2 2317: =item * $regexp: if string matches this regexp, the string will be
                   2318:     sent to $gradesub
1.14      harris41 2319: 
1.112     bowersj2 2320: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 2321: 
1.112     bowersj2 2322: =back
1.14      harris41 2323: 
1.112     bowersj2 2324: The output string is a table containing all desired attempts, if any.
1.16      harris41 2325: 
1.112     bowersj2 2326: =cut
1.1       albertel 2327: 
                   2328: sub get_previous_attempt {
1.43      ng       2329:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 2330:   my $prevattempts='';
1.43      ng       2331:   no strict 'refs';
1.1       albertel 2332:   if ($symb) {
1.3       albertel 2333:     my (%returnhash)=
                   2334:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 2335:     if ($returnhash{'version'}) {
                   2336:       my %lasthash=();
                   2337:       my $version;
                   2338:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.19      harris41 2339:         foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {
1.1       albertel 2340: 	  $lasthash{$_}=$returnhash{$version.':'.$_};
1.19      harris41 2341:         }
1.1       albertel 2342:       }
1.43      ng       2343:       $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40      ng       2344:       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.16      harris41 2345:       foreach (sort(keys %lasthash)) {
1.31      albertel 2346: 	my ($ign,@parts) = split(/\./,$_);
1.41      ng       2347: 	if ($#parts > 0) {
1.31      albertel 2348: 	  my $data=$parts[-1];
                   2349: 	  pop(@parts);
1.40      ng       2350: 	  $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.'&nbsp;</td>';
1.31      albertel 2351: 	} else {
1.41      ng       2352: 	  if ($#parts == 0) {
                   2353: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   2354: 	  } else {
                   2355: 	    $prevattempts.='<th>'.$ign.'</th>';
                   2356: 	  }
1.31      albertel 2357: 	}
1.16      harris41 2358:       }
1.40      ng       2359:       if ($getattempt eq '') {
                   2360: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
                   2361: 	  $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
                   2362: 	    foreach (sort(keys %lasthash)) {
                   2363: 	       my $value;
                   2364: 	       if ($_ =~ /timestamp/) {
                   2365: 		  $value=scalar(localtime($returnhash{$version.':'.$_}));
                   2366: 	       } else {
                   2367: 		  $value=$returnhash{$version.':'.$_};
                   2368: 	       }
1.142     albertel 2369: 	       $prevattempts.='<td>'.&Apache::lonnet::unescape($value).'&nbsp;</td>';   
1.40      ng       2370: 	    }
                   2371: 	 }
1.1       albertel 2372:       }
1.40      ng       2373:       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.16      harris41 2374:       foreach (sort(keys %lasthash)) {
1.5       albertel 2375: 	my $value;
                   2376: 	if ($_ =~ /timestamp/) {
                   2377: 	  $value=scalar(localtime($lasthash{$_}));
                   2378: 	} else {
                   2379: 	  $value=$lasthash{$_};
                   2380: 	}
1.142     albertel 2381: 	$value=&Apache::lonnet::unescape($value);
1.49      ng       2382: 	if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       2383: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 2384:       }
1.40      ng       2385:       $prevattempts.='</tr></table></td></tr></table>';
1.1       albertel 2386:     } else {
                   2387:       $prevattempts='Nothing submitted - no attempts.';
                   2388:     }
                   2389:   } else {
                   2390:     $prevattempts='No data.';
                   2391:   }
1.10      albertel 2392: }
                   2393: 
1.107     albertel 2394: sub relative_to_absolute {
                   2395:     my ($url,$output)=@_;
                   2396:     my $parser=HTML::TokeParser->new(\$output);
                   2397:     my $token;
                   2398:     my $thisdir=$url;
                   2399:     my @rlinks=();
                   2400:     while ($token=$parser->get_token) {
                   2401: 	if ($token->[0] eq 'S') {
                   2402: 	    if ($token->[1] eq 'a') {
                   2403: 		if ($token->[2]->{'href'}) {
                   2404: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   2405: 		}
                   2406: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   2407: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   2408: 	    } elsif ($token->[1] eq 'base') {
                   2409: 		$thisdir=$token->[2]->{'href'};
                   2410: 	    }
                   2411: 	}
                   2412:     }
                   2413:     $thisdir=~s-/[^/]*$--;
                   2414:     foreach (@rlinks) {
                   2415: 	unless (($_=~/^http:\/\//i) ||
                   2416: 		($_=~/^\//) ||
                   2417: 		($_=~/^javascript:/i) ||
                   2418: 		($_=~/^mailto:/i) ||
                   2419: 		($_=~/^\#/)) {
                   2420: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
                   2421: 	    $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
                   2422: 	}
                   2423:     }
                   2424: # -------------------------------------------------- Deal with Applet codebases
                   2425:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   2426:     return $output;
                   2427: }
                   2428: 
1.112     bowersj2 2429: =pod
                   2430: 
                   2431: =item * get_student_view
                   2432: 
                   2433: show a snapshot of what student was looking at
                   2434: 
                   2435: =cut
                   2436: 
1.10      albertel 2437: sub get_student_view {
1.186     albertel 2438:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      2439:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2440:   my (%form);
1.10      albertel 2441:   my @elements=('symb','courseid','domain','username');
                   2442:   foreach my $element (@elements) {
1.186     albertel 2443:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2444:   }
1.186     albertel 2445:   if (defined($moreenv)) {
                   2446:       %form=(%form,%{$moreenv});
                   2447:   }
1.236     albertel 2448:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 2449:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.186     albertel 2450:   my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 2451:   $userview=~s/\<body[^\>]*\>//gi;
                   2452:   $userview=~s/\<\/body\>//gi;
                   2453:   $userview=~s/\<html\>//gi;
                   2454:   $userview=~s/\<\/html\>//gi;
                   2455:   $userview=~s/\<head\>//gi;
                   2456:   $userview=~s/\<\/head\>//gi;
                   2457:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 2458:   $userview=&relative_to_absolute($feedurl,$userview);
1.11      albertel 2459:   return $userview;
                   2460: }
                   2461: 
1.112     bowersj2 2462: =pod
                   2463: 
                   2464: =item * get_student_answers() 
                   2465: 
                   2466: show a snapshot of how student was answering problem
                   2467: 
                   2468: =cut
                   2469: 
1.11      albertel 2470: sub get_student_answers {
1.100     sakharuk 2471:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      2472:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2473:   my (%moreenv);
1.11      albertel 2474:   my @elements=('symb','courseid','domain','username');
                   2475:   foreach my $element (@elements) {
1.186     albertel 2476:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2477:   }
1.186     albertel 2478:   $moreenv{'grade_target'}='answer';
                   2479:   %moreenv=(%form,%moreenv);
                   2480:   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10      albertel 2481:   return $userview;
1.1       albertel 2482: }
1.116     albertel 2483: 
                   2484: =pod
                   2485: 
                   2486: =item * &submlink()
                   2487: 
1.242     albertel 2488: Inputs: $text $uname $udom $symb $target
1.116     albertel 2489: 
                   2490: Returns: A link to grades.pm such as to see the SUBM view of a student
                   2491: 
                   2492: =cut
                   2493: 
                   2494: ###############################################
                   2495: sub submlink {
1.242     albertel 2496:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 2497:     if (!($uname && $udom)) {
                   2498: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2499: 	    &Apache::lonxml::whichuser($symb);
                   2500: 	if (!$symb) { $symb=$cursymb; }
                   2501:     }
1.254     matthew  2502:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242     albertel 2503:     $symb=&Apache::lonnet::escape($symb);
                   2504:     if ($target) { $target="target=\"$target\""; }
                   2505:     return '<a href="/adm/grades?&command=submission&'.
                   2506: 	'symb='.$symb.'&student='.$uname.
                   2507: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   2508: }
                   2509: ##############################################
                   2510: 
                   2511: =pod
                   2512: 
                   2513: =item * &pgrdlink()
                   2514: 
                   2515: Inputs: $text $uname $udom $symb $target
                   2516: 
                   2517: Returns: A link to grades.pm such as to see the PGRD view of a student
                   2518: 
                   2519: =cut
                   2520: 
                   2521: ###############################################
                   2522: sub pgrdlink {
                   2523:     my $link=&submlink(@_);
                   2524:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   2525:     return $link;
                   2526: }
                   2527: ##############################################
                   2528: 
                   2529: =pod
                   2530: 
                   2531: =item * &pprmlink()
                   2532: 
                   2533: Inputs: $text $uname $udom $symb $target
                   2534: 
                   2535: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 2536: student and a specific resource
1.242     albertel 2537: 
                   2538: =cut
                   2539: 
                   2540: ###############################################
                   2541: sub pprmlink {
                   2542:     my ($text,$uname,$udom,$symb,$target)=@_;
                   2543:     if (!($uname && $udom)) {
                   2544: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2545: 	    &Apache::lonxml::whichuser($symb);
                   2546: 	if (!$symb) { $symb=$cursymb; }
                   2547:     }
1.254     matthew  2548:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242     albertel 2549:     $symb=&Apache::lonnet::escape($symb);
                   2550:     if ($target) { $target="target=\"$target\""; }
                   2551:     return '<a href="/adm/parmset?&command=set&'.
                   2552: 	'symb='.$symb.'&uname='.$uname.
                   2553: 	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 2554: }
                   2555: ##############################################
1.37      matthew  2556: 
1.112     bowersj2 2557: =pod
                   2558: 
                   2559: =back
                   2560: 
                   2561: =cut
                   2562: 
1.37      matthew  2563: ###############################################
1.51      www      2564: 
                   2565: 
                   2566: sub timehash {
                   2567:     my @ltime=localtime(shift);
                   2568:     return ( 'seconds' => $ltime[0],
                   2569:              'minutes' => $ltime[1],
                   2570:              'hours'   => $ltime[2],
                   2571:              'day'     => $ltime[3],
                   2572:              'month'   => $ltime[4]+1,
                   2573:              'year'    => $ltime[5]+1900,
                   2574:              'weekday' => $ltime[6],
                   2575:              'dayyear' => $ltime[7]+1,
                   2576:              'dlsav'   => $ltime[8] );
                   2577: }
                   2578: 
                   2579: sub maketime {
                   2580:     my %th=@_;
                   2581:     return POSIX::mktime(
                   2582:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      2583:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      2584: }
                   2585: 
                   2586: #########################################
1.51      www      2587: 
                   2588: sub findallcourses {
                   2589:     my %courses=();
                   2590:     my $now=time;
1.258     albertel 2591:     foreach (keys %env) {
1.51      www      2592: 	if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
1.258     albertel 2593: 	    my ($starttime,$endtime)=$env{$_};
1.51      www      2594:             my $active=1;
                   2595:             if ($starttime) {
                   2596: 		if ($now<$starttime) { $active=0; }
                   2597:             }
                   2598:             if ($endtime) {
                   2599:                 if ($now>$endtime) { $active=0; }
                   2600:             }
                   2601:             if ($active) { $courses{$1.'_'.$2}=1; }
                   2602:         }
                   2603:     }
                   2604:     return keys %courses;
                   2605: }
1.37      matthew  2606: 
1.54      www      2607: ###############################################
1.60      matthew  2608: ###############################################
                   2609: 
                   2610: =pod
                   2611: 
1.112     bowersj2 2612: =head1 Domain Template Functions
                   2613: 
                   2614: =over 4
                   2615: 
                   2616: =item * &determinedomain()
1.60      matthew  2617: 
                   2618: Inputs: $domain (usually will be undef)
                   2619: 
1.63      www      2620: Returns: Determines which domain should be used for designs
1.60      matthew  2621: 
                   2622: =cut
1.54      www      2623: 
1.60      matthew  2624: ###############################################
1.63      www      2625: sub determinedomain {
                   2626:     my $domain=shift;
                   2627:    if (! $domain) {
1.60      matthew  2628:         # Determine domain if we have not been given one
                   2629:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 2630:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   2631:         if ($env{'request.role.domain'}) { 
                   2632:             $domain=$env{'request.role.domain'}; 
1.60      matthew  2633:         }
                   2634:     }
1.63      www      2635:     return $domain;
                   2636: }
                   2637: ###############################################
                   2638: =pod
                   2639: 
1.112     bowersj2 2640: =item * &domainlogo()
1.63      www      2641: 
                   2642: Inputs: $domain (usually will be undef)
                   2643: 
                   2644: Returns: A link to a domain logo, if the domain logo exists.
                   2645: If the domain logo does not exist, a description of the domain.
                   2646: 
                   2647: =cut
1.112     bowersj2 2648: 
1.63      www      2649: ###############################################
                   2650: sub domainlogo {
                   2651:     my $domain = &determinedomain(shift);    
                   2652:      # See if there is a logo
1.59      www      2653:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215     albertel 2654: 	my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
                   2655:         return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60      matthew  2656:     } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
                   2657:         return $Apache::lonnet::domaindescription{$domain};
1.59      www      2658:     } else {
1.60      matthew  2659:         return '';
1.59      www      2660:     }
                   2661: }
1.63      www      2662: ##############################################
                   2663: 
                   2664: =pod
                   2665: 
1.112     bowersj2 2666: =item * &designparm()
1.63      www      2667: 
                   2668: Inputs: $which parameter; $domain (usually will be undef)
                   2669: 
                   2670: Returns: value of designparamter $which
                   2671: 
                   2672: =cut
1.112     bowersj2 2673: 
1.63      www      2674: ##############################################
                   2675: sub designparm {
                   2676:     my ($which,$domain)=@_;
1.258     albertel 2677:     if ($env{'browser.blackwhite'} eq 'on') {
1.110     www      2678: 	if ($which=~/\.(font|alink|vlink|link)$/) {
                   2679: 	    return '#000000';
                   2680: 	}
                   2681: 	if ($which=~/\.(pgbg|sidebg)$/) {
                   2682: 	    return '#FFFFFF';
                   2683: 	}
                   2684: 	if ($which=~/\.tabbg$/) {
                   2685: 	    return '#CCCCCC';
                   2686: 	}
                   2687:     }
1.258     albertel 2688:     if ($env{'environment.color.'.$which}) {
                   2689: 	return $env{'environment.color.'.$which};
1.96      www      2690:     }
1.63      www      2691:     $domain=&determinedomain($domain);
                   2692:     if ($designhash{$domain.'.'.$which}) {
                   2693: 	return $designhash{$domain.'.'.$which};
                   2694:     } else {
                   2695:         return $designhash{'default.'.$which};
                   2696:     }
                   2697: }
1.59      www      2698: 
1.60      matthew  2699: ###############################################
                   2700: ###############################################
                   2701: 
                   2702: =pod
                   2703: 
1.112     bowersj2 2704: =back
                   2705: 
                   2706: =head1 HTTP Helpers
                   2707: 
                   2708: =over 4
                   2709: 
                   2710: =item * &bodytag()
1.60      matthew  2711: 
                   2712: Returns a uniform header for LON-CAPA web pages.
                   2713: 
                   2714: Inputs: 
                   2715: 
1.112     bowersj2 2716: =over 4
                   2717: 
                   2718: =item * $title, A title to be displayed on the page.
                   2719: 
                   2720: =item * $function, the current role (can be undef).
                   2721: 
                   2722: =item * $addentries, extra parameters for the <body> tag.
                   2723: 
                   2724: =item * $bodyonly, if defined, only return the <body> tag.
                   2725: 
                   2726: =item * $domain, if defined, force a given domain.
                   2727: 
                   2728: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      2729:             text interface only)
1.60      matthew  2730: 
1.112     bowersj2 2731: =back
                   2732: 
1.60      matthew  2733: Returns: A uniform header for LON-CAPA web pages.  
                   2734: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   2735: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   2736: other decorations will be returned.
                   2737: 
                   2738: =cut
                   2739: 
1.54      www      2740: sub bodytag {
1.272     raeburn  2741:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,$notopbar)=@_;
1.117     www      2742:     $title=&mt($title);
1.183     matthew  2743:     $function = &get_users_function() if (!$function);
1.63      www      2744:     my $img=&designparm($function.'.img',$domain);
                   2745:     my $pgbg=&designparm($function.'.pgbg',$domain);
                   2746:     my $tabbg=&designparm($function.'.tabbg',$domain);
                   2747:     my $font=&designparm($function.'.font',$domain);
                   2748:     my $link=&designparm($function.'.link',$domain);
                   2749:     my $alink=&designparm($function.'.alink',$domain);
                   2750:     my $vlink=&designparm($function.'.vlink',$domain);
                   2751:     my $sidebg=&designparm($function.'.sidebg',$domain);
1.110     www      2752: # Accessibility font enhance
                   2753:     unless ($addentries) { $addentries=''; }
1.146     www      2754:     my $addstyle='';
1.258     albertel 2755:     if ($env{'browser.fontenhance'} eq 'on') {
1.146     www      2756: 	$addstyle=' font-size: x-large;';
1.110     www      2757:     }
1.63      www      2758:  # role and realm
1.55      www      2759:     my ($role,$realm)
1.258     albertel 2760:        =&Apache::lonnet::plaintext((split(/\./,$env{'request.role'}))[0]);
1.55      www      2761: # realm
1.258     albertel 2762:     if ($env{'request.course.id'}) {
1.55      www      2763: 	$realm=
1.258     albertel 2764:          $env{'course.'.$env{'request.course.id'}.'.description'};
1.54      www      2765:     }
1.55      www      2766:     unless ($realm) { $realm='&nbsp;'; }
                   2767: # Set messages
1.60      matthew  2768:     my $messages=&domainlogo($domain);
1.101     www      2769: # Port for miniserver
1.83      albertel 2770:     my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   2771:     if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.101     www      2772: # construct main body tag
1.60      matthew  2773:     my $bodytag = <<END;
1.231     albertel 2774: <style type="text/css">
1.147     www      2775: h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
1.146     www      2776: a:focus { color: red; background: yellow } 
1.285     albertel 2777: table.thinborder { border-collapse: collapse; }
                   2778: table.thinborder tr th { border-style: solid; border-width: 1px}
                   2779: table.thinborder tr td { border-style: solid; border-width: 1px}
                   2780: .center { text-align: center; }
1.146     www      2781: </style>
1.54      www      2782: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
1.151     www      2783: style="margin-top: 0px;$addstyle" $addentries>
1.60      matthew  2784: END
1.269     albertel 2785:     &Apache::lontexconvert::jsMath_reset();
1.258     albertel 2786:     if ($env{'environment.texengine'} eq 'jsMath') {
1.269     albertel 2787: 	$bodytag.=&Apache::lontexconvert::jsMath_header();
1.252     albertel 2788:     }
                   2789: 
1.94      www      2790:     my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
1.150     matthew  2791:                    $lonhttpdPort.$img.'" alt="'.$function.'" />';
1.60      matthew  2792:     if ($bodyonly) {
                   2793:         return $bodytag;
1.258     albertel 2794:     } elsif ($env{'browser.interface'} eq 'textual') {
1.95      www      2795: # Accessibility
1.224     raeburn  2796:           
1.93      www      2797:         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
                   2798:                                                       $forcereg).
                   2799:                '<h1>LON-CAPA: '.$title.'</h1>';
1.258     albertel 2800:     } elsif ($env{'environment.remote'} eq 'off') {
1.95      www      2801: # No Remote
1.206     albertel 2802: 	my $roleinfo=(<<ENDROLE);
                   2803: <td bgcolor="$tabbg" align="right">
                   2804: <font size="2" face="Arial, Helvetica, sans-serif">
1.258     albertel 2805:     $env{'environment.firstname'}
                   2806:     $env{'environment.middlename'}
                   2807:     $env{'environment.lastname'}
                   2808:     $env{'environment.generation'}
1.206     albertel 2809:     </font>&nbsp;
                   2810: <br />
                   2811: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
                   2812: <br />
                   2813: <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;
                   2814: </td>
                   2815: ENDROLE
1.224     raeburn  2816:         my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
1.229     albertel 2817: 		$font.'"><b>'.$title.'</b></font>';
1.224     raeburn  2818:         if ($customtitle) {
                   2819:             $titleinfo = $customtitle;
1.235     raeburn  2820:         }
                   2821: 
1.258     albertel 2822: 	if ($env{'request.state'} eq 'construct') {
1.229     albertel 2823: 	    my ($uname,$thisdisfn)=
1.258     albertel 2824: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 2825: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   2826: 	    $formaction=~s/\/+/\//g;
1.237     raeburn  2827:             unless ($customtitle) {  #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm  
                   2828:                 my $parentpath = '';
1.241     raeburn  2829:                 my $lastitem = '';
                   2830:                 if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
1.235     raeburn  2831:                     $parentpath = $1;
1.241     raeburn  2832:                     $lastitem = $2;
                   2833:                 } else {
                   2834:                     $lastitem = $thisdisfn;
1.235     raeburn  2835:                 }
                   2836: 	        $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
                   2837:                       '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font>&nbsp;'. 
                   2838:                       '<form name="dirs" method="post" action="'.$formaction
                   2839: 		    .'" target="_top"><tt><b>'
1.241     raeburn  2840: 		    .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
1.235     raeburn  2841: 		    .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   2842: 		    .'</form>'
                   2843: 		    .&Apache::lonmenu::constspaceform();
1.229     albertel 2844: 
1.235     raeburn  2845:             }
                   2846: 	    $forcereg=1;
                   2847:         }
                   2848:         my $titletable = '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
                   2849:                          'cellspacing="3" cellpadding="3">'.
1.270     albertel 2850:                          '<tr><td bgcolor="'.$tabbg.'">'.
1.235     raeburn  2851:                          $titleinfo.'</td>'.$roleinfo.'</tr></table>';
1.258     albertel 2852:         if ($env{'request.state'} eq 'construct') {
1.272     raeburn  2853:             if ($notopbar) {
                   2854:                 $bodytag .= $titletable;
                   2855:             } else {
                   2856:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg,$titletable);
                   2857:             }
1.235     raeburn  2858: 	} else {
1.272     raeburn  2859:             if ($notopbar) {
                   2860:                 $bodytag .= $titletable;
                   2861:             } else {
                   2862:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg).
1.235     raeburn  2863:                         $titletable;
1.272     raeburn  2864:             }
1.235     raeburn  2865:         }
                   2866:         return $bodytag;
1.94      www      2867:     }
1.95      www      2868: 
1.93      www      2869: #
1.95      www      2870: # Top frame rendering, Remote is up
1.93      www      2871: #
1.224     raeburn  2872:     my $titleinfo = '&nbsp;<font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
                   2873:     if ($customtitle) {
                   2874:         $titleinfo = $customtitle;
                   2875:     }
1.245     matthew  2876:     #
                   2877:     # Extra info if you are the DC
                   2878:     my $dc_info = '';
1.258     albertel 2879:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   2880:                         $env{'course.'.$env{'request.course.id'}.
1.245     matthew  2881:                                  '.domain'}.'/'})) {
1.258     albertel 2882:         my $cid = $env{'request.course.id'};
                   2883:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.245     matthew  2884:         $dc_info = '('.$dc_info.')';
                   2885:     }
                   2886:     #
1.94      www      2887:     return(<<ENDBODY);
1.60      matthew  2888: $bodytag
1.285     albertel 2889: <table class="thinborder" width="100%" cellspacing="0" border="0" cellpadding="0">
1.95      www      2890: <tr><td bgcolor="$sidebg">
1.94      www      2891: $upperleft</td>
1.95      www      2892: <td bgcolor="$sidebg" align="right">$messages&nbsp;</td>
1.55      www      2893: </tr>
1.54      www      2894: <tr>
1.55      www      2895: <td rowspan="3" bgcolor="$tabbg">
1.245     matthew  2896: $titleinfo $dc_info
1.257     matthew  2897: </td><td bgcolor="$tabbg" align="right">
1.146     www      2898: <font size="2" face="Arial, Helvetica, sans-serif">
1.258     albertel 2899:     $env{'environment.firstname'}
                   2900:     $env{'environment.middlename'}
                   2901:     $env{'environment.lastname'}
                   2902:     $env{'environment.generation'}
1.55      www      2903:     </font>&nbsp;
1.54      www      2904: </td>
                   2905: </tr>
                   2906: <tr><td bgcolor="$tabbg" align="right">
1.146     www      2907: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
1.54      www      2908: </td></tr>
1.55      www      2909: <tr>
1.148     www      2910: <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;</td></tr>
1.202     albertel 2911: </table><br />
1.54      www      2912: ENDBODY
1.182     matthew  2913: }
                   2914: 
                   2915: ###############################################
1.251     albertel 2916: ###############################################
                   2917: 
                   2918: =pod
                   2919: 
                   2920: =back
                   2921: 
                   2922: =head1 HTTP Helpers
                   2923: 
                   2924: =over 4
                   2925: 
                   2926: =item * &endbodytag()
                   2927: 
                   2928: Returns a uniform footer for LON-CAPA web pages.
                   2929: 
                   2930: Inputs: 
                   2931: 
                   2932: =over 4
                   2933: 
                   2934: =back
                   2935: 
                   2936: Returns: A uniform footer for LON-CAPA web pages.  
                   2937: 
                   2938: =cut
                   2939: 
                   2940: sub endbodytag {
                   2941:     my $endbodytag='</body>';
1.269     albertel 2942:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.251     albertel 2943:     return $endbodytag;
                   2944: }
                   2945: 
                   2946: ###############################################
1.182     matthew  2947: 
                   2948: =pod
                   2949: 
                   2950: =item get_users_function
                   2951: 
                   2952: Used by &bodytag to determine the current users primary role.
                   2953: Returns either 'student','coordinator','admin', or 'author'.
                   2954: 
                   2955: =cut
                   2956: 
                   2957: ###############################################
                   2958: sub get_users_function {
                   2959:     my $function = 'student';
1.258     albertel 2960:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  2961:         $function='coordinator';
                   2962:     }
1.258     albertel 2963:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  2964:         $function='admin';
                   2965:     }
1.258     albertel 2966:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  2967:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   2968:         $function='author';
                   2969:     }
                   2970:     return $function;
1.54      www      2971: }
1.99      www      2972: 
                   2973: ###############################################
                   2974: 
1.233     raeburn  2975: =pod
                   2976: 
1.274     raeburn  2977: =item check_user_status
                   2978: 
                   2979: Determines current status of supplied role for a
                   2980: specific user. Roles can be active, previous or future.
                   2981: 
                   2982: Inputs: 
                   2983: user's domain, user's username, course's domain,
                   2984: course's number, optional section/group.
                   2985: 
                   2986: Outputs:
                   2987: role status: active, previous or future. 
                   2988: 
                   2989: =cut
                   2990: 
                   2991: sub check_user_status {
                   2992:     my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;
                   2993:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   2994:     my @uroles = keys %userinfo;
                   2995:     my $srchstr;
                   2996:     my $active_chk = 'none';
                   2997:     if (@uroles > 0) {
                   2998:         if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {
                   2999:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   3000:         } else {
                   3001:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role;         }
                   3002:         if (grep/^$srchstr$/,@uroles) {
                   3003:             my $role_end = 0;
                   3004:             my $role_start = 0;
                   3005:             $active_chk = 'active';
                   3006:             if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {
                   3007:                 $role_end = $2;
                   3008:                 if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {
                   3009:                     $role_start = $3;
                   3010:                 }
                   3011:             }
                   3012:             if ($role_start > 0) {
                   3013:                 if (time < $role_start) {
                   3014:                     $active_chk = 'future';
                   3015:                 }
                   3016:             }
                   3017:             if ($role_end > 0) {
                   3018:                 if (time > $role_end) {
                   3019:                     $active_chk = 'previous';
                   3020:                 }
                   3021:             }
                   3022:         }
                   3023:     }
                   3024:     return $active_chk;
                   3025: }
                   3026: 
                   3027: ###############################################
                   3028: 
                   3029: =pod
                   3030: 
1.233     raeburn  3031: =item get_sections
                   3032: 
                   3033: Determines all the sections for a course including
                   3034: sections with students and sections containing other roles.
                   3035: Incoming parameters: domain, course number, reference to 
                   3036: section hash (keys to be section/group IDs), reference to 
                   3037: array containing roles for which sections should be gathered
                   3038: (optional). If the fourth argument is undefined, sections
                   3039: are gathered for any role.
                   3040:  
                   3041: Returns number of sections.
                   3042: 
                   3043: =cut
                   3044: 
                   3045: ###############################################
                   3046: sub get_sections {
                   3047:     my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
1.240     albertel 3048:     if (!($cdom && $cnum)) { return 0; }
1.233     raeburn  3049:     my $numsections = 0;
1.240     albertel 3050: 
                   3051:     if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
1.276     albertel 3052: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 3053: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   3054: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
                   3055: 	while (my ($student,$data) = each %$classlist) {
                   3056: 	    my ($section,$status) = ($data->[$sec_index],
                   3057: 				     $data->[$status_index]);
                   3058: 	    unless ($section eq '-1' || $section =~ /^\s*$/) {
                   3059: 		if (!defined($$sectioncount{$section})) { $numsections++; }
                   3060: 		$$sectioncount{$section}++;
                   3061: 	    }
                   3062: 	}
                   3063:     }
                   3064:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   3065:     foreach my $user (sort(keys(%courseroles))) {
                   3066: 	if ($user !~ /^(\w{2})/) { next; }
                   3067: 	my ($role) = ($user =~ /^(\w{2})/);
                   3068: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
                   3069: 	my $section;
                   3070: 	if ($role eq 'cr' &&
                   3071: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   3072: 	    $section=$1;
                   3073: 	}
                   3074: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   3075: 	if (!defined($section) || $section eq '-1') { next; }
                   3076: 	if (!defined($$sectioncount{$section})) { $numsections++; } 
                   3077: 	$$sectioncount{$section}++;
1.233     raeburn  3078:     }
                   3079:     return $numsections;
                   3080: }
                   3081: 
1.274     raeburn  3082: ###############################################
                   3083: 
1.275     raeburn  3084: =pod
                   3085:                                                                                 
                   3086: =item get_course_users
                   3087:                                                                                 
                   3088: Retrieves usernames:domains for users in the specified course
                   3089: with specific role(s), and access status. 
                   3090: 
                   3091: Incoming parameters:
1.277     albertel 3092: 1. course domain
                   3093: 2. course number
                   3094: 3. access status: users must have - either active, 
1.275     raeburn  3095: previous, future, or all.
1.277     albertel 3096: 4. reference to array of permissible roles
                   3097: 5. reference to results object (hash of hashes).
1.275     raeburn  3098: Keys of top level hash are roles.
                   3099: Keys of inner hashes are username:domain, with 
                   3100: values set to access type.
                   3101:                                                                                 
                   3102: =cut
                   3103:                                                                                 
                   3104: ###############################################
                   3105:                                                                                 
                   3106: sub get_course_users {
1.277     albertel 3107:     my ($cdom,$cnum,$types,$roles,$users) = @_;
1.275     raeburn  3108:     if (grep/^st$/,@{$roles}) {
1.277     albertel 3109:         my $statusidx = &Apache::loncoursedata::CL_STATUS();
                   3110:         my $startidx = &Apache::loncoursedata::CL_START();
                   3111:         my $endidx = &Apache::loncoursedata::CL_END();
1.276     albertel 3112:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  3113:         my $now = time;
1.277     albertel 3114:         foreach my $student (keys(%{$classlist})) {
1.275     raeburn  3115:             if (defined($$types{'active'})) {
                   3116:                 if ($$classlist{$student}[$statusidx] eq 'Active') {
                   3117:                     push(@{$$users{st}{$student}},'active');
                   3118:                 }
                   3119:             }
                   3120:             if (defined($$types{'previous'})) {
1.278     raeburn  3121:                 if ($$classlist{$student}[$endidx] <= $now) {
1.275     raeburn  3122:                     push(@{$$users{st}{$student}},'previous');
                   3123:                 }
                   3124:             }
                   3125:             if (defined($$types{'future'})) {
1.278     raeburn  3126:                 if (($$classlist{$student}[$startidx] > $now) && ($$classlist{$student}[$endidx] > $now) || ($$classlist{$student}[$endidx] == 0) || ($$classlist{$student}[$endidx] eq '')) {
1.275     raeburn  3127:                     push(@{$$users{st}{$student}},'future');
                   3128:                 }
                   3129:             }
                   3130:         }
                   3131:     }
                   3132:     if ((@{$roles} > 0) && (@{$roles} ne "st")) {
                   3133:         my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
                   3134:         foreach my $person (@coursepersonnel) {
                   3135:             my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);
                   3136:             $user =~ s/:$//;
1.277     albertel 3137:             if (($role) && (grep(/^$role$/,@{$roles}))) {
                   3138:                 my ($uname,$udom) = split(/:/,$user);
1.275     raeburn  3139:                 if ($uname ne '' && $udom ne '') {
                   3140:                     my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);
1.277     albertel 3141:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  3142:                         if ($status eq $type) {
                   3143:                             $$users{$role}{$user} = $type;
                   3144:                         }
                   3145:                     }
                   3146:                 }
                   3147:             }
                   3148:         }
1.279     raeburn  3149:         if (grep/^ow$/,@{$roles}) {
                   3150:             if ((defined($cdom)) && (defined($cnum))) {
                   3151:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   3152:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   3153:                     my $owner = $csettings{'internal.courseowner'};
                   3154:                     $$users{'ow'}{$owner.':'.$cdom} = 'any';
                   3155:                 }
                   3156:             }
                   3157:         }
1.275     raeburn  3158:     }
                   3159:     return;
                   3160: }
                   3161: 
                   3162: 
                   3163: 
                   3164: ###############################################
1.233     raeburn  3165: 
1.99      www      3166: sub get_posted_cgi {
                   3167:     my $r=shift;
                   3168: 
                   3169:     my $buffer;
1.260     albertel 3170:     if ($r->header_in('Content-length')) {
                   3171: 	$r->read($buffer,$r->header_in('Content-length'),0);
                   3172:     }
1.99      www      3173:     unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
                   3174: 	my @pairs=split(/&/,$buffer);
                   3175: 	my $pair;
                   3176: 	foreach $pair (@pairs) {
                   3177: 	    my ($name,$value) = split(/=/,$pair);
                   3178: 	    $value =~ tr/+/ /;
                   3179: 	    $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
                   3180: 	    $name  =~ tr/+/ /;
                   3181: 	    $name  =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
                   3182: 	    &add_to_env("form.$name",$value);
                   3183: 	}
                   3184:     } else {
                   3185: 	my $contentsep=$1;
                   3186: 	my @lines = split (/\n/,$buffer);
                   3187: 	my $name='';
                   3188: 	my $value='';
                   3189: 	my $fname='';
                   3190: 	my $fmime='';
                   3191: 	my $i;
                   3192: 	for ($i=0;$i<=$#lines;$i++) {
                   3193: 	    if ($lines[$i]=~/^$contentsep/) {
                   3194: 		if ($name) {
                   3195: 		    chomp($value);
                   3196: 		    if ($fname) {
1.258     albertel 3197: 			$env{"form.$name.filename"}=$fname;
                   3198: 			$env{"form.$name.mimetype"}=$fmime;
1.99      www      3199: 		    } else {
                   3200: 			$value=~s/\s+$//s;
                   3201: 		    }
                   3202: 		    &add_to_env("form.$name",$value);
                   3203: 		}
                   3204: 		if ($i<$#lines) {
                   3205: 		    $i++;
                   3206: 		    $lines[$i]=~
                   3207: 		/Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
                   3208: 		    $name=$1;
                   3209: 		    $value='';
                   3210: 		    if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
                   3211: 			$fname=$1;
                   3212: 			if 
                   3213:                             ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
                   3214: 				$fmime=$1;
                   3215: 				$i++;
                   3216: 			    } else {
                   3217: 				$fmime='';
                   3218: 			    }
                   3219: 		    } else {
                   3220: 			$fname='';
                   3221: 			$fmime='';
                   3222: 		    }
                   3223: 		    $i++;
                   3224: 		}
                   3225: 	    } else {
                   3226: 		$value.=$lines[$i]."\n";
                   3227: 	    }
                   3228: 	}
                   3229:     }
1.258     albertel 3230:     $env{'request.method'}=$ENV{'REQUEST_METHOD'};
1.99      www      3231:     $r->method_number(M_GET);
                   3232:     $r->method('GET');
                   3233:     $r->headers_in->unset('Content-length');
                   3234: }
                   3235: 
1.112     bowersj2 3236: =pod
                   3237: 
                   3238: =item * get_unprocessed_cgi($query,$possible_names)
                   3239: 
1.258     albertel 3240: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 3241: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 3242: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 3243: 
                   3244: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   3245: $possible_names is an ref to an array of form element names.  As an example:
                   3246: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 3247: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 3248: 
                   3249: =cut
1.1       albertel 3250: 
1.6       albertel 3251: sub get_unprocessed_cgi {
1.25      albertel 3252:   my ($query,$possible_names)= @_;
1.26      matthew  3253:   # $Apache::lonxml::debug=1;
1.16      harris41 3254:   foreach (split(/&/,$query)) {
1.6       albertel 3255:     my ($name, $value) = split(/=/,$_);
1.25      albertel 3256:     $name = &Apache::lonnet::unescape($name);
                   3257:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   3258:       $value =~ tr/+/ /;
                   3259:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 3260:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 3261:     }
1.16      harris41 3262:   }
1.6       albertel 3263: }
                   3264: 
1.112     bowersj2 3265: =pod
                   3266: 
                   3267: =item * cacheheader() 
                   3268: 
                   3269: returns cache-controlling header code
                   3270: 
                   3271: =cut
                   3272: 
1.7       albertel 3273: sub cacheheader {
1.258     albertel 3274:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 3275:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   3276:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 3277:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   3278:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 3279:     return $output;
1.7       albertel 3280: }
                   3281: 
1.112     bowersj2 3282: =pod
                   3283: 
                   3284: =item * no_cache($r) 
                   3285: 
                   3286: specifies header code to not have cache
                   3287: 
                   3288: =cut
                   3289: 
1.9       albertel 3290: sub no_cache {
1.216     albertel 3291:     my ($r) = @_;
                   3292:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 3293: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 3294:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   3295:     $r->no_cache(1);
                   3296:     $r->header_out("Expires" => $date);
                   3297:     $r->header_out("Pragma" => "no-cache");
1.123     www      3298: }
                   3299: 
                   3300: sub content_type {
1.181     albertel 3301:     my ($r,$type,$charset) = @_;
1.258     albertel 3302:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 3303:     unless ($charset) {
                   3304: 	$charset=&Apache::lonlocal::current_encoding;
                   3305:     }
                   3306:     if ($charset) { $type.='; charset='.$charset; }
                   3307:     if ($r) {
                   3308: 	$r->content_type($type);
                   3309:     } else {
                   3310: 	print("Content-type: $type\n\n");
                   3311:     }
1.9       albertel 3312: }
1.25      albertel 3313: 
1.112     bowersj2 3314: =pod
                   3315: 
                   3316: =item * add_to_env($name,$value) 
                   3317: 
1.258     albertel 3318: adds $name to the %env hash with value
1.112     bowersj2 3319: $value, if $name already exists, the entry is converted to an array
                   3320: reference and $value is added to the array.
                   3321: 
                   3322: =cut
                   3323: 
1.25      albertel 3324: sub add_to_env {
                   3325:   my ($name,$value)=@_;
1.258     albertel 3326:   if (defined($env{$name})) {
                   3327:     if (ref($env{$name})) {
1.25      albertel 3328:       #already have multiple values
1.258     albertel 3329:       push(@{ $env{$name} },$value);
1.25      albertel 3330:     } else {
                   3331:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 3332:       my $first=$env{$name};
                   3333:       undef($env{$name});
                   3334:       push(@{ $env{$name} },$first,$value);
1.25      albertel 3335:     }
                   3336:   } else {
1.258     albertel 3337:     $env{$name}=$value;
1.25      albertel 3338:   }
1.31      albertel 3339: }
1.149     albertel 3340: 
                   3341: =pod
                   3342: 
                   3343: =item * get_env_multiple($name) 
                   3344: 
1.258     albertel 3345: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 3346: values may be defined and end up as an array ref.
                   3347: 
                   3348: returns an array of values
                   3349: 
                   3350: =cut
                   3351: 
                   3352: sub get_env_multiple {
                   3353:     my ($name) = @_;
                   3354:     my @values;
1.258     albertel 3355:     if (defined($env{$name})) {
1.149     albertel 3356:         # exists is it an array
1.258     albertel 3357:         if (ref($env{$name})) {
                   3358:             @values=@{ $env{$name} };
1.149     albertel 3359:         } else {
1.258     albertel 3360:             $values[0]=$env{$name};
1.149     albertel 3361:         }
                   3362:     }
                   3363:     return(@values);
                   3364: }
                   3365: 
1.31      albertel 3366: 
1.41      ng       3367: =pod
1.45      matthew  3368: 
                   3369: =back 
1.41      ng       3370: 
1.112     bowersj2 3371: =head1 CSV Upload/Handling functions
1.38      albertel 3372: 
1.41      ng       3373: =over 4
                   3374: 
1.112     bowersj2 3375: =item * upfile_store($r)
1.41      ng       3376: 
                   3377: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 3378: needs $env{'form.upfile'}
1.41      ng       3379: returns $datatoken to be put into hidden field
                   3380: 
                   3381: =cut
1.31      albertel 3382: 
                   3383: sub upfile_store {
                   3384:     my $r=shift;
1.258     albertel 3385:     $env{'form.upfile'}=~s/\r/\n/gs;
                   3386:     $env{'form.upfile'}=~s/\f/\n/gs;
                   3387:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   3388:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 3389: 
1.258     albertel 3390:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   3391: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 3392:     {
1.158     raeburn  3393:         my $datafile = $r->dir_config('lonDaemons').
                   3394:                            '/tmp/'.$datatoken.'.tmp';
                   3395:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 3396:             print $fh $env{'form.upfile'};
1.158     raeburn  3397:             close($fh);
                   3398:         }
1.31      albertel 3399:     }
                   3400:     return $datatoken;
                   3401: }
                   3402: 
1.56      matthew  3403: =pod
                   3404: 
1.112     bowersj2 3405: =item * load_tmp_file($r)
1.41      ng       3406: 
                   3407: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 3408: needs $env{'form.datatoken'},
                   3409: sets $env{'form.upfile'} to the contents of the file
1.41      ng       3410: 
                   3411: =cut
1.31      albertel 3412: 
                   3413: sub load_tmp_file {
                   3414:     my $r=shift;
                   3415:     my @studentdata=();
                   3416:     {
1.158     raeburn  3417:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 3418:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  3419:         if ( open(my $fh,"<$studentfile") ) {
                   3420:             @studentdata=<$fh>;
                   3421:             close($fh);
                   3422:         }
1.31      albertel 3423:     }
1.258     albertel 3424:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 3425: }
                   3426: 
1.56      matthew  3427: =pod
                   3428: 
1.112     bowersj2 3429: =item * upfile_record_sep()
1.41      ng       3430: 
                   3431: Separate uploaded file into records
                   3432: returns array of records,
1.258     albertel 3433: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       3434: 
                   3435: =cut
1.31      albertel 3436: 
                   3437: sub upfile_record_sep {
1.258     albertel 3438:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 3439:     } else {
1.248     albertel 3440: 	my @records;
1.258     albertel 3441: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 3442: 	    if ($line=~/^\s*$/) { next; }
                   3443: 	    push(@records,$line);
                   3444: 	}
                   3445: 	return @records;
1.31      albertel 3446:     }
                   3447: }
                   3448: 
1.56      matthew  3449: =pod
                   3450: 
1.112     bowersj2 3451: =item * record_sep($record)
1.41      ng       3452: 
1.258     albertel 3453: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       3454: 
                   3455: =cut
                   3456: 
1.263     www      3457: sub takeleft {
                   3458:     my $index=shift;
                   3459:     return substr('0000'.$index,-4,4);
                   3460: }
                   3461: 
1.31      albertel 3462: sub record_sep {
                   3463:     my $record=shift;
                   3464:     my %components=();
1.258     albertel 3465:     if ($env{'form.upfiletype'} eq 'xml') {
                   3466:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 3467:         my $i=0;
                   3468:         foreach (split(/\s+/,$record)) {
                   3469:             my $field=$_;
                   3470:             $field=~s/^(\"|\')//;
                   3471:             $field=~s/(\"|\')$//;
1.263     www      3472:             $components{&takeleft($i)}=$field;
1.31      albertel 3473:             $i++;
                   3474:         }
1.258     albertel 3475:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 3476:         my $i=0;
1.171     matthew  3477:         foreach (split(/\t/,$record)) {
1.31      albertel 3478:             my $field=$_;
                   3479:             $field=~s/^(\"|\')//;
                   3480:             $field=~s/(\"|\')$//;
1.263     www      3481:             $components{&takeleft($i)}=$field;
1.31      albertel 3482:             $i++;
                   3483:         }
                   3484:     } else {
                   3485:         my @allfields=split(/\,/,$record);
                   3486:         my $i=0;
                   3487:         my $j;
                   3488:         for ($j=0;$j<=$#allfields;$j++) {
                   3489:             my $field=$allfields[$j];
                   3490:             if ($field=~/^\s*(\"|\')/) {
                   3491: 		my $delimiter=$1;
                   3492:                 while (($field!~/$delimiter$/) && ($j<$#allfields)) {
                   3493: 		    $j++;
                   3494: 		    $field.=','.$allfields[$j];
                   3495: 		}
                   3496:                 $field=~s/^\s*$delimiter//;
                   3497:                 $field=~s/$delimiter\s*$//;
                   3498:             }
1.263     www      3499:             $components{&takeleft($i)}=$field;
1.31      albertel 3500: 	    $i++;
                   3501:         }
                   3502:     }
                   3503:     return %components;
                   3504: }
                   3505: 
1.144     matthew  3506: ######################################################
                   3507: ######################################################
                   3508: 
1.56      matthew  3509: =pod
                   3510: 
1.112     bowersj2 3511: =item * upfile_select_html()
1.41      ng       3512: 
1.144     matthew  3513: Return HTML code to select a file from the users machine and specify 
                   3514: the file type.
1.41      ng       3515: 
                   3516: =cut
                   3517: 
1.144     matthew  3518: ######################################################
                   3519: ######################################################
1.31      albertel 3520: sub upfile_select_html {
1.144     matthew  3521:     my %Types = (
                   3522:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
                   3523:                  space => &mt('Space separated'),
                   3524:                  tab   => &mt('Tabulator separated'),
                   3525: #                 xml   => &mt('HTML/XML'),
                   3526:                  );
                   3527:     my $Str = '<input type="file" name="upfile" size="50" />'.
                   3528:         '<br />Type: <select name="upfiletype">';
                   3529:     foreach my $type (sort(keys(%Types))) {
                   3530:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   3531:     }
                   3532:     $Str .= "</select>\n";
                   3533:     return $Str;
1.31      albertel 3534: }
                   3535: 
1.144     matthew  3536: ######################################################
                   3537: ######################################################
                   3538: 
1.56      matthew  3539: =pod
                   3540: 
1.112     bowersj2 3541: =item * csv_print_samples($r,$records)
1.41      ng       3542: 
                   3543: Prints a table of sample values from each column uploaded $r is an
                   3544: Apache Request ref, $records is an arrayref from
                   3545: &Apache::loncommon::upfile_record_sep
                   3546: 
                   3547: =cut
                   3548: 
1.144     matthew  3549: ######################################################
                   3550: ######################################################
1.31      albertel 3551: sub csv_print_samples {
                   3552:     my ($r,$records) = @_;
                   3553:     my (%sone,%stwo,%sthree);
                   3554:     %sone=&record_sep($$records[0]);
                   3555:     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
                   3556:     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144     matthew  3557:     #
                   3558:     $r->print(&mt('Samples').'<br /><table border="2"><tr>');
                   3559:     foreach (sort({$a <=> $b} keys(%sone))) { 
                   3560:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($_+1)).'</th>'); }
1.31      albertel 3561:     $r->print('</tr>');
                   3562:     foreach my $hash (\%sone,\%stwo,\%sthree) {
                   3563: 	$r->print('<tr>');
                   3564: 	foreach (sort({$a <=> $b} keys(%sone))) {
                   3565: 	    $r->print('<td>');
                   3566: 	    if (defined($$hash{$_})) { $r->print($$hash{$_}); }
                   3567: 	    $r->print('</td>');
                   3568: 	}
                   3569: 	$r->print('</tr>');
                   3570:     }
                   3571:     $r->print('</tr></table><br />'."\n");
                   3572: }
                   3573: 
1.144     matthew  3574: ######################################################
                   3575: ######################################################
                   3576: 
1.56      matthew  3577: =pod
                   3578: 
1.112     bowersj2 3579: =item * csv_print_select_table($r,$records,$d)
1.41      ng       3580: 
                   3581: Prints a table to create associations between values and table columns.
1.144     matthew  3582: 
1.41      ng       3583: $r is an Apache Request ref,
                   3584: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  3585: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       3586: 
                   3587: =cut
                   3588: 
1.144     matthew  3589: ######################################################
                   3590: ######################################################
1.31      albertel 3591: sub csv_print_select_table {
                   3592:     my ($r,$records,$d) = @_;
                   3593:     my $i=0;my %sone;
                   3594:     %sone=&record_sep($$records[0]);
1.144     matthew  3595:     $r->print(&mt('Associate columns with student attributes.')."\n".
                   3596: 	     '<table border="2"><tr>'.
                   3597:               '<th>'.&mt('Attribute').'</th>'.
                   3598:               '<th>'.&mt('Column').'</th></tr>'."\n");
1.31      albertel 3599:     foreach (@$d) {
1.174     matthew  3600: 	my ($value,$display,$defaultcol)=@{ $_ };
1.31      albertel 3601: 	$r->print('<tr><td>'.$display.'</td>');
                   3602: 
                   3603: 	$r->print('<td><select name=f'.$i.
1.32      matthew  3604: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 3605: 	$r->print('<option value="none"></option>');
                   3606: 	foreach (sort({$a <=> $b} keys(%sone))) {
1.174     matthew  3607: 	    $r->print('<option value="'.$_.'"'.
1.253     albertel 3608:                       ($_ eq $defaultcol ? ' selected="selected" ' : '').
1.174     matthew  3609:                       '>Column '.($_+1).'</option>');
1.31      albertel 3610: 	}
                   3611: 	$r->print('</select></td></tr>'."\n");
                   3612: 	$i++;
                   3613:     }
                   3614:     $i--;
                   3615:     return $i;
                   3616: }
1.56      matthew  3617: 
1.144     matthew  3618: ######################################################
                   3619: ######################################################
                   3620: 
1.56      matthew  3621: =pod
1.31      albertel 3622: 
1.112     bowersj2 3623: =item * csv_samples_select_table($r,$records,$d)
1.41      ng       3624: 
                   3625: Prints a table of sample values from the upload and can make associate samples to internal names.
                   3626: 
                   3627: $r is an Apache Request ref,
                   3628: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   3629: $d is an array of 2 element arrays (internal name, displayed name)
                   3630: 
                   3631: =cut
                   3632: 
1.144     matthew  3633: ######################################################
                   3634: ######################################################
1.31      albertel 3635: sub csv_samples_select_table {
                   3636:     my ($r,$records,$d) = @_;
                   3637:     my %sone; my %stwo; my %sthree;
                   3638:     my $i=0;
1.144     matthew  3639:     #
                   3640:     $r->print('<table border=2><tr><th>'.
                   3641:               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.31      albertel 3642:     %sone=&record_sep($$records[0]);
                   3643:     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
                   3644:     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144     matthew  3645:     #
1.31      albertel 3646:     foreach (sort keys %sone) {
1.144     matthew  3647: 	$r->print('<tr><td><select name="f'.$i.'"'.
1.32      matthew  3648: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 3649: 	foreach (@$d) {
1.174     matthew  3650: 	    my ($value,$display,$defaultcol)=@{ $_ };
                   3651: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 3652:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  3653:                       $display.'</option>');
1.31      albertel 3654: 	}
                   3655: 	$r->print('</select></td><td>');
1.263     www      3656: 	if (defined($sone{$_})) { $r->print($sone{$_}."<br />\n"); }
                   3657: 	if (defined($stwo{$_})) { $r->print($stwo{$_}."<br />\n"); }
                   3658: 	if (defined($sthree{$_})) { $r->print($sthree{$_}."<br />\n"); }
1.31      albertel 3659: 	$r->print('</td></tr>');
                   3660: 	$i++;
                   3661:     }
                   3662:     $i--;
                   3663:     return($i);
1.115     matthew  3664: }
                   3665: 
1.144     matthew  3666: ######################################################
                   3667: ######################################################
                   3668: 
1.115     matthew  3669: =pod
                   3670: 
                   3671: =item clean_excel_name($name)
                   3672: 
                   3673: Returns a replacement for $name which does not contain any illegal characters.
                   3674: 
                   3675: =cut
                   3676: 
1.144     matthew  3677: ######################################################
                   3678: ######################################################
1.115     matthew  3679: sub clean_excel_name {
                   3680:     my ($name) = @_;
                   3681:     $name =~ s/[:\*\?\/\\]//g;
                   3682:     if (length($name) > 31) {
                   3683:         $name = substr($name,0,31);
                   3684:     }
                   3685:     return $name;
1.25      albertel 3686: }
1.84      albertel 3687: 
1.85      albertel 3688: =pod
                   3689: 
1.112     bowersj2 3690: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 3691: 
                   3692: Returns either 1 or undef
                   3693: 
                   3694: 1 if the part is to be hidden, undef if it is to be shown
                   3695: 
                   3696: Arguments are:
                   3697: 
                   3698: $id the id of the part to be checked
                   3699: $symb, optional the symb of the resource to check
                   3700: $udom, optional the domain of the user to check for
                   3701: $uname, optional the username of the user to check for
                   3702: 
                   3703: =cut
1.84      albertel 3704: 
                   3705: sub check_if_partid_hidden {
                   3706:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 3707:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 3708: 					 $symb,$udom,$uname);
1.141     albertel 3709:     my $truth=1;
                   3710:     #if the string starts with !, then the list is the list to show not hide
                   3711:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 3712:     my @hiddenlist=split(/,/,$hiddenparts);
                   3713:     foreach my $checkid (@hiddenlist) {
1.141     albertel 3714: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 3715:     }
1.141     albertel 3716:     return !$truth;
1.84      albertel 3717: }
1.127     matthew  3718: 
1.138     matthew  3719: 
                   3720: ############################################################
                   3721: ############################################################
                   3722: 
                   3723: =pod
                   3724: 
1.157     matthew  3725: =back 
                   3726: 
1.138     matthew  3727: =head1 cgi-bin script and graphing routines
                   3728: 
1.157     matthew  3729: =over 4
                   3730: 
1.138     matthew  3731: =item get_cgi_id
                   3732: 
                   3733: Inputs: none
                   3734: 
                   3735: Returns an id which can be used to pass environment variables
                   3736: to various cgi-bin scripts.  These environment variables will
                   3737: be removed from the users environment after a given time by
                   3738: the routine &Apache::lonnet::transfer_profile_to_env.
                   3739: 
                   3740: =cut
                   3741: 
                   3742: ############################################################
                   3743: ############################################################
1.152     albertel 3744: my $uniq=0;
1.136     matthew  3745: sub get_cgi_id {
1.154     albertel 3746:     $uniq=($uniq+1)%100000;
1.280     albertel 3747:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  3748: }
                   3749: 
1.127     matthew  3750: ############################################################
                   3751: ############################################################
                   3752: 
                   3753: =pod
                   3754: 
1.134     matthew  3755: =item DrawBarGraph
1.127     matthew  3756: 
1.138     matthew  3757: Facilitates the plotting of data in a (stacked) bar graph.
                   3758: Puts plot definition data into the users environment in order for 
                   3759: graph.png to plot it.  Returns an <img> tag for the plot.
                   3760: The bars on the plot are labeled '1','2',...,'n'.
                   3761: 
                   3762: Inputs:
                   3763: 
                   3764: =over 4
                   3765: 
                   3766: =item $Title: string, the title of the plot
                   3767: 
                   3768: =item $xlabel: string, text describing the X-axis of the plot
                   3769: 
                   3770: =item $ylabel: string, text describing the Y-axis of the plot
                   3771: 
                   3772: =item $Max: scalar, the maximum Y value to use in the plot
                   3773: If $Max is < any data point, the graph will not be rendered.
                   3774: 
1.140     matthew  3775: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  3776: they are plotted.  If undefined, default values will be used.
                   3777: 
1.178     matthew  3778: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   3779: 
1.138     matthew  3780: =item @Values: An array of array references.  Each array reference holds data
                   3781: to be plotted in a stacked bar chart.
                   3782: 
1.239     matthew  3783: =item If the final element of @Values is a hash reference the key/value
                   3784: pairs will be added to the graph definition.
                   3785: 
1.138     matthew  3786: =back
                   3787: 
                   3788: Returns:
                   3789: 
                   3790: An <img> tag which references graph.png and the appropriate identifying
                   3791: information for the plot.
                   3792: 
1.127     matthew  3793: =cut
                   3794: 
                   3795: ############################################################
                   3796: ############################################################
1.134     matthew  3797: sub DrawBarGraph {
1.178     matthew  3798:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  3799:     #
                   3800:     if (! defined($colors)) {
                   3801:         $colors = ['#33ff00', 
                   3802:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   3803:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   3804:                   ]; 
                   3805:     }
1.228     matthew  3806:     my $extra_settings = {};
                   3807:     if (ref($Values[-1]) eq 'HASH') {
                   3808:         $extra_settings = pop(@Values);
                   3809:     }
1.127     matthew  3810:     #
1.136     matthew  3811:     my $identifier = &get_cgi_id();
                   3812:     my $id = 'cgi.'.$identifier;        
1.129     matthew  3813:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  3814:         return '';
                   3815:     }
1.225     matthew  3816:     #
                   3817:     my @Labels;
                   3818:     if (defined($labels)) {
                   3819:         @Labels = @$labels;
                   3820:     } else {
                   3821:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   3822:             push (@Labels,$i+1);
                   3823:         }
                   3824:     }
                   3825:     #
1.129     matthew  3826:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  3827:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  3828:     my %ValuesHash;
                   3829:     my $NumSets=1;
                   3830:     foreach my $array (@Values) {
                   3831:         next if (! ref($array));
1.136     matthew  3832:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  3833:             join(',',@$array);
1.129     matthew  3834:     }
1.127     matthew  3835:     #
1.136     matthew  3836:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  3837:     if ($NumBars < 3) {
                   3838:         $width = 120+$NumBars*32;
1.220     matthew  3839:         $xskip = 1;
1.225     matthew  3840:         $bar_width = 30;
                   3841:     } elsif ($NumBars < 5) {
                   3842:         $width = 120+$NumBars*20;
                   3843:         $xskip = 1;
                   3844:         $bar_width = 20;
1.220     matthew  3845:     } elsif ($NumBars < 10) {
1.136     matthew  3846:         $width = 120+$NumBars*15;
                   3847:         $xskip = 1;
                   3848:         $bar_width = 15;
                   3849:     } elsif ($NumBars <= 25) {
                   3850:         $width = 120+$NumBars*11;
                   3851:         $xskip = 5;
                   3852:         $bar_width = 8;
                   3853:     } elsif ($NumBars <= 50) {
                   3854:         $width = 120+$NumBars*8;
                   3855:         $xskip = 5;
                   3856:         $bar_width = 4;
                   3857:     } else {
                   3858:         $width = 120+$NumBars*8;
                   3859:         $xskip = 5;
                   3860:         $bar_width = 4;
                   3861:     }
                   3862:     #
1.137     matthew  3863:     $Max = 1 if ($Max < 1);
                   3864:     if ( int($Max) < $Max ) {
                   3865:         $Max++;
                   3866:         $Max = int($Max);
                   3867:     }
1.127     matthew  3868:     $Title  = '' if (! defined($Title));
                   3869:     $xlabel = '' if (! defined($xlabel));
                   3870:     $ylabel = '' if (! defined($ylabel));
1.136     matthew  3871:     $ValuesHash{$id.'.title'}    = &Apache::lonnet::escape($Title);
                   3872:     $ValuesHash{$id.'.xlabel'}   = &Apache::lonnet::escape($xlabel);
                   3873:     $ValuesHash{$id.'.ylabel'}   = &Apache::lonnet::escape($ylabel);
1.137     matthew  3874:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  3875:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   3876:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   3877:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   3878:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   3879:     $ValuesHash{$id.'.height'}   = $height;
                   3880:     $ValuesHash{$id.'.width'}    = $width;
                   3881:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   3882:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   3883:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  3884:     #
1.228     matthew  3885:     # Deal with other parameters
                   3886:     while (my ($key,$value) = each(%$extra_settings)) {
                   3887:         $ValuesHash{$id.'.'.$key} = $value;
                   3888:     }
                   3889:     #
1.137     matthew  3890:     &Apache::lonnet::appenv(%ValuesHash);
                   3891:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   3892: }
                   3893: 
                   3894: ############################################################
                   3895: ############################################################
                   3896: 
                   3897: =pod
                   3898: 
                   3899: =item DrawXYGraph
                   3900: 
1.138     matthew  3901: Facilitates the plotting of data in an XY graph.
                   3902: Puts plot definition data into the users environment in order for 
                   3903: graph.png to plot it.  Returns an <img> tag for the plot.
                   3904: 
                   3905: Inputs:
                   3906: 
                   3907: =over 4
                   3908: 
                   3909: =item $Title: string, the title of the plot
                   3910: 
                   3911: =item $xlabel: string, text describing the X-axis of the plot
                   3912: 
                   3913: =item $ylabel: string, text describing the Y-axis of the plot
                   3914: 
                   3915: =item $Max: scalar, the maximum Y value to use in the plot
                   3916: If $Max is < any data point, the graph will not be rendered.
                   3917: 
                   3918: =item $colors: Array ref containing the hex color codes for the data to be 
                   3919: plotted in.  If undefined, default values will be used.
                   3920: 
                   3921: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   3922: 
                   3923: =item $Ydata: Array ref containing Array refs.  
1.185     www      3924: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  3925: 
                   3926: =item %Values: hash indicating or overriding any default values which are 
                   3927: passed to graph.png.  
                   3928: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   3929: 
                   3930: =back
                   3931: 
                   3932: Returns:
                   3933: 
                   3934: An <img> tag which references graph.png and the appropriate identifying
                   3935: information for the plot.
                   3936: 
1.137     matthew  3937: =cut
                   3938: 
                   3939: ############################################################
                   3940: ############################################################
                   3941: sub DrawXYGraph {
                   3942:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   3943:     #
                   3944:     # Create the identifier for the graph
                   3945:     my $identifier = &get_cgi_id();
                   3946:     my $id = 'cgi.'.$identifier;
                   3947:     #
                   3948:     $Title  = '' if (! defined($Title));
                   3949:     $xlabel = '' if (! defined($xlabel));
                   3950:     $ylabel = '' if (! defined($ylabel));
                   3951:     my %ValuesHash = 
                   3952:         (
                   3953:          $id.'.title'  => &Apache::lonnet::escape($Title),
                   3954:          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
                   3955:          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
                   3956:          $id.'.y_max_value'=> $Max,
                   3957:          $id.'.labels'     => join(',',@$Xlabels),
                   3958:          $id.'.PlotType'   => 'XY',
                   3959:          );
                   3960:     #
                   3961:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   3962:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   3963:     }
                   3964:     #
                   3965:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   3966:         return '';
                   3967:     }
                   3968:     my $NumSets=1;
1.138     matthew  3969:     foreach my $array (@{$Ydata}){
1.137     matthew  3970:         next if (! ref($array));
                   3971:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   3972:     }
1.138     matthew  3973:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  3974:     #
                   3975:     # Deal with other parameters
                   3976:     while (my ($key,$value) = each(%Values)) {
                   3977:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  3978:     }
                   3979:     #
1.136     matthew  3980:     &Apache::lonnet::appenv(%ValuesHash);
                   3981:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   3982: }
                   3983: 
                   3984: ############################################################
                   3985: ############################################################
                   3986: 
                   3987: =pod
                   3988: 
1.138     matthew  3989: =item DrawXYYGraph
                   3990: 
                   3991: Facilitates the plotting of data in an XY graph with two Y axes.
                   3992: Puts plot definition data into the users environment in order for 
                   3993: graph.png to plot it.  Returns an <img> tag for the plot.
                   3994: 
                   3995: Inputs:
                   3996: 
                   3997: =over 4
                   3998: 
                   3999: =item $Title: string, the title of the plot
                   4000: 
                   4001: =item $xlabel: string, text describing the X-axis of the plot
                   4002: 
                   4003: =item $ylabel: string, text describing the Y-axis of the plot
                   4004: 
                   4005: =item $colors: Array ref containing the hex color codes for the data to be 
                   4006: plotted in.  If undefined, default values will be used.
                   4007: 
                   4008: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   4009: 
                   4010: =item $Ydata1: The first data set
                   4011: 
                   4012: =item $Min1: The minimum value of the left Y-axis
                   4013: 
                   4014: =item $Max1: The maximum value of the left Y-axis
                   4015: 
                   4016: =item $Ydata2: The second data set
                   4017: 
                   4018: =item $Min2: The minimum value of the right Y-axis
                   4019: 
                   4020: =item $Max2: The maximum value of the left Y-axis
                   4021: 
                   4022: =item %Values: hash indicating or overriding any default values which are 
                   4023: passed to graph.png.  
                   4024: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   4025: 
                   4026: =back
                   4027: 
                   4028: Returns:
                   4029: 
                   4030: An <img> tag which references graph.png and the appropriate identifying
                   4031: information for the plot.
1.136     matthew  4032: 
                   4033: =cut
                   4034: 
                   4035: ############################################################
                   4036: ############################################################
1.137     matthew  4037: sub DrawXYYGraph {
                   4038:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   4039:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  4040:     #
                   4041:     # Create the identifier for the graph
                   4042:     my $identifier = &get_cgi_id();
                   4043:     my $id = 'cgi.'.$identifier;
                   4044:     #
                   4045:     $Title  = '' if (! defined($Title));
                   4046:     $xlabel = '' if (! defined($xlabel));
                   4047:     $ylabel = '' if (! defined($ylabel));
                   4048:     my %ValuesHash = 
                   4049:         (
                   4050:          $id.'.title'  => &Apache::lonnet::escape($Title),
                   4051:          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
                   4052:          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
                   4053:          $id.'.labels' => join(',',@$Xlabels),
                   4054:          $id.'.PlotType' => 'XY',
                   4055:          $id.'.NumSets' => 2,
1.137     matthew  4056:          $id.'.two_axes' => 1,
                   4057:          $id.'.y1_max_value' => $Max1,
                   4058:          $id.'.y1_min_value' => $Min1,
                   4059:          $id.'.y2_max_value' => $Max2,
                   4060:          $id.'.y2_min_value' => $Min2,
1.136     matthew  4061:          );
                   4062:     #
1.137     matthew  4063:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   4064:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   4065:     }
                   4066:     #
                   4067:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   4068:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  4069:         return '';
                   4070:     }
                   4071:     my $NumSets=1;
1.137     matthew  4072:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  4073:         next if (! ref($array));
                   4074:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  4075:     }
                   4076:     #
                   4077:     # Deal with other parameters
                   4078:     while (my ($key,$value) = each(%Values)) {
                   4079:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  4080:     }
                   4081:     #
                   4082:     &Apache::lonnet::appenv(%ValuesHash);
1.130     albertel 4083:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  4084: }
                   4085: 
                   4086: ############################################################
                   4087: ############################################################
                   4088: 
                   4089: =pod
                   4090: 
1.157     matthew  4091: =back 
                   4092: 
1.139     matthew  4093: =head1 Statistics helper routines?  
                   4094: 
                   4095: Bad place for them but what the hell.
                   4096: 
1.157     matthew  4097: =over 4
                   4098: 
1.139     matthew  4099: =item &chartlink
                   4100: 
                   4101: Returns a link to the chart for a specific student.  
                   4102: 
                   4103: Inputs:
                   4104: 
                   4105: =over 4
                   4106: 
                   4107: =item $linktext: The text of the link
                   4108: 
                   4109: =item $sname: The students username
                   4110: 
                   4111: =item $sdomain: The students domain
                   4112: 
                   4113: =back
                   4114: 
1.157     matthew  4115: =back
                   4116: 
1.139     matthew  4117: =cut
                   4118: 
                   4119: ############################################################
                   4120: ############################################################
                   4121: sub chartlink {
                   4122:     my ($linktext, $sname, $sdomain) = @_;
                   4123:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.219     albertel 4124:         '&amp;SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
                   4125:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  4126:        '">'.$linktext.'</a>';
1.153     matthew  4127: }
                   4128: 
                   4129: #######################################################
                   4130: #######################################################
                   4131: 
                   4132: =pod
                   4133: 
                   4134: =head1 Course Environment Routines
1.157     matthew  4135: 
                   4136: =over 4
1.153     matthew  4137: 
                   4138: =item &restore_course_settings 
                   4139: 
                   4140: =item &store_course_settings
                   4141: 
                   4142: Restores/Store indicated form parameters from the course environment.
                   4143: Will not overwrite existing values of the form parameters.
                   4144: 
                   4145: Inputs: 
                   4146: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   4147: 
                   4148: a hash ref describing the data to be stored.  For example:
                   4149:    
                   4150: %Save_Parameters = ('Status' => 'scalar',
                   4151:     'chartoutputmode' => 'scalar',
                   4152:     'chartoutputdata' => 'scalar',
                   4153:     'Section' => 'array',
                   4154:     'StudentData' => 'array',
                   4155:     'Maps' => 'array');
                   4156: 
                   4157: Returns: both routines return nothing
                   4158: 
                   4159: =cut
                   4160: 
                   4161: #######################################################
                   4162: #######################################################
                   4163: sub store_course_settings {
                   4164:     # save to the environment
                   4165:     # appenv the same items, just to be safe
1.258     albertel 4166:     my $courseid = $env{'request.course.id'};
                   4167:     my $coursedom = $env{'course.'.$courseid.'.domain'};
1.153     matthew  4168:     my ($prefix,$Settings) = @_;
                   4169:     my %SaveHash;
                   4170:     my %AppHash;
                   4171:     while (my ($setting,$type) = each(%$Settings)) {
1.176     albertel 4172:         my $basename = 'internal.'.$prefix.'.'.$setting;
1.153     matthew  4173:         my $envname = 'course.'.$courseid.'.'.$basename;
1.258     albertel 4174:         if (exists($env{'form.'.$setting})) {
1.153     matthew  4175:             # Save this value away
                   4176:             if ($type eq 'scalar' &&
1.258     albertel 4177:                 (! exists($env{$envname}) || 
                   4178:                  $env{$envname} ne $env{'form.'.$setting})) {
                   4179:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   4180:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  4181:             } elsif ($type eq 'array') {
                   4182:                 my $stored_form;
1.258     albertel 4183:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  4184:                     $stored_form = join(',',
                   4185:                                         map {
                   4186:                                             &Apache::lonnet::escape($_);
1.258     albertel 4187:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  4188:                 } else {
                   4189:                     $stored_form = 
1.258     albertel 4190:                         &Apache::lonnet::escape($env{'form.'.$setting});
1.153     matthew  4191:                 }
                   4192:                 # Determine if the array contents are the same.
1.258     albertel 4193:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  4194:                     $SaveHash{$basename} = $stored_form;
                   4195:                     $AppHash{$envname}   = $stored_form;
                   4196:                 }
                   4197:             }
                   4198:         }
                   4199:     }
                   4200:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
                   4201:                                           $coursedom,
1.258     albertel 4202:                                           $env{'course.'.$courseid.'.num'});
1.153     matthew  4203:     if ($put_result !~ /^(ok|delayed)/) {
                   4204:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   4205:                                  'got error:'.$put_result);
                   4206:     }
                   4207:     # Make sure these settings stick around in this session, too
                   4208:     &Apache::lonnet::appenv(%AppHash);
                   4209:     return;
                   4210: }
                   4211: 
                   4212: sub restore_course_settings {
1.258     albertel 4213:     my $courseid = $env{'request.course.id'};
1.153     matthew  4214:     my ($prefix,$Settings) = @_;
                   4215:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 4216:         next if (exists($env{'form.'.$setting}));
1.176     albertel 4217:         my $envname = 'course.'.$courseid.'.internal.'.$prefix.
1.153     matthew  4218:             '.'.$setting;
1.258     albertel 4219:         if (exists($env{$envname})) {
1.153     matthew  4220:             if ($type eq 'scalar') {
1.258     albertel 4221:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  4222:             } elsif ($type eq 'array') {
1.258     albertel 4223:                 $env{'form.'.$setting} = [ 
1.153     matthew  4224:                                            map { 
                   4225:                                                &Apache::lonnet::unescape($_); 
1.258     albertel 4226:                                            } split(',',$env{$envname})
1.153     matthew  4227:                                            ];
                   4228:             }
                   4229:         }
                   4230:     }
1.127     matthew  4231: }
                   4232: 
                   4233: ############################################################
                   4234: ############################################################
1.154     albertel 4235: 
                   4236: sub propath {
                   4237:     my ($udom,$uname)=@_;
                   4238:     $udom=~s/\W//g;
                   4239:     $uname=~s/\W//g;
                   4240:     my $subdir=$uname.'__';
                   4241:     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   4242:     my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
                   4243:     return $proname;
1.156     albertel 4244: } 
                   4245: 
                   4246: sub icon {
                   4247:     my ($file)=@_;
1.168     albertel 4248:     my $curfext = (split(/\./,$file))[-1];
                   4249:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 4250:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 4251:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   4252: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   4253: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   4254: 	            $curfext.".gif") {
                   4255: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   4256: 		$curfext.".gif";
                   4257: 	}
                   4258:     }
1.249     albertel 4259:     return &lonhttpdurl($iconname);
1.154     albertel 4260: } 
1.84      albertel 4261: 
1.215     albertel 4262: sub lonhttpdurl {
                   4263:     my ($url)=@_;
                   4264:     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   4265:     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
                   4266:     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
                   4267: }
                   4268: 
1.213     albertel 4269: sub connection_aborted {
                   4270:     my ($r)=@_;
                   4271:     $r->print(" ");$r->rflush();
                   4272:     my $c = $r->connection;
                   4273:     return $c->aborted();
                   4274: }
                   4275: 
1.221     foxr     4276: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     4277: #    strings as 'strings'.
                   4278: sub escape_single {
1.221     foxr     4279:     my ($input) = @_;
1.223     albertel 4280:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     4281:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   4282:     return $input;
                   4283: }
1.223     albertel 4284: 
1.222     foxr     4285: #  Same as escape_single, but escape's "'s  This 
                   4286: #  can be used for  "strings"
                   4287: sub escape_double {
                   4288:     my ($input) = @_;
                   4289:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   4290:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   4291:     return $input;
                   4292: }
1.223     albertel 4293:  
1.222     foxr     4294: #   Escapes the last element of a full URL.
                   4295: sub escape_url {
                   4296:     my ($url)   = @_;
1.238     raeburn  4297:     my @urlslices = split(/\//, $url,-1);
1.223     albertel 4298:     my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
                   4299:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     4300: }
1.41      ng       4301: =pod
                   4302: 
                   4303: =back
                   4304: 
1.112     bowersj2 4305: =cut
1.41      ng       4306: 
1.112     bowersj2 4307: 1;
                   4308: __END__;
1.41      ng       4309: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>