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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.280   ! albertel    4: # $Id: loncommon.pm,v 1.279 2005/10/13 22:37:40 raeburn 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: 
                   1158: sub multiple_select_form {
1.191     matthew  1159:     my ($name,$value,$size,%hash)=@_;
1.169     www      1160:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1161:     my $output='';
1.191     matthew  1162:     if (! defined($size)) {
                   1163:         $size = 4;
                   1164:         if (scalar(keys(%hash))<4) {
                   1165:             $size = scalar(keys(%hash));
                   1166:         }
                   1167:     }
1.169     www      1168:     $output.="\n<select name='$name' size='$size' multiple='1'>";
1.191     matthew  1169:     foreach (sort(keys(%hash))) {
                   1170:         $output.='<option value="'.$_.'" ';
1.253     albertel 1171:         $output.='selected="selected" ' if ($selected{$_});
1.191     matthew  1172:         $output.='>'.$hash{$_}."</option>\n";
1.169     www      1173:     }
                   1174:     $output.="</select>\n";
                   1175:     return $output;
                   1176: }
                   1177: 
1.88      www      1178: #-------------------------------------------
                   1179: 
                   1180: =pod
                   1181: 
1.112     bowersj2 1182: =item * select_form($defdom,$name,%hash)
1.88      www      1183: 
                   1184: Returns a string containing a <select name='$name' size='1'> form to 
                   1185: allow a user to select options from a hash option_name => displayed text.  
                   1186: See lonrights.pm for an example invocation and use.
                   1187: 
                   1188: =cut
                   1189: 
                   1190: #-------------------------------------------
                   1191: sub select_form {
                   1192:     my ($def,$name,%hash) = @_;
                   1193:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1194:     my @keys;
                   1195:     if (exists($hash{'select_form_order'})) {
                   1196: 	@keys=@{$hash{'select_form_order'}};
                   1197:     } else {
                   1198: 	@keys=sort(keys(%hash));
                   1199:     }
                   1200:     foreach (@keys) {
1.88      www      1201:         $selectform.="<option value=\"$_\" ".
1.253     albertel 1202:             ($_ eq $def ? 'selected="selected" ' : '').
1.119     www      1203:                 ">".&mt($hash{$_})."</option>\n";
1.88      www      1204:     }
                   1205:     $selectform.="</select>";
                   1206:     return $selectform;
                   1207: }
                   1208: 
1.167     www      1209: sub gradeleveldescription {
                   1210:     my $gradelevel=shift;
                   1211:     my %gradelevels=(0 => 'Not specified',
                   1212: 		     1 => 'Grade 1',
                   1213: 		     2 => 'Grade 2',
                   1214: 		     3 => 'Grade 3',
                   1215: 		     4 => 'Grade 4',
                   1216: 		     5 => 'Grade 5',
                   1217: 		     6 => 'Grade 6',
                   1218: 		     7 => 'Grade 7',
                   1219: 		     8 => 'Grade 8',
                   1220: 		     9 => 'Grade 9',
                   1221: 		     10 => 'Grade 10',
                   1222: 		     11 => 'Grade 11',
                   1223: 		     12 => 'Grade 12',
                   1224: 		     13 => 'Grade 13',
                   1225: 		     14 => '100 Level',
                   1226: 		     15 => '200 Level',
                   1227: 		     16 => '300 Level',
                   1228: 		     17 => '400 Level',
                   1229: 		     18 => 'Graduate Level');
                   1230:     return &mt($gradelevels{$gradelevel});
                   1231: }
                   1232: 
1.163     www      1233: sub select_level_form {
                   1234:     my ($deflevel,$name)=@_;
                   1235:     unless ($deflevel) { $deflevel=0; }
1.167     www      1236:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1237:     for (my $i=0; $i<=18; $i++) {
                   1238:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1239:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1240:                 ">".&gradeleveldescription($i)."</option>\n";
                   1241:     }
                   1242:     $selectform.="</select>";
                   1243:     return $selectform;
1.163     www      1244: }
1.167     www      1245: 
1.35      matthew  1246: #-------------------------------------------
                   1247: 
1.45      matthew  1248: =pod
                   1249: 
1.112     bowersj2 1250: =item * select_dom_form($defdom,$name,$includeempty)
1.35      matthew  1251: 
                   1252: Returns a string containing a <select name='$name' size='1'> form to 
                   1253: allow a user to select the domain to preform an operation in.  
                   1254: See loncreateuser.pm for an example invocation and use.
                   1255: 
1.90      www      1256: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1257: selected");
                   1258: 
1.35      matthew  1259: =cut
                   1260: 
                   1261: #-------------------------------------------
1.34      matthew  1262: sub select_dom_form {
1.90      www      1263:     my ($defdom,$name,$includeempty) = @_;
1.34      matthew  1264:     my @domains = get_domains();
1.90      www      1265:     if ($includeempty) { @domains=('',@domains); }
1.34      matthew  1266:     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
                   1267:     foreach (@domains) {
                   1268:         $selectdomain.="<option value=\"$_\" ".
1.253     albertel 1269:             ($_ eq $defdom ? 'selected="selected" ' : '').
1.34      matthew  1270:                 ">$_</option>\n";
                   1271:     }
                   1272:     $selectdomain.="</select>";
                   1273:     return $selectdomain;
                   1274: }
                   1275: 
1.35      matthew  1276: #-------------------------------------------
                   1277: 
1.45      matthew  1278: =pod
                   1279: 
1.112     bowersj2 1280: =item * get_library_servers($domain)
1.35      matthew  1281: 
                   1282: Returns a hash which contains keys like '103l3' and values like 
                   1283: 'kirk.lite.msu.edu'.  All of the keys will be for machines in the
                   1284: given $domain.
                   1285: 
                   1286: =cut
                   1287: 
                   1288: #-------------------------------------------
1.52      matthew  1289: sub get_library_servers {
1.33      matthew  1290:     my $domain = shift;
1.52      matthew  1291:     my %library_servers;
1.33      matthew  1292:     foreach (keys(%Apache::lonnet::libserv)) {
                   1293:         if ($Apache::lonnet::hostdom{$_} eq $domain) {
1.52      matthew  1294:             $library_servers{$_} = $Apache::lonnet::hostname{$_};
1.33      matthew  1295:         }
                   1296:     }
1.52      matthew  1297:     return %library_servers;
1.33      matthew  1298: }
                   1299: 
1.35      matthew  1300: #-------------------------------------------
                   1301: 
1.45      matthew  1302: =pod
                   1303: 
1.112     bowersj2 1304: =item * home_server_option_list($domain)
1.35      matthew  1305: 
                   1306: returns a string which contains an <option> list to be used in a 
                   1307: <select> form input.  See loncreateuser.pm for an example.
                   1308: 
                   1309: =cut
                   1310: 
                   1311: #-------------------------------------------
1.33      matthew  1312: sub home_server_option_list {
                   1313:     my $domain = shift;
1.52      matthew  1314:     my %servers = &get_library_servers($domain);
1.33      matthew  1315:     my $result = '';
                   1316:     foreach (sort keys(%servers)) {
                   1317:         $result.=
                   1318:             '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
                   1319:     }
                   1320:     return $result;
                   1321: }
1.112     bowersj2 1322: 
                   1323: =pod
                   1324: 
                   1325: =back
                   1326: 
                   1327: =cut
1.87      matthew  1328: 
                   1329: ###############################################################
1.112     bowersj2 1330: ##                  Decoding User Agent                      ##
1.87      matthew  1331: ###############################################################
                   1332: 
                   1333: =pod
                   1334: 
1.112     bowersj2 1335: =head1 Decoding the User Agent
                   1336: 
                   1337: =over 4
                   1338: 
                   1339: =item * &decode_user_agent()
1.87      matthew  1340: 
                   1341: Inputs: $r
                   1342: 
                   1343: Outputs:
                   1344: 
                   1345: =over 4
                   1346: 
1.112     bowersj2 1347: =item * $httpbrowser
1.87      matthew  1348: 
1.112     bowersj2 1349: =item * $clientbrowser
1.87      matthew  1350: 
1.112     bowersj2 1351: =item * $clientversion
1.87      matthew  1352: 
1.112     bowersj2 1353: =item * $clientmathml
1.87      matthew  1354: 
1.112     bowersj2 1355: =item * $clientunicode
1.87      matthew  1356: 
1.112     bowersj2 1357: =item * $clientos
1.87      matthew  1358: 
                   1359: =back
                   1360: 
1.157     matthew  1361: =back 
                   1362: 
1.87      matthew  1363: =cut
                   1364: 
                   1365: ###############################################################
                   1366: ###############################################################
                   1367: sub decode_user_agent {
1.247     albertel 1368:     my ($r)=@_;
1.87      matthew  1369:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1370:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1371:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1372:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1373:     my $clientbrowser='unknown';
                   1374:     my $clientversion='0';
                   1375:     my $clientmathml='';
                   1376:     my $clientunicode='0';
                   1377:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1378:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1379: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1380: 	    $clientbrowser=$bname;
                   1381:             $httpbrowser=~/$vreg/i;
                   1382: 	    $clientversion=$1;
                   1383:             $clientmathml=($clientversion>=$minv);
                   1384:             $clientunicode=($clientversion>=$univ);
                   1385: 	}
                   1386:     }
                   1387:     my $clientos='unknown';
                   1388:     if (($httpbrowser=~/linux/i) ||
                   1389:         ($httpbrowser=~/unix/i) ||
                   1390:         ($httpbrowser=~/ux/i) ||
                   1391:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1392:     if (($httpbrowser=~/vax/i) ||
                   1393:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1394:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1395:     if (($httpbrowser=~/mac/i) ||
                   1396:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1397:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1398:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1399:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1400:             $clientunicode,$clientos,);
                   1401: }
                   1402: 
1.32      matthew  1403: ###############################################################
                   1404: ##    Authentication changing form generation subroutines    ##
                   1405: ###############################################################
                   1406: ##
                   1407: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1408: ## hash, and have reasonable default values.
                   1409: ##
                   1410: ##    formname = the name given in the <form> tag.
1.35      matthew  1411: #-------------------------------------------
                   1412: 
1.45      matthew  1413: =pod
                   1414: 
1.112     bowersj2 1415: =head1 Authentication Routines
                   1416: 
                   1417: =over 4
                   1418: 
                   1419: =item * authform_xxxxxx
1.35      matthew  1420: 
                   1421: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1422: handle some of the conveniences required for authentication forms.  
                   1423: This is not an optimal method, but it works.  
                   1424: 
                   1425: See loncreateuser.pm for invocation and use examples.
                   1426: 
                   1427: =over 4
                   1428: 
1.112     bowersj2 1429: =item * authform_header
1.35      matthew  1430: 
1.112     bowersj2 1431: =item * authform_authorwarning
1.35      matthew  1432: 
1.112     bowersj2 1433: =item * authform_nochange
1.35      matthew  1434: 
1.112     bowersj2 1435: =item * authform_kerberos
1.35      matthew  1436: 
1.112     bowersj2 1437: =item * authform_internal
1.35      matthew  1438: 
1.112     bowersj2 1439: =item * authform_filesystem
1.35      matthew  1440: 
                   1441: =back
                   1442: 
1.157     matthew  1443: =back 
                   1444: 
1.35      matthew  1445: =cut
                   1446: 
                   1447: #-------------------------------------------
1.32      matthew  1448: sub authform_header{  
                   1449:     my %in = (
                   1450:         formname => 'cu',
1.80      albertel 1451:         kerb_def_dom => '',
1.32      matthew  1452:         @_,
                   1453:     );
                   1454:     $in{'formname'} = 'document.' . $in{'formname'};
                   1455:     my $result='';
1.80      albertel 1456: 
                   1457: #---------------------------------------------- Code for upper case translation
                   1458:     my $Javascript_toUpperCase;
                   1459:     unless ($in{kerb_def_dom}) {
                   1460:         $Javascript_toUpperCase =<<"END";
                   1461:         switch (choice) {
                   1462:            case 'krb': currentform.elements[choicearg].value =
                   1463:                currentform.elements[choicearg].value.toUpperCase();
                   1464:                break;
                   1465:            default:
                   1466:         }
                   1467: END
                   1468:     } else {
                   1469:         $Javascript_toUpperCase = "";
                   1470:     }
                   1471: 
1.165     raeburn  1472:     my $radioval = "'nochange'";
1.174     matthew  1473:     if (exists($in{'curr_authtype'}) &&
                   1474:         defined($in{'curr_authtype'}) &&
                   1475:         $in{'curr_authtype'} ne '') {
                   1476:         $radioval = "'$in{'curr_authtype'}arg'";
                   1477:     }
1.165     raeburn  1478:     my $argfield = 'null';
                   1479:     if ( grep/^mode$/,(keys %in) ) {
                   1480:         if ($in{'mode'} eq 'modifycourse')  {
                   1481:             if ( grep/^curr_authtype$/,(keys %in) ) {
                   1482:                 $radioval = "'$in{'curr_authtype'}'";
                   1483:             }
                   1484:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1485:                 unless ($in{'curr_autharg'} eq '') {
                   1486:                     $argfield = "'$in{'curr_autharg'}'";
                   1487:                 }
                   1488:             }
                   1489:         }
                   1490:     }
                   1491: 
1.32      matthew  1492:     $result.=<<"END";
                   1493: var current = new Object();
1.165     raeburn  1494: current.radiovalue = $radioval;
                   1495: current.argfield = $argfield;
1.32      matthew  1496: 
                   1497: function changed_radio(choice,currentform) {
                   1498:     var choicearg = choice + 'arg';
                   1499:     // If a radio button in changed, we need to change the argfield
                   1500:     if (current.radiovalue != choice) {
                   1501:         current.radiovalue = choice;
                   1502:         if (current.argfield != null) {
                   1503:             currentform.elements[current.argfield].value = '';
                   1504:         }
                   1505:         if (choice == 'nochange') {
                   1506:             current.argfield = null;
                   1507:         } else {
                   1508:             current.argfield = choicearg;
                   1509:             switch(choice) {
                   1510:                 case 'krb': 
                   1511:                     currentform.elements[current.argfield].value = 
                   1512:                         "$in{'kerb_def_dom'}";
                   1513:                 break;
                   1514:               default:
                   1515:                 break;
                   1516:             }
                   1517:         }
                   1518:     }
                   1519:     return;
                   1520: }
1.22      www      1521: 
1.32      matthew  1522: function changed_text(choice,currentform) {
                   1523:     var choicearg = choice + 'arg';
                   1524:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 1525:         $Javascript_toUpperCase
1.32      matthew  1526:         // clear old field
                   1527:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   1528:             currentform.elements[current.argfield].value = '';
                   1529:         }
                   1530:         current.argfield = choicearg;
                   1531:     }
                   1532:     set_auth_radio_buttons(choice,currentform);
                   1533:     return;
1.20      www      1534: }
1.32      matthew  1535: 
                   1536: function set_auth_radio_buttons(newvalue,currentform) {
                   1537:     var i=0;
                   1538:     while (i < currentform.login.length) {
                   1539:         if (currentform.login[i].value == newvalue) { break; }
                   1540:         i++;
                   1541:     }
                   1542:     if (i == currentform.login.length) {
                   1543:         return;
                   1544:     }
                   1545:     current.radiovalue = newvalue;
                   1546:     currentform.login[i].checked = true;
                   1547:     return;
                   1548: }
                   1549: END
                   1550:     return $result;
                   1551: }
                   1552: 
                   1553: sub authform_authorwarning{
                   1554:     my $result='';
1.144     matthew  1555:     $result='<i>'.
                   1556:         &mt('As a general rule, only authors or co-authors should be '.
                   1557:             'filesystem authenticated '.
                   1558:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  1559:     return $result;
                   1560: }
                   1561: 
                   1562: sub authform_nochange{  
                   1563:     my %in = (
                   1564:               formname => 'document.cu',
                   1565:               kerb_def_dom => 'MSU.EDU',
                   1566:               @_,
                   1567:           );
1.144     matthew  1568:     my $result = &mt('[_1] Do not change login data',
                   1569:                      '<input type="radio" name="login" value="nochange" '.
                   1570:                      'checked="checked" onclick="'.
                   1571:             "javascript:changed_radio('nochange',$in{'formname'});".'" />');
1.32      matthew  1572:     return $result;
                   1573: }
                   1574: 
                   1575: sub authform_kerberos{  
                   1576:     my %in = (
                   1577:               formname => 'document.cu',
                   1578:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 1579:               kerb_def_auth => 'krb4',
1.32      matthew  1580:               @_,
                   1581:               );
1.165     raeburn  1582:     my ($check4,$check5,$krbarg);
1.80      albertel 1583:     if ($in{'kerb_def_auth'} eq 'krb5') {
                   1584:        $check5 = " checked=\"on\"";
                   1585:     } else {
                   1586:        $check4 = " checked=\"on\"";
                   1587:     }
1.165     raeburn  1588:     $krbarg = $in{'kerb_def_dom'};
                   1589: 
                   1590:     my $krbcheck = "";
                   1591:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1592:         if ($in{'curr_authtype'} =~ m/^krb/) {
                   1593:             $krbcheck = " checked=\"on\"";
                   1594:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1595:                 $krbarg = $in{'curr_autharg'};
                   1596:             }
                   1597:         }
                   1598:     }
                   1599: 
1.144     matthew  1600:     my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   1601:     my $result .= &mt
                   1602:         ('[_1] Kerberos authenticated with domain [_2] '.
                   1603:          '[_3] Version 4 [_4] Version 5',
                   1604:          '<input type="radio" name="login" value="krb" '.
1.165     raeburn  1605:              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.144     matthew  1606:          '<input type="text" size="10" name="krbarg" '.
1.165     raeburn  1607:              'value="'.$krbarg.'" '.
1.144     matthew  1608:              'onchange="'.$jscall.'" />',
                   1609:          '<input type="radio" name="krbver" value="4" '.$check4.' />',
                   1610:          '<input type="radio" name="krbver" value="5" '.$check5.' />');
1.32      matthew  1611:     return $result;
                   1612: }
                   1613: 
                   1614: sub authform_internal{  
                   1615:     my %args = (
                   1616:                 formname => 'document.cu',
                   1617:                 kerb_def_dom => 'MSU.EDU',
                   1618:                 @_,
                   1619:                 );
1.165     raeburn  1620: 
                   1621:     my $intcheck = "";
                   1622:     my $intarg = 'value=""';
                   1623:     if ( grep/^curr_authtype$/,(keys %args) ) {
                   1624:         if ($args{'curr_authtype'} eq 'int') {
                   1625:             $intcheck = " checked=\"on\"";
                   1626:             if ( grep/^curr_autharg$/,(keys %args) ) {
                   1627:                 $intarg = "value=\"$args{'curr_autharg'}\"";
                   1628:             }
                   1629:         }
                   1630:     }
                   1631: 
1.144     matthew  1632:     my $jscall = "javascript:changed_radio('int',$args{'formname'});";
                   1633:     my $result.=&mt
                   1634:         ('[_1] Internally authenticated (with initial password [_2])',
1.165     raeburn  1635:          '<input type="radio" name="login" value="int" '.$intcheck.
                   1636:              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
                   1637:          '<input type="text" size="10" name="intarg" '.$intarg.
                   1638:              ' onchange="'.$jscall.'" />');
1.32      matthew  1639:     return $result;
                   1640: }
                   1641: 
                   1642: sub authform_local{  
                   1643:     my %in = (
                   1644:               formname => 'document.cu',
                   1645:               kerb_def_dom => 'MSU.EDU',
                   1646:               @_,
                   1647:               );
1.165     raeburn  1648: 
                   1649:     my $loccheck = "";
                   1650:     my $locarg = 'value=""';
                   1651:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1652:         if ($in{'curr_authtype'} eq 'loc') {
                   1653:             $loccheck = " checked=\"on\"";
                   1654:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1655:                 $locarg = "value=\"$in{'curr_autharg'}\"";
                   1656:             }
                   1657:         }
                   1658:     }
                   1659: 
1.144     matthew  1660:     my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160     matthew  1661:     my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.165     raeburn  1662:                     '<input type="radio" name="login" value="loc" '.$loccheck.
                   1663:                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
                   1664:                     '<input type="text" size="10" name="locarg" '.$locarg.
                   1665:                         ' onchange="'.$jscall.'" />');
1.32      matthew  1666:     return $result;
                   1667: }
                   1668: 
                   1669: sub authform_filesystem{  
                   1670:     my %in = (
                   1671:               formname => 'document.cu',
                   1672:               kerb_def_dom => 'MSU.EDU',
                   1673:               @_,
                   1674:               );
1.144     matthew  1675:     my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   1676:     my $result.= &mt
                   1677:         ('[_1] Filesystem Authenticated (with initial password [_2])',
                   1678:          '<input type="radio" name="login" value="fsys" '.
                   1679:          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
                   1680:          '<input type="text" size="10" name="fsysarg" value="" '.
                   1681:                   'onchange="'.$jscall.'" />');
1.32      matthew  1682:     return $result;
                   1683: }
                   1684: 
1.80      albertel 1685: ###############################################################
                   1686: ##    Get Authentication Defaults for Domain                 ##
                   1687: ###############################################################
                   1688: 
                   1689: =pod
                   1690: 
1.112     bowersj2 1691: =head1 Domains and Authentication
                   1692: 
                   1693: Returns default authentication type and an associated argument as
                   1694: listed in file 'domain.tab'.
                   1695: 
                   1696: =over 4
                   1697: 
                   1698: =item * get_auth_defaults
1.80      albertel 1699: 
                   1700: get_auth_defaults($target_domain) returns the default authentication
                   1701: type and an associated argument (initial password or a kerberos domain).
                   1702: These values are stored in lonTabs/domain.tab
                   1703: 
                   1704: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
                   1705: 
                   1706: If target_domain is not found in domain.tab, returns nothing ('').
                   1707: 
                   1708: =cut
                   1709: 
                   1710: #-------------------------------------------
                   1711: sub get_auth_defaults {
                   1712:     my $domain=shift;
                   1713:     return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
                   1714: }
                   1715: ###############################################################
                   1716: ##   End Get Authentication Defaults for Domain              ##
                   1717: ###############################################################
                   1718: 
                   1719: ###############################################################
                   1720: ##    Get Kerberos Defaults for Domain                 ##
                   1721: ###############################################################
                   1722: ##
                   1723: ## Returns default kerberos version and an associated argument
                   1724: ## as listed in file domain.tab. If not listed, provides
                   1725: ## appropriate default domain and kerberos version.
                   1726: ##
                   1727: #-------------------------------------------
                   1728: 
                   1729: =pod
                   1730: 
1.112     bowersj2 1731: =item * get_kerberos_defaults
1.80      albertel 1732: 
                   1733: get_kerberos_defaults($target_domain) returns the default kerberos
                   1734: version and domain. If not found in domain.tabs, it defaults to
                   1735: version 4 and the domain of the server.
                   1736: 
                   1737: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   1738: 
                   1739: =cut
                   1740: 
                   1741: #-------------------------------------------
                   1742: sub get_kerberos_defaults {
                   1743:     my $domain=shift;
                   1744:     my ($krbdef,$krbdefdom) =
                   1745:         &Apache::loncommon::get_auth_defaults($domain);
                   1746:     unless ($krbdef =~/^krb/ && $krbdefdom) {
                   1747:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   1748:         my $krbdefdom=$1;
                   1749:         $krbdefdom=~tr/a-z/A-Z/;
                   1750:         $krbdef = "krb4";
                   1751:     }
                   1752:     return ($krbdef,$krbdefdom);
                   1753: }
1.112     bowersj2 1754: 
                   1755: =pod
                   1756: 
                   1757: =back
                   1758: 
                   1759: =cut
1.32      matthew  1760: 
1.46      matthew  1761: ###############################################################
                   1762: ##                Thesaurus Functions                        ##
                   1763: ###############################################################
1.20      www      1764: 
1.46      matthew  1765: =pod
1.20      www      1766: 
1.112     bowersj2 1767: =head1 Thesaurus Functions
                   1768: 
                   1769: =over 4
                   1770: 
                   1771: =item * initialize_keywords
1.46      matthew  1772: 
                   1773: Initializes the package variable %Keywords if it is empty.  Uses the
                   1774: package variable $thesaurus_db_file.
                   1775: 
                   1776: =cut
                   1777: 
                   1778: ###################################################
                   1779: 
                   1780: sub initialize_keywords {
                   1781:     return 1 if (scalar keys(%Keywords));
                   1782:     # If we are here, %Keywords is empty, so fill it up
                   1783:     #   Make sure the file we need exists...
                   1784:     if (! -e $thesaurus_db_file) {
                   1785:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   1786:                                  " failed because it does not exist");
                   1787:         return 0;
                   1788:     }
                   1789:     #   Set up the hash as a database
                   1790:     my %thesaurus_db;
                   1791:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1792:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1793:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   1794:                                  $thesaurus_db_file);
                   1795:         return 0;
                   1796:     } 
                   1797:     #  Get the average number of appearances of a word.
                   1798:     my $avecount = $thesaurus_db{'average.count'};
                   1799:     #  Put keywords (those that appear > average) into %Keywords
                   1800:     while (my ($word,$data)=each (%thesaurus_db)) {
                   1801:         my ($count,undef) = split /:/,$data;
                   1802:         $Keywords{$word}++ if ($count > $avecount);
                   1803:     }
                   1804:     untie %thesaurus_db;
                   1805:     # Remove special values from %Keywords.
                   1806:     foreach ('total.count','average.count') {
                   1807:         delete($Keywords{$_}) if (exists($Keywords{$_}));
                   1808:     }
                   1809:     return 1;
                   1810: }
                   1811: 
                   1812: ###################################################
                   1813: 
                   1814: =pod
                   1815: 
1.112     bowersj2 1816: =item * keyword($word)
1.46      matthew  1817: 
                   1818: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   1819: than the average number of times in the thesaurus database.  Calls 
                   1820: &initialize_keywords
                   1821: 
                   1822: =cut
                   1823: 
                   1824: ###################################################
1.20      www      1825: 
                   1826: sub keyword {
1.46      matthew  1827:     return if (!&initialize_keywords());
                   1828:     my $word=lc(shift());
                   1829:     $word=~s/\W//g;
                   1830:     return exists($Keywords{$word});
1.20      www      1831: }
1.46      matthew  1832: 
                   1833: ###############################################################
                   1834: 
                   1835: =pod 
1.20      www      1836: 
1.112     bowersj2 1837: =item * get_related_words
1.46      matthew  1838: 
1.160     matthew  1839: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  1840: an array of words.  If the keyword is not in the thesaurus, an empty array
                   1841: will be returned.  The order of the words returned is determined by the
                   1842: database which holds them.
                   1843: 
                   1844: Uses global $thesaurus_db_file.
                   1845: 
                   1846: =cut
                   1847: 
                   1848: ###############################################################
                   1849: sub get_related_words {
                   1850:     my $keyword = shift;
                   1851:     my %thesaurus_db;
                   1852:     if (! -e $thesaurus_db_file) {
                   1853:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   1854:                                  "failed because the file does not exist");
                   1855:         return ();
                   1856:     }
                   1857:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1858:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1859:         return ();
                   1860:     } 
                   1861:     my @Words=();
                   1862:     if (exists($thesaurus_db{$keyword})) {
                   1863:         $_ = $thesaurus_db{$keyword};
                   1864:         (undef,@Words) = split/:/;  # The first element is the number of times
                   1865:                                     # the word appears.  We do not need it now.
                   1866:         for (my $i=0;$i<=$#Words;$i++) {
                   1867:             ($Words[$i],undef)= split/\,/,$Words[$i];
1.20      www      1868:         }
                   1869:     }
1.46      matthew  1870:     untie %thesaurus_db;
                   1871:     return @Words;
1.14      harris41 1872: }
1.46      matthew  1873: 
1.112     bowersj2 1874: =pod
                   1875: 
                   1876: =back
                   1877: 
                   1878: =cut
1.61      www      1879: 
                   1880: # -------------------------------------------------------------- Plaintext name
1.81      albertel 1881: =pod
                   1882: 
1.112     bowersj2 1883: =head1 User Name Functions
                   1884: 
                   1885: =over 4
                   1886: 
1.226     albertel 1887: =item * plainname($uname,$udom,$first)
1.81      albertel 1888: 
1.112     bowersj2 1889: Takes a users logon name and returns it as a string in
1.226     albertel 1890: "first middle last generation" form 
                   1891: if $first is set to 'lastname' then it returns it as
                   1892: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 1893: 
                   1894: =cut
1.61      www      1895: 
1.81      albertel 1896: ###############################################################
1.61      www      1897: sub plainname {
1.226     albertel 1898:     my ($uname,$udom,$first)=@_;
1.61      www      1899:     my %names=&Apache::lonnet::get('environment',
                   1900:                     ['firstname','middlename','lastname','generation'],
                   1901: 					 $udom,$uname);
1.226     albertel 1902:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   1903: 					  $names{'middlename'},
                   1904: 					  $names{'lastname'},
                   1905: 					  $names{'generation'},$first);
                   1906:     $name=~s/^\s+//;
1.62      www      1907:     $name=~s/\s+$//;
                   1908:     $name=~s/\s+/ /g;
1.190     albertel 1909:     if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
1.62      www      1910:     return $name;
1.61      www      1911: }
1.66      www      1912: 
                   1913: # -------------------------------------------------------------------- Nickname
1.81      albertel 1914: =pod
                   1915: 
1.112     bowersj2 1916: =item * nickname($uname,$udom)
1.81      albertel 1917: 
                   1918: Gets a users name and returns it as a string as
                   1919: 
                   1920: "&quot;nickname&quot;"
1.66      www      1921: 
1.81      albertel 1922: if the user has a nickname or
                   1923: 
                   1924: "first middle last generation"
                   1925: 
                   1926: if the user does not
                   1927: 
                   1928: =cut
1.66      www      1929: 
                   1930: sub nickname {
                   1931:     my ($uname,$udom)=@_;
1.212     albertel 1932:     my %names;
1.258     albertel 1933:     if ($uname eq $env{'user.name'} &&
                   1934: 	$udom eq $env{'user.domain'}) {
                   1935: 	%names=('nickname'   => $env{'environment.nickname'}  ,
                   1936: 		'firstname'  => $env{'environment.firstname'} ,
                   1937: 		'middlename' => $env{'environment.middlename'},
                   1938: 		'lastname'   => $env{'environment.lastname'}  ,
                   1939: 		'generation' => $env{'environment.generation'});
1.212     albertel 1940:     } else {
                   1941: 	%names=&Apache::lonnet::get('environment',
                   1942: 				    ['nickname','firstname','middlename',
                   1943: 				     'lastname','generation'],$udom,$uname);
                   1944:     }
1.68      albertel 1945:     my $name=$names{'nickname'};
1.66      www      1946:     if ($name) {
                   1947:        $name='&quot;'.$name.'&quot;'; 
                   1948:     } else {
                   1949:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   1950: 	     $names{'lastname'}.' '.$names{'generation'};
                   1951:        $name=~s/\s+$//;
                   1952:        $name=~s/\s+/ /g;
                   1953:     }
                   1954:     return $name;
                   1955: }
                   1956: 
1.61      www      1957: 
                   1958: # ------------------------------------------------------------------ Screenname
1.81      albertel 1959: 
                   1960: =pod
                   1961: 
1.112     bowersj2 1962: =item * screenname($uname,$udom)
1.81      albertel 1963: 
                   1964: Gets a users screenname and returns it as a string
                   1965: 
                   1966: =cut
1.61      www      1967: 
                   1968: sub screenname {
                   1969:     my ($uname,$udom)=@_;
1.258     albertel 1970:     if ($uname eq $env{'user.name'} &&
                   1971: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 1972:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 1973:     return $names{'screenname'};
1.62      www      1974: }
                   1975: 
1.212     albertel 1976: 
1.62      www      1977: # ------------------------------------------------------------- Message Wrapper
                   1978: 
                   1979: sub messagewrapper {
1.200     matthew  1980:     my ($link,$username,$domain)=@_;
1.62      www      1981:     return 
1.200     matthew  1982:         '<a href="/adm/email?compose=individual&'.
                   1983:         'recname='.$username.'&recdom='.$domain.'" '.
                   1984:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      1985: }
                   1986: # --------------------------------------------------------------- Notes Wrapper
                   1987: 
                   1988: sub noteswrapper {
                   1989:     my ($link,$un,$do)=@_;
                   1990:     return 
                   1991: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      1992: }
                   1993: # ------------------------------------------------------------- Aboutme Wrapper
                   1994: 
                   1995: sub aboutmewrapper {
1.166     www      1996:     my ($link,$username,$domain,$target)=@_;
1.205     www      1997:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.200     matthew  1998: 	($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
1.62      www      1999: }
                   2000: 
                   2001: # ------------------------------------------------------------ Syllabus Wrapper
                   2002: 
                   2003: 
                   2004: sub syllabuswrapper {
1.109     matthew  2005:     my ($linktext,$coursedir,$domain,$fontcolor)=@_;
                   2006:     if ($fontcolor) { 
                   2007:         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
                   2008:     }
1.208     matthew  2009:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2010: }
1.14      harris41 2011: 
1.208     matthew  2012: sub track_student_link {
1.268     albertel 2013:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2014:     my $link ="/adm/trackstudent?";
1.208     matthew  2015:     my $title = 'View recent activity';
                   2016:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2017:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2018:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2019:         $title .= ' of this student';
1.268     albertel 2020:     } 
1.208     matthew  2021:     if (defined($target) && $target !~ /^\s*$/) {
                   2022:         $target = qq{target="$target"};
                   2023:     } else {
                   2024:         $target = '';
                   2025:     }
1.268     albertel 2026:     if ($start) { $link.='&amp;start='.$start; }
1.208     matthew  2027:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2028: }
                   2029: 
1.112     bowersj2 2030: =pod
                   2031: 
                   2032: =back
                   2033: 
                   2034: =head1 Access .tab File Data
                   2035: 
                   2036: =over 4
                   2037: 
                   2038: =item * languageids() 
                   2039: 
                   2040: returns list of all language ids
                   2041: 
                   2042: =cut
                   2043: 
1.14      harris41 2044: sub languageids {
1.16      harris41 2045:     return sort(keys(%language));
1.14      harris41 2046: }
                   2047: 
1.112     bowersj2 2048: =pod
                   2049: 
                   2050: =item * languagedescription() 
                   2051: 
                   2052: returns description of a specified language id
                   2053: 
                   2054: =cut
                   2055: 
1.14      harris41 2056: sub languagedescription {
1.125     www      2057:     my $code=shift;
                   2058:     return  ($supported_language{$code}?'* ':'').
                   2059:             $language{$code}.
1.126     www      2060: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2061: }
                   2062: 
                   2063: sub plainlanguagedescription {
                   2064:     my $code=shift;
                   2065:     return $language{$code};
                   2066: }
                   2067: 
                   2068: sub supportedlanguagecode {
                   2069:     my $code=shift;
                   2070:     return $supported_language{$code};
1.97      www      2071: }
                   2072: 
1.112     bowersj2 2073: =pod
                   2074: 
                   2075: =item * copyrightids() 
                   2076: 
                   2077: returns list of all copyrights
                   2078: 
                   2079: =cut
                   2080: 
                   2081: sub copyrightids {
                   2082:     return sort(keys(%cprtag));
                   2083: }
                   2084: 
                   2085: =pod
                   2086: 
                   2087: =item * copyrightdescription() 
                   2088: 
                   2089: returns description of a specified copyright id
                   2090: 
                   2091: =cut
                   2092: 
                   2093: sub copyrightdescription {
1.166     www      2094:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2095: }
1.197     matthew  2096: 
                   2097: =pod
                   2098: 
1.192     taceyjo1 2099: =item * source_copyrightids() 
                   2100: 
                   2101: returns list of all source copyrights
                   2102: 
                   2103: =cut
                   2104: 
                   2105: sub source_copyrightids {
                   2106:     return sort(keys(%scprtag));
                   2107: }
                   2108: 
                   2109: =pod
                   2110: 
                   2111: =item * source_copyrightdescription() 
                   2112: 
                   2113: returns description of a specified source copyright id
                   2114: 
                   2115: =cut
                   2116: 
                   2117: sub source_copyrightdescription {
                   2118:     return &mt($scprtag{shift(@_)});
                   2119: }
1.112     bowersj2 2120: 
                   2121: =pod
                   2122: 
                   2123: =item * filecategories() 
                   2124: 
                   2125: returns list of all file categories
                   2126: 
                   2127: =cut
                   2128: 
                   2129: sub filecategories {
                   2130:     return sort(keys(%category_extensions));
                   2131: }
                   2132: 
                   2133: =pod
                   2134: 
                   2135: =item * filecategorytypes() 
                   2136: 
                   2137: returns list of file types belonging to a given file
                   2138: category
                   2139: 
                   2140: =cut
                   2141: 
                   2142: sub filecategorytypes {
                   2143:     return @{$category_extensions{lc($_[0])}};
                   2144: }
                   2145: 
                   2146: =pod
                   2147: 
                   2148: =item * fileembstyle() 
                   2149: 
                   2150: returns embedding style for a specified file type
                   2151: 
                   2152: =cut
                   2153: 
                   2154: sub fileembstyle {
                   2155:     return $fe{lc(shift(@_))};
1.169     www      2156: }
                   2157: 
                   2158: 
                   2159: sub filecategoryselect {
                   2160:     my ($name,$value)=@_;
1.189     matthew  2161:     return &select_form($value,$name,
1.169     www      2162: 			'' => &mt('Any category'),
                   2163: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 2164: }
                   2165: 
                   2166: =pod
                   2167: 
                   2168: =item * filedescription() 
                   2169: 
                   2170: returns description for a specified file type
                   2171: 
                   2172: =cut
                   2173: 
                   2174: sub filedescription {
1.188     matthew  2175:     my $file_description = $fd{lc(shift())};
                   2176:     $file_description =~ s:([\[\]]):~$1:g;
                   2177:     return &mt($file_description);
1.112     bowersj2 2178: }
                   2179: 
                   2180: =pod
                   2181: 
                   2182: =item * filedescriptionex() 
                   2183: 
                   2184: returns description for a specified file type with
                   2185: extra formatting
                   2186: 
                   2187: =cut
                   2188: 
                   2189: sub filedescriptionex {
                   2190:     my $ex=shift;
1.188     matthew  2191:     my $file_description = $fd{lc($ex)};
                   2192:     $file_description =~ s:([\[\]]):~$1:g;
                   2193:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 2194: }
                   2195: 
                   2196: # End of .tab access
                   2197: =pod
                   2198: 
                   2199: =back
                   2200: 
                   2201: =cut
                   2202: 
                   2203: # ------------------------------------------------------------------ File Types
                   2204: sub fileextensions {
                   2205:     return sort(keys(%fe));
                   2206: }
                   2207: 
1.97      www      2208: # ----------------------------------------------------------- Display Languages
                   2209: # returns a hash with all desired display languages
                   2210: #
                   2211: 
                   2212: sub display_languages {
                   2213:     my %languages=();
1.118     www      2214:     foreach (&preferred_languages()) {
                   2215: 	$languages{$_}=1;
1.97      www      2216:     }
                   2217:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 2218:     if ($env{'form.displaylanguage'}) {
                   2219: 	foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
1.97      www      2220: 	    $languages{$_}=1;
                   2221:         }
                   2222:     }
                   2223:     return %languages;
1.14      harris41 2224: }
                   2225: 
1.117     www      2226: sub preferred_languages {
                   2227:     my @languages=();
1.258     albertel 2228:     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117     www      2229: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258     albertel 2230: 	         $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177     www      2231:     }
1.258     albertel 2232:     if ($env{'environment.languages'}) {
                   2233: 	@languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
1.118     www      2234:     }
1.162     www      2235:     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
                   2236:     if ($browser) {
                   2237: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
                   2238:     }
1.258     albertel 2239:     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
1.118     www      2240: 	@languages=(@languages,
1.258     albertel 2241: 		$Apache::lonnet::domain_lang_def{$env{'user.domain'}});
1.118     www      2242:     }
1.258     albertel 2243:     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
1.118     www      2244: 	@languages=(@languages,
1.258     albertel 2245: 		$Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
1.118     www      2246:     }
                   2247:     if ($Apache::lonnet::domain_lang_def{
                   2248: 	                          $Apache::lonnet::perlvar{'lonDefDomain'}}) {
                   2249: 	@languages=(@languages,
                   2250: 		$Apache::lonnet::domain_lang_def{
                   2251:                                   $Apache::lonnet::perlvar{'lonDefDomain'}});
                   2252:     }
                   2253: # turn "en-ca" into "en-ca,en"
                   2254:     my @genlanguages;
                   2255:     foreach (@languages) {
                   2256: 	unless ($_=~/\w/) { next; }
                   2257: 	push (@genlanguages,$_);
                   2258: 	if ($_=~/(\-|\_)/) {
                   2259: 	    push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
                   2260: 	}
                   2261:     }
                   2262:     return @genlanguages;
1.117     www      2263: }
                   2264: 
1.112     bowersj2 2265: ###############################################################
                   2266: ##               Student Answer Attempts                     ##
                   2267: ###############################################################
                   2268: 
                   2269: =pod
                   2270: 
                   2271: =head1 Alternate Problem Views
                   2272: 
                   2273: =over 4
                   2274: 
                   2275: =item * get_previous_attempt($symb, $username, $domain, $course,
                   2276:     $getattempt, $regexp, $gradesub)
                   2277: 
                   2278: Return string with previous attempt on problem. Arguments:
                   2279: 
                   2280: =over 4
                   2281: 
                   2282: =item * $symb: Problem, including path
                   2283: 
                   2284: =item * $username: username of the desired student
                   2285: 
                   2286: =item * $domain: domain of the desired student
1.14      harris41 2287: 
1.112     bowersj2 2288: =item * $course: Course ID
1.14      harris41 2289: 
1.112     bowersj2 2290: =item * $getattempt: Leave blank for all attempts, otherwise put
                   2291:     something
1.14      harris41 2292: 
1.112     bowersj2 2293: =item * $regexp: if string matches this regexp, the string will be
                   2294:     sent to $gradesub
1.14      harris41 2295: 
1.112     bowersj2 2296: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 2297: 
1.112     bowersj2 2298: =back
1.14      harris41 2299: 
1.112     bowersj2 2300: The output string is a table containing all desired attempts, if any.
1.16      harris41 2301: 
1.112     bowersj2 2302: =cut
1.1       albertel 2303: 
                   2304: sub get_previous_attempt {
1.43      ng       2305:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 2306:   my $prevattempts='';
1.43      ng       2307:   no strict 'refs';
1.1       albertel 2308:   if ($symb) {
1.3       albertel 2309:     my (%returnhash)=
                   2310:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 2311:     if ($returnhash{'version'}) {
                   2312:       my %lasthash=();
                   2313:       my $version;
                   2314:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.19      harris41 2315:         foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {
1.1       albertel 2316: 	  $lasthash{$_}=$returnhash{$version.':'.$_};
1.19      harris41 2317:         }
1.1       albertel 2318:       }
1.43      ng       2319:       $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40      ng       2320:       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.16      harris41 2321:       foreach (sort(keys %lasthash)) {
1.31      albertel 2322: 	my ($ign,@parts) = split(/\./,$_);
1.41      ng       2323: 	if ($#parts > 0) {
1.31      albertel 2324: 	  my $data=$parts[-1];
                   2325: 	  pop(@parts);
1.40      ng       2326: 	  $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.'&nbsp;</td>';
1.31      albertel 2327: 	} else {
1.41      ng       2328: 	  if ($#parts == 0) {
                   2329: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   2330: 	  } else {
                   2331: 	    $prevattempts.='<th>'.$ign.'</th>';
                   2332: 	  }
1.31      albertel 2333: 	}
1.16      harris41 2334:       }
1.40      ng       2335:       if ($getattempt eq '') {
                   2336: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
                   2337: 	  $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
                   2338: 	    foreach (sort(keys %lasthash)) {
                   2339: 	       my $value;
                   2340: 	       if ($_ =~ /timestamp/) {
                   2341: 		  $value=scalar(localtime($returnhash{$version.':'.$_}));
                   2342: 	       } else {
                   2343: 		  $value=$returnhash{$version.':'.$_};
                   2344: 	       }
1.142     albertel 2345: 	       $prevattempts.='<td>'.&Apache::lonnet::unescape($value).'&nbsp;</td>';   
1.40      ng       2346: 	    }
                   2347: 	 }
1.1       albertel 2348:       }
1.40      ng       2349:       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.16      harris41 2350:       foreach (sort(keys %lasthash)) {
1.5       albertel 2351: 	my $value;
                   2352: 	if ($_ =~ /timestamp/) {
                   2353: 	  $value=scalar(localtime($lasthash{$_}));
                   2354: 	} else {
                   2355: 	  $value=$lasthash{$_};
                   2356: 	}
1.142     albertel 2357: 	$value=&Apache::lonnet::unescape($value);
1.49      ng       2358: 	if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       2359: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 2360:       }
1.40      ng       2361:       $prevattempts.='</tr></table></td></tr></table>';
1.1       albertel 2362:     } else {
                   2363:       $prevattempts='Nothing submitted - no attempts.';
                   2364:     }
                   2365:   } else {
                   2366:     $prevattempts='No data.';
                   2367:   }
1.10      albertel 2368: }
                   2369: 
1.107     albertel 2370: sub relative_to_absolute {
                   2371:     my ($url,$output)=@_;
                   2372:     my $parser=HTML::TokeParser->new(\$output);
                   2373:     my $token;
                   2374:     my $thisdir=$url;
                   2375:     my @rlinks=();
                   2376:     while ($token=$parser->get_token) {
                   2377: 	if ($token->[0] eq 'S') {
                   2378: 	    if ($token->[1] eq 'a') {
                   2379: 		if ($token->[2]->{'href'}) {
                   2380: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   2381: 		}
                   2382: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   2383: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   2384: 	    } elsif ($token->[1] eq 'base') {
                   2385: 		$thisdir=$token->[2]->{'href'};
                   2386: 	    }
                   2387: 	}
                   2388:     }
                   2389:     $thisdir=~s-/[^/]*$--;
                   2390:     foreach (@rlinks) {
                   2391: 	unless (($_=~/^http:\/\//i) ||
                   2392: 		($_=~/^\//) ||
                   2393: 		($_=~/^javascript:/i) ||
                   2394: 		($_=~/^mailto:/i) ||
                   2395: 		($_=~/^\#/)) {
                   2396: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
                   2397: 	    $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
                   2398: 	}
                   2399:     }
                   2400: # -------------------------------------------------- Deal with Applet codebases
                   2401:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   2402:     return $output;
                   2403: }
                   2404: 
1.112     bowersj2 2405: =pod
                   2406: 
                   2407: =item * get_student_view
                   2408: 
                   2409: show a snapshot of what student was looking at
                   2410: 
                   2411: =cut
                   2412: 
1.10      albertel 2413: sub get_student_view {
1.186     albertel 2414:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      2415:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2416:   my (%form);
1.10      albertel 2417:   my @elements=('symb','courseid','domain','username');
                   2418:   foreach my $element (@elements) {
1.186     albertel 2419:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2420:   }
1.186     albertel 2421:   if (defined($moreenv)) {
                   2422:       %form=(%form,%{$moreenv});
                   2423:   }
1.236     albertel 2424:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 2425:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.186     albertel 2426:   my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 2427:   $userview=~s/\<body[^\>]*\>//gi;
                   2428:   $userview=~s/\<\/body\>//gi;
                   2429:   $userview=~s/\<html\>//gi;
                   2430:   $userview=~s/\<\/html\>//gi;
                   2431:   $userview=~s/\<head\>//gi;
                   2432:   $userview=~s/\<\/head\>//gi;
                   2433:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 2434:   $userview=&relative_to_absolute($feedurl,$userview);
1.11      albertel 2435:   return $userview;
                   2436: }
                   2437: 
1.112     bowersj2 2438: =pod
                   2439: 
                   2440: =item * get_student_answers() 
                   2441: 
                   2442: show a snapshot of how student was answering problem
                   2443: 
                   2444: =cut
                   2445: 
1.11      albertel 2446: sub get_student_answers {
1.100     sakharuk 2447:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      2448:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2449:   my (%moreenv);
1.11      albertel 2450:   my @elements=('symb','courseid','domain','username');
                   2451:   foreach my $element (@elements) {
1.186     albertel 2452:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2453:   }
1.186     albertel 2454:   $moreenv{'grade_target'}='answer';
                   2455:   %moreenv=(%form,%moreenv);
                   2456:   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10      albertel 2457:   return $userview;
1.1       albertel 2458: }
1.116     albertel 2459: 
                   2460: =pod
                   2461: 
                   2462: =item * &submlink()
                   2463: 
1.242     albertel 2464: Inputs: $text $uname $udom $symb $target
1.116     albertel 2465: 
                   2466: Returns: A link to grades.pm such as to see the SUBM view of a student
                   2467: 
                   2468: =cut
                   2469: 
                   2470: ###############################################
                   2471: sub submlink {
1.242     albertel 2472:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 2473:     if (!($uname && $udom)) {
                   2474: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2475: 	    &Apache::lonxml::whichuser($symb);
                   2476: 	if (!$symb) { $symb=$cursymb; }
                   2477:     }
1.254     matthew  2478:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242     albertel 2479:     $symb=&Apache::lonnet::escape($symb);
                   2480:     if ($target) { $target="target=\"$target\""; }
                   2481:     return '<a href="/adm/grades?&command=submission&'.
                   2482: 	'symb='.$symb.'&student='.$uname.
                   2483: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   2484: }
                   2485: ##############################################
                   2486: 
                   2487: =pod
                   2488: 
                   2489: =item * &pgrdlink()
                   2490: 
                   2491: Inputs: $text $uname $udom $symb $target
                   2492: 
                   2493: Returns: A link to grades.pm such as to see the PGRD view of a student
                   2494: 
                   2495: =cut
                   2496: 
                   2497: ###############################################
                   2498: sub pgrdlink {
                   2499:     my $link=&submlink(@_);
                   2500:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   2501:     return $link;
                   2502: }
                   2503: ##############################################
                   2504: 
                   2505: =pod
                   2506: 
                   2507: =item * &pprmlink()
                   2508: 
                   2509: Inputs: $text $uname $udom $symb $target
                   2510: 
                   2511: Returns: A link to parmset.pm such as to see the PPRM view of a
                   2512: student andn resource
                   2513: 
                   2514: =cut
                   2515: 
                   2516: ###############################################
                   2517: sub pprmlink {
                   2518:     my ($text,$uname,$udom,$symb,$target)=@_;
                   2519:     if (!($uname && $udom)) {
                   2520: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2521: 	    &Apache::lonxml::whichuser($symb);
                   2522: 	if (!$symb) { $symb=$cursymb; }
                   2523:     }
1.254     matthew  2524:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242     albertel 2525:     $symb=&Apache::lonnet::escape($symb);
                   2526:     if ($target) { $target="target=\"$target\""; }
                   2527:     return '<a href="/adm/parmset?&command=set&'.
                   2528: 	'symb='.$symb.'&uname='.$uname.
                   2529: 	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 2530: }
                   2531: ##############################################
1.37      matthew  2532: 
1.112     bowersj2 2533: =pod
                   2534: 
                   2535: =back
                   2536: 
                   2537: =cut
                   2538: 
1.37      matthew  2539: ###############################################
1.51      www      2540: 
                   2541: 
                   2542: sub timehash {
                   2543:     my @ltime=localtime(shift);
                   2544:     return ( 'seconds' => $ltime[0],
                   2545:              'minutes' => $ltime[1],
                   2546:              'hours'   => $ltime[2],
                   2547:              'day'     => $ltime[3],
                   2548:              'month'   => $ltime[4]+1,
                   2549:              'year'    => $ltime[5]+1900,
                   2550:              'weekday' => $ltime[6],
                   2551:              'dayyear' => $ltime[7]+1,
                   2552:              'dlsav'   => $ltime[8] );
                   2553: }
                   2554: 
                   2555: sub maketime {
                   2556:     my %th=@_;
                   2557:     return POSIX::mktime(
                   2558:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      2559:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      2560: }
                   2561: 
                   2562: #########################################
1.51      www      2563: 
                   2564: sub findallcourses {
                   2565:     my %courses=();
                   2566:     my $now=time;
1.258     albertel 2567:     foreach (keys %env) {
1.51      www      2568: 	if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
1.258     albertel 2569: 	    my ($starttime,$endtime)=$env{$_};
1.51      www      2570:             my $active=1;
                   2571:             if ($starttime) {
                   2572: 		if ($now<$starttime) { $active=0; }
                   2573:             }
                   2574:             if ($endtime) {
                   2575:                 if ($now>$endtime) { $active=0; }
                   2576:             }
                   2577:             if ($active) { $courses{$1.'_'.$2}=1; }
                   2578:         }
                   2579:     }
                   2580:     return keys %courses;
                   2581: }
1.37      matthew  2582: 
1.54      www      2583: ###############################################
1.60      matthew  2584: ###############################################
                   2585: 
                   2586: =pod
                   2587: 
1.112     bowersj2 2588: =head1 Domain Template Functions
                   2589: 
                   2590: =over 4
                   2591: 
                   2592: =item * &determinedomain()
1.60      matthew  2593: 
                   2594: Inputs: $domain (usually will be undef)
                   2595: 
1.63      www      2596: Returns: Determines which domain should be used for designs
1.60      matthew  2597: 
                   2598: =cut
1.54      www      2599: 
1.60      matthew  2600: ###############################################
1.63      www      2601: sub determinedomain {
                   2602:     my $domain=shift;
                   2603:    if (! $domain) {
1.60      matthew  2604:         # Determine domain if we have not been given one
                   2605:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 2606:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   2607:         if ($env{'request.role.domain'}) { 
                   2608:             $domain=$env{'request.role.domain'}; 
1.60      matthew  2609:         }
                   2610:     }
1.63      www      2611:     return $domain;
                   2612: }
                   2613: ###############################################
                   2614: =pod
                   2615: 
1.112     bowersj2 2616: =item * &domainlogo()
1.63      www      2617: 
                   2618: Inputs: $domain (usually will be undef)
                   2619: 
                   2620: Returns: A link to a domain logo, if the domain logo exists.
                   2621: If the domain logo does not exist, a description of the domain.
                   2622: 
                   2623: =cut
1.112     bowersj2 2624: 
1.63      www      2625: ###############################################
                   2626: sub domainlogo {
                   2627:     my $domain = &determinedomain(shift);    
                   2628:      # See if there is a logo
1.59      www      2629:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215     albertel 2630: 	my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
                   2631:         return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60      matthew  2632:     } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
                   2633:         return $Apache::lonnet::domaindescription{$domain};
1.59      www      2634:     } else {
1.60      matthew  2635:         return '';
1.59      www      2636:     }
                   2637: }
1.63      www      2638: ##############################################
                   2639: 
                   2640: =pod
                   2641: 
1.112     bowersj2 2642: =item * &designparm()
1.63      www      2643: 
                   2644: Inputs: $which parameter; $domain (usually will be undef)
                   2645: 
                   2646: Returns: value of designparamter $which
                   2647: 
                   2648: =cut
1.112     bowersj2 2649: 
1.63      www      2650: ##############################################
                   2651: sub designparm {
                   2652:     my ($which,$domain)=@_;
1.258     albertel 2653:     if ($env{'browser.blackwhite'} eq 'on') {
1.110     www      2654: 	if ($which=~/\.(font|alink|vlink|link)$/) {
                   2655: 	    return '#000000';
                   2656: 	}
                   2657: 	if ($which=~/\.(pgbg|sidebg)$/) {
                   2658: 	    return '#FFFFFF';
                   2659: 	}
                   2660: 	if ($which=~/\.tabbg$/) {
                   2661: 	    return '#CCCCCC';
                   2662: 	}
                   2663:     }
1.258     albertel 2664:     if ($env{'environment.color.'.$which}) {
                   2665: 	return $env{'environment.color.'.$which};
1.96      www      2666:     }
1.63      www      2667:     $domain=&determinedomain($domain);
                   2668:     if ($designhash{$domain.'.'.$which}) {
                   2669: 	return $designhash{$domain.'.'.$which};
                   2670:     } else {
                   2671:         return $designhash{'default.'.$which};
                   2672:     }
                   2673: }
1.59      www      2674: 
1.60      matthew  2675: ###############################################
                   2676: ###############################################
                   2677: 
                   2678: =pod
                   2679: 
1.112     bowersj2 2680: =back
                   2681: 
                   2682: =head1 HTTP Helpers
                   2683: 
                   2684: =over 4
                   2685: 
                   2686: =item * &bodytag()
1.60      matthew  2687: 
                   2688: Returns a uniform header for LON-CAPA web pages.
                   2689: 
                   2690: Inputs: 
                   2691: 
1.112     bowersj2 2692: =over 4
                   2693: 
                   2694: =item * $title, A title to be displayed on the page.
                   2695: 
                   2696: =item * $function, the current role (can be undef).
                   2697: 
                   2698: =item * $addentries, extra parameters for the <body> tag.
                   2699: 
                   2700: =item * $bodyonly, if defined, only return the <body> tag.
                   2701: 
                   2702: =item * $domain, if defined, force a given domain.
                   2703: 
                   2704: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      2705:             text interface only)
1.60      matthew  2706: 
1.112     bowersj2 2707: =back
                   2708: 
1.60      matthew  2709: Returns: A uniform header for LON-CAPA web pages.  
                   2710: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   2711: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   2712: other decorations will be returned.
                   2713: 
                   2714: =cut
                   2715: 
1.54      www      2716: sub bodytag {
1.272     raeburn  2717:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,$notopbar)=@_;
1.117     www      2718:     $title=&mt($title);
1.183     matthew  2719:     $function = &get_users_function() if (!$function);
1.63      www      2720:     my $img=&designparm($function.'.img',$domain);
                   2721:     my $pgbg=&designparm($function.'.pgbg',$domain);
                   2722:     my $tabbg=&designparm($function.'.tabbg',$domain);
                   2723:     my $font=&designparm($function.'.font',$domain);
                   2724:     my $link=&designparm($function.'.link',$domain);
                   2725:     my $alink=&designparm($function.'.alink',$domain);
                   2726:     my $vlink=&designparm($function.'.vlink',$domain);
                   2727:     my $sidebg=&designparm($function.'.sidebg',$domain);
1.110     www      2728: # Accessibility font enhance
                   2729:     unless ($addentries) { $addentries=''; }
1.146     www      2730:     my $addstyle='';
1.258     albertel 2731:     if ($env{'browser.fontenhance'} eq 'on') {
1.146     www      2732: 	$addstyle=' font-size: x-large;';
1.110     www      2733:     }
1.63      www      2734:  # role and realm
1.55      www      2735:     my ($role,$realm)
1.258     albertel 2736:        =&Apache::lonnet::plaintext((split(/\./,$env{'request.role'}))[0]);
1.55      www      2737: # realm
1.258     albertel 2738:     if ($env{'request.course.id'}) {
1.55      www      2739: 	$realm=
1.258     albertel 2740:          $env{'course.'.$env{'request.course.id'}.'.description'};
1.54      www      2741:     }
1.55      www      2742:     unless ($realm) { $realm='&nbsp;'; }
                   2743: # Set messages
1.60      matthew  2744:     my $messages=&domainlogo($domain);
1.101     www      2745: # Port for miniserver
1.83      albertel 2746:     my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   2747:     if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.101     www      2748: # construct main body tag
1.60      matthew  2749:     my $bodytag = <<END;
1.231     albertel 2750: <style type="text/css">
1.147     www      2751: h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
1.146     www      2752: a:focus { color: red; background: yellow } 
                   2753: </style>
1.54      www      2754: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
1.151     www      2755: style="margin-top: 0px;$addstyle" $addentries>
1.60      matthew  2756: END
1.269     albertel 2757:     &Apache::lontexconvert::jsMath_reset();
1.258     albertel 2758:     if ($env{'environment.texengine'} eq 'jsMath') {
1.269     albertel 2759: 	$bodytag.=&Apache::lontexconvert::jsMath_header();
1.252     albertel 2760:     }
                   2761: 
1.94      www      2762:     my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
1.150     matthew  2763:                    $lonhttpdPort.$img.'" alt="'.$function.'" />';
1.60      matthew  2764:     if ($bodyonly) {
                   2765:         return $bodytag;
1.258     albertel 2766:     } elsif ($env{'browser.interface'} eq 'textual') {
1.95      www      2767: # Accessibility
1.224     raeburn  2768:           
1.93      www      2769:         return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
                   2770:                                                       $forcereg).
                   2771:                '<h1>LON-CAPA: '.$title.'</h1>';
1.258     albertel 2772:     } elsif ($env{'environment.remote'} eq 'off') {
1.95      www      2773: # No Remote
1.206     albertel 2774: 	my $roleinfo=(<<ENDROLE);
                   2775: <td bgcolor="$tabbg" align="right">
                   2776: <font size="2" face="Arial, Helvetica, sans-serif">
1.258     albertel 2777:     $env{'environment.firstname'}
                   2778:     $env{'environment.middlename'}
                   2779:     $env{'environment.lastname'}
                   2780:     $env{'environment.generation'}
1.206     albertel 2781:     </font>&nbsp;
                   2782: <br />
                   2783: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
                   2784: <br />
                   2785: <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;
                   2786: </td>
                   2787: ENDROLE
1.224     raeburn  2788:         my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
1.229     albertel 2789: 		$font.'"><b>'.$title.'</b></font>';
1.224     raeburn  2790:         if ($customtitle) {
                   2791:             $titleinfo = $customtitle;
1.235     raeburn  2792:         }
                   2793: 
1.258     albertel 2794: 	if ($env{'request.state'} eq 'construct') {
1.229     albertel 2795: 	    my ($uname,$thisdisfn)=
1.258     albertel 2796: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 2797: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   2798: 	    $formaction=~s/\/+/\//g;
1.237     raeburn  2799:             unless ($customtitle) {  #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm  
                   2800:                 my $parentpath = '';
1.241     raeburn  2801:                 my $lastitem = '';
                   2802:                 if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
1.235     raeburn  2803:                     $parentpath = $1;
1.241     raeburn  2804:                     $lastitem = $2;
                   2805:                 } else {
                   2806:                     $lastitem = $thisdisfn;
1.235     raeburn  2807:                 }
                   2808: 	        $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
                   2809:                       '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font>&nbsp;'. 
                   2810:                       '<form name="dirs" method="post" action="'.$formaction
                   2811: 		    .'" target="_top"><tt><b>'
1.241     raeburn  2812: 		    .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
1.235     raeburn  2813: 		    .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   2814: 		    .'</form>'
                   2815: 		    .&Apache::lonmenu::constspaceform();
1.229     albertel 2816: 
1.235     raeburn  2817:             }
                   2818: 	    $forcereg=1;
                   2819:         }
                   2820:         my $titletable = '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
                   2821:                          'cellspacing="3" cellpadding="3">'.
1.270     albertel 2822:                          '<tr><td bgcolor="'.$tabbg.'">'.
1.235     raeburn  2823:                          $titleinfo.'</td>'.$roleinfo.'</tr></table>';
1.258     albertel 2824:         if ($env{'request.state'} eq 'construct') {
1.272     raeburn  2825:             if ($notopbar) {
                   2826:                 $bodytag .= $titletable;
                   2827:             } else {
                   2828:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg,$titletable);
                   2829:             }
1.235     raeburn  2830: 	} else {
1.272     raeburn  2831:             if ($notopbar) {
                   2832:                 $bodytag .= $titletable;
                   2833:             } else {
                   2834:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg).
1.235     raeburn  2835:                         $titletable;
1.272     raeburn  2836:             }
1.235     raeburn  2837:         }
                   2838:         return $bodytag;
1.94      www      2839:     }
1.95      www      2840: 
1.93      www      2841: #
1.95      www      2842: # Top frame rendering, Remote is up
1.93      www      2843: #
1.224     raeburn  2844:     my $titleinfo = '&nbsp;<font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
                   2845:     if ($customtitle) {
                   2846:         $titleinfo = $customtitle;
                   2847:     }
1.245     matthew  2848:     #
                   2849:     # Extra info if you are the DC
                   2850:     my $dc_info = '';
1.258     albertel 2851:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   2852:                         $env{'course.'.$env{'request.course.id'}.
1.245     matthew  2853:                                  '.domain'}.'/'})) {
1.258     albertel 2854:         my $cid = $env{'request.course.id'};
                   2855:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.245     matthew  2856:         $dc_info = '('.$dc_info.')';
                   2857:     }
                   2858:     #
1.94      www      2859:     return(<<ENDBODY);
1.60      matthew  2860: $bodytag
1.55      www      2861: <table width="100%" cellspacing="0" border="0" cellpadding="0">
1.95      www      2862: <tr><td bgcolor="$sidebg">
1.94      www      2863: $upperleft</td>
1.95      www      2864: <td bgcolor="$sidebg" align="right">$messages&nbsp;</td>
1.55      www      2865: </tr>
1.54      www      2866: <tr>
1.55      www      2867: <td rowspan="3" bgcolor="$tabbg">
1.245     matthew  2868: $titleinfo $dc_info
1.257     matthew  2869: </td><td bgcolor="$tabbg" align="right">
1.146     www      2870: <font size="2" face="Arial, Helvetica, sans-serif">
1.258     albertel 2871:     $env{'environment.firstname'}
                   2872:     $env{'environment.middlename'}
                   2873:     $env{'environment.lastname'}
                   2874:     $env{'environment.generation'}
1.55      www      2875:     </font>&nbsp;
1.54      www      2876: </td>
                   2877: </tr>
                   2878: <tr><td bgcolor="$tabbg" align="right">
1.146     www      2879: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>&nbsp;
1.54      www      2880: </td></tr>
1.55      www      2881: <tr>
1.148     www      2882: <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font>&nbsp;</td></tr>
1.202     albertel 2883: </table><br />
1.54      www      2884: ENDBODY
1.182     matthew  2885: }
                   2886: 
                   2887: ###############################################
1.251     albertel 2888: ###############################################
                   2889: 
                   2890: =pod
                   2891: 
                   2892: =back
                   2893: 
                   2894: =head1 HTTP Helpers
                   2895: 
                   2896: =over 4
                   2897: 
                   2898: =item * &endbodytag()
                   2899: 
                   2900: Returns a uniform footer for LON-CAPA web pages.
                   2901: 
                   2902: Inputs: 
                   2903: 
                   2904: =over 4
                   2905: 
                   2906: =back
                   2907: 
                   2908: Returns: A uniform footer for LON-CAPA web pages.  
                   2909: 
                   2910: =cut
                   2911: 
                   2912: sub endbodytag {
                   2913:     my $endbodytag='</body>';
1.269     albertel 2914:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.251     albertel 2915:     return $endbodytag;
                   2916: }
                   2917: 
                   2918: ###############################################
1.182     matthew  2919: 
                   2920: =pod
                   2921: 
                   2922: =item get_users_function
                   2923: 
                   2924: Used by &bodytag to determine the current users primary role.
                   2925: Returns either 'student','coordinator','admin', or 'author'.
                   2926: 
                   2927: =cut
                   2928: 
                   2929: ###############################################
                   2930: sub get_users_function {
                   2931:     my $function = 'student';
1.258     albertel 2932:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  2933:         $function='coordinator';
                   2934:     }
1.258     albertel 2935:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  2936:         $function='admin';
                   2937:     }
1.258     albertel 2938:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  2939:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   2940:         $function='author';
                   2941:     }
                   2942:     return $function;
1.54      www      2943: }
1.99      www      2944: 
                   2945: ###############################################
                   2946: 
1.233     raeburn  2947: =pod
                   2948: 
1.274     raeburn  2949: =item check_user_status
                   2950: 
                   2951: Determines current status of supplied role for a
                   2952: specific user. Roles can be active, previous or future.
                   2953: 
                   2954: Inputs: 
                   2955: user's domain, user's username, course's domain,
                   2956: course's number, optional section/group.
                   2957: 
                   2958: Outputs:
                   2959: role status: active, previous or future. 
                   2960: 
                   2961: =cut
                   2962: 
                   2963: sub check_user_status {
                   2964:     my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;
                   2965:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   2966:     my @uroles = keys %userinfo;
                   2967:     my $srchstr;
                   2968:     my $active_chk = 'none';
                   2969:     if (@uroles > 0) {
                   2970:         if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {
                   2971:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   2972:         } else {
                   2973:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role;         }
                   2974:         if (grep/^$srchstr$/,@uroles) {
                   2975:             my $role_end = 0;
                   2976:             my $role_start = 0;
                   2977:             $active_chk = 'active';
                   2978:             if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {
                   2979:                 $role_end = $2;
                   2980:                 if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {
                   2981:                     $role_start = $3;
                   2982:                 }
                   2983:             }
                   2984:             if ($role_start > 0) {
                   2985:                 if (time < $role_start) {
                   2986:                     $active_chk = 'future';
                   2987:                 }
                   2988:             }
                   2989:             if ($role_end > 0) {
                   2990:                 if (time > $role_end) {
                   2991:                     $active_chk = 'previous';
                   2992:                 }
                   2993:             }
                   2994:         }
                   2995:     }
                   2996:     return $active_chk;
                   2997: }
                   2998: 
                   2999: ###############################################
                   3000: 
                   3001: =pod
                   3002: 
1.233     raeburn  3003: =item get_sections
                   3004: 
                   3005: Determines all the sections for a course including
                   3006: sections with students and sections containing other roles.
                   3007: Incoming parameters: domain, course number, reference to 
                   3008: section hash (keys to be section/group IDs), reference to 
                   3009: array containing roles for which sections should be gathered
                   3010: (optional). If the fourth argument is undefined, sections
                   3011: are gathered for any role.
                   3012:  
                   3013: Returns number of sections.
                   3014: 
                   3015: =cut
                   3016: 
                   3017: ###############################################
                   3018: sub get_sections {
                   3019:     my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
1.240     albertel 3020:     if (!($cdom && $cnum)) { return 0; }
1.233     raeburn  3021:     my $numsections = 0;
1.240     albertel 3022: 
                   3023:     if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
1.276     albertel 3024: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 3025: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   3026: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
                   3027: 	while (my ($student,$data) = each %$classlist) {
                   3028: 	    my ($section,$status) = ($data->[$sec_index],
                   3029: 				     $data->[$status_index]);
                   3030: 	    unless ($section eq '-1' || $section =~ /^\s*$/) {
                   3031: 		if (!defined($$sectioncount{$section})) { $numsections++; }
                   3032: 		$$sectioncount{$section}++;
                   3033: 	    }
                   3034: 	}
                   3035:     }
                   3036:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   3037:     foreach my $user (sort(keys(%courseroles))) {
                   3038: 	if ($user !~ /^(\w{2})/) { next; }
                   3039: 	my ($role) = ($user =~ /^(\w{2})/);
                   3040: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
                   3041: 	my $section;
                   3042: 	if ($role eq 'cr' &&
                   3043: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   3044: 	    $section=$1;
                   3045: 	}
                   3046: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   3047: 	if (!defined($section) || $section eq '-1') { next; }
                   3048: 	if (!defined($$sectioncount{$section})) { $numsections++; } 
                   3049: 	$$sectioncount{$section}++;
1.233     raeburn  3050:     }
                   3051:     return $numsections;
                   3052: }
                   3053: 
1.274     raeburn  3054: ###############################################
                   3055: 
1.275     raeburn  3056: =pod
                   3057:                                                                                 
                   3058: =item get_course_users
                   3059:                                                                                 
                   3060: Retrieves usernames:domains for users in the specified course
                   3061: with specific role(s), and access status. 
                   3062: 
                   3063: Incoming parameters:
1.277     albertel 3064: 1. course domain
                   3065: 2. course number
                   3066: 3. access status: users must have - either active, 
1.275     raeburn  3067: previous, future, or all.
1.277     albertel 3068: 4. reference to array of permissible roles
                   3069: 5. reference to results object (hash of hashes).
1.275     raeburn  3070: Keys of top level hash are roles.
                   3071: Keys of inner hashes are username:domain, with 
                   3072: values set to access type.
                   3073:                                                                                 
                   3074: =cut
                   3075:                                                                                 
                   3076: ###############################################
                   3077:                                                                                 
                   3078: sub get_course_users {
1.277     albertel 3079:     my ($cdom,$cnum,$types,$roles,$users) = @_;
1.275     raeburn  3080:     if (grep/^st$/,@{$roles}) {
1.277     albertel 3081:         my $statusidx = &Apache::loncoursedata::CL_STATUS();
                   3082:         my $startidx = &Apache::loncoursedata::CL_START();
                   3083:         my $endidx = &Apache::loncoursedata::CL_END();
1.276     albertel 3084:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  3085:         my $now = time;
1.277     albertel 3086:         foreach my $student (keys(%{$classlist})) {
1.275     raeburn  3087:             if (defined($$types{'active'})) {
                   3088:                 if ($$classlist{$student}[$statusidx] eq 'Active') {
                   3089:                     push(@{$$users{st}{$student}},'active');
                   3090:                 }
                   3091:             }
                   3092:             if (defined($$types{'previous'})) {
1.278     raeburn  3093:                 if ($$classlist{$student}[$endidx] <= $now) {
1.275     raeburn  3094:                     push(@{$$users{st}{$student}},'previous');
                   3095:                 }
                   3096:             }
                   3097:             if (defined($$types{'future'})) {
1.278     raeburn  3098:                 if (($$classlist{$student}[$startidx] > $now) && ($$classlist{$student}[$endidx] > $now) || ($$classlist{$student}[$endidx] == 0) || ($$classlist{$student}[$endidx] eq '')) {
1.275     raeburn  3099:                     push(@{$$users{st}{$student}},'future');
                   3100:                 }
                   3101:             }
                   3102:         }
                   3103:     }
                   3104:     if ((@{$roles} > 0) && (@{$roles} ne "st")) {
                   3105:         my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
                   3106:         foreach my $person (@coursepersonnel) {
                   3107:             my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);
                   3108:             $user =~ s/:$//;
1.277     albertel 3109:             if (($role) && (grep(/^$role$/,@{$roles}))) {
                   3110:                 my ($uname,$udom) = split(/:/,$user);
1.275     raeburn  3111:                 if ($uname ne '' && $udom ne '') {
                   3112:                     my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);
1.277     albertel 3113:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  3114:                         if ($status eq $type) {
                   3115:                             $$users{$role}{$user} = $type;
                   3116:                         }
                   3117:                     }
                   3118:                 }
                   3119:             }
                   3120:         }
1.279     raeburn  3121:         if (grep/^ow$/,@{$roles}) {
                   3122:             if ((defined($cdom)) && (defined($cnum))) {
                   3123:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   3124:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   3125:                     my $owner = $csettings{'internal.courseowner'};
                   3126:                     $$users{'ow'}{$owner.':'.$cdom} = 'any';
                   3127:                 }
                   3128:             }
                   3129:         }
1.275     raeburn  3130:     }
                   3131:     return;
                   3132: }
                   3133: 
                   3134: 
                   3135: 
                   3136: ###############################################
1.233     raeburn  3137: 
1.99      www      3138: sub get_posted_cgi {
                   3139:     my $r=shift;
                   3140: 
                   3141:     my $buffer;
1.260     albertel 3142:     if ($r->header_in('Content-length')) {
                   3143: 	$r->read($buffer,$r->header_in('Content-length'),0);
                   3144:     }
1.99      www      3145:     unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
                   3146: 	my @pairs=split(/&/,$buffer);
                   3147: 	my $pair;
                   3148: 	foreach $pair (@pairs) {
                   3149: 	    my ($name,$value) = split(/=/,$pair);
                   3150: 	    $value =~ tr/+/ /;
                   3151: 	    $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
                   3152: 	    $name  =~ tr/+/ /;
                   3153: 	    $name  =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
                   3154: 	    &add_to_env("form.$name",$value);
                   3155: 	}
                   3156:     } else {
                   3157: 	my $contentsep=$1;
                   3158: 	my @lines = split (/\n/,$buffer);
                   3159: 	my $name='';
                   3160: 	my $value='';
                   3161: 	my $fname='';
                   3162: 	my $fmime='';
                   3163: 	my $i;
                   3164: 	for ($i=0;$i<=$#lines;$i++) {
                   3165: 	    if ($lines[$i]=~/^$contentsep/) {
                   3166: 		if ($name) {
                   3167: 		    chomp($value);
                   3168: 		    if ($fname) {
1.258     albertel 3169: 			$env{"form.$name.filename"}=$fname;
                   3170: 			$env{"form.$name.mimetype"}=$fmime;
1.99      www      3171: 		    } else {
                   3172: 			$value=~s/\s+$//s;
                   3173: 		    }
                   3174: 		    &add_to_env("form.$name",$value);
                   3175: 		}
                   3176: 		if ($i<$#lines) {
                   3177: 		    $i++;
                   3178: 		    $lines[$i]=~
                   3179: 		/Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
                   3180: 		    $name=$1;
                   3181: 		    $value='';
                   3182: 		    if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
                   3183: 			$fname=$1;
                   3184: 			if 
                   3185:                             ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
                   3186: 				$fmime=$1;
                   3187: 				$i++;
                   3188: 			    } else {
                   3189: 				$fmime='';
                   3190: 			    }
                   3191: 		    } else {
                   3192: 			$fname='';
                   3193: 			$fmime='';
                   3194: 		    }
                   3195: 		    $i++;
                   3196: 		}
                   3197: 	    } else {
                   3198: 		$value.=$lines[$i]."\n";
                   3199: 	    }
                   3200: 	}
                   3201:     }
1.258     albertel 3202:     $env{'request.method'}=$ENV{'REQUEST_METHOD'};
1.99      www      3203:     $r->method_number(M_GET);
                   3204:     $r->method('GET');
                   3205:     $r->headers_in->unset('Content-length');
                   3206: }
                   3207: 
1.112     bowersj2 3208: =pod
                   3209: 
                   3210: =item * get_unprocessed_cgi($query,$possible_names)
                   3211: 
1.258     albertel 3212: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 3213: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 3214: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 3215: 
                   3216: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   3217: $possible_names is an ref to an array of form element names.  As an example:
                   3218: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 3219: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 3220: 
                   3221: =cut
1.1       albertel 3222: 
1.6       albertel 3223: sub get_unprocessed_cgi {
1.25      albertel 3224:   my ($query,$possible_names)= @_;
1.26      matthew  3225:   # $Apache::lonxml::debug=1;
1.16      harris41 3226:   foreach (split(/&/,$query)) {
1.6       albertel 3227:     my ($name, $value) = split(/=/,$_);
1.25      albertel 3228:     $name = &Apache::lonnet::unescape($name);
                   3229:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   3230:       $value =~ tr/+/ /;
                   3231:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 3232:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 3233:     }
1.16      harris41 3234:   }
1.6       albertel 3235: }
                   3236: 
1.112     bowersj2 3237: =pod
                   3238: 
                   3239: =item * cacheheader() 
                   3240: 
                   3241: returns cache-controlling header code
                   3242: 
                   3243: =cut
                   3244: 
1.7       albertel 3245: sub cacheheader {
1.258     albertel 3246:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 3247:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   3248:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 3249:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   3250:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 3251:     return $output;
1.7       albertel 3252: }
                   3253: 
1.112     bowersj2 3254: =pod
                   3255: 
                   3256: =item * no_cache($r) 
                   3257: 
                   3258: specifies header code to not have cache
                   3259: 
                   3260: =cut
                   3261: 
1.9       albertel 3262: sub no_cache {
1.216     albertel 3263:     my ($r) = @_;
                   3264:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 3265: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 3266:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   3267:     $r->no_cache(1);
                   3268:     $r->header_out("Expires" => $date);
                   3269:     $r->header_out("Pragma" => "no-cache");
1.123     www      3270: }
                   3271: 
                   3272: sub content_type {
1.181     albertel 3273:     my ($r,$type,$charset) = @_;
1.258     albertel 3274:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 3275:     unless ($charset) {
                   3276: 	$charset=&Apache::lonlocal::current_encoding;
                   3277:     }
                   3278:     if ($charset) { $type.='; charset='.$charset; }
                   3279:     if ($r) {
                   3280: 	$r->content_type($type);
                   3281:     } else {
                   3282: 	print("Content-type: $type\n\n");
                   3283:     }
1.9       albertel 3284: }
1.25      albertel 3285: 
1.112     bowersj2 3286: =pod
                   3287: 
                   3288: =item * add_to_env($name,$value) 
                   3289: 
1.258     albertel 3290: adds $name to the %env hash with value
1.112     bowersj2 3291: $value, if $name already exists, the entry is converted to an array
                   3292: reference and $value is added to the array.
                   3293: 
                   3294: =cut
                   3295: 
1.25      albertel 3296: sub add_to_env {
                   3297:   my ($name,$value)=@_;
1.258     albertel 3298:   if (defined($env{$name})) {
                   3299:     if (ref($env{$name})) {
1.25      albertel 3300:       #already have multiple values
1.258     albertel 3301:       push(@{ $env{$name} },$value);
1.25      albertel 3302:     } else {
                   3303:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 3304:       my $first=$env{$name};
                   3305:       undef($env{$name});
                   3306:       push(@{ $env{$name} },$first,$value);
1.25      albertel 3307:     }
                   3308:   } else {
1.258     albertel 3309:     $env{$name}=$value;
1.25      albertel 3310:   }
1.31      albertel 3311: }
1.149     albertel 3312: 
                   3313: =pod
                   3314: 
                   3315: =item * get_env_multiple($name) 
                   3316: 
1.258     albertel 3317: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 3318: values may be defined and end up as an array ref.
                   3319: 
                   3320: returns an array of values
                   3321: 
                   3322: =cut
                   3323: 
                   3324: sub get_env_multiple {
                   3325:     my ($name) = @_;
                   3326:     my @values;
1.258     albertel 3327:     if (defined($env{$name})) {
1.149     albertel 3328:         # exists is it an array
1.258     albertel 3329:         if (ref($env{$name})) {
                   3330:             @values=@{ $env{$name} };
1.149     albertel 3331:         } else {
1.258     albertel 3332:             $values[0]=$env{$name};
1.149     albertel 3333:         }
                   3334:     }
                   3335:     return(@values);
                   3336: }
                   3337: 
1.31      albertel 3338: 
1.41      ng       3339: =pod
1.45      matthew  3340: 
                   3341: =back 
1.41      ng       3342: 
1.112     bowersj2 3343: =head1 CSV Upload/Handling functions
1.38      albertel 3344: 
1.41      ng       3345: =over 4
                   3346: 
1.112     bowersj2 3347: =item * upfile_store($r)
1.41      ng       3348: 
                   3349: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 3350: needs $env{'form.upfile'}
1.41      ng       3351: returns $datatoken to be put into hidden field
                   3352: 
                   3353: =cut
1.31      albertel 3354: 
                   3355: sub upfile_store {
                   3356:     my $r=shift;
1.258     albertel 3357:     $env{'form.upfile'}=~s/\r/\n/gs;
                   3358:     $env{'form.upfile'}=~s/\f/\n/gs;
                   3359:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   3360:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 3361: 
1.258     albertel 3362:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   3363: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 3364:     {
1.158     raeburn  3365:         my $datafile = $r->dir_config('lonDaemons').
                   3366:                            '/tmp/'.$datatoken.'.tmp';
                   3367:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 3368:             print $fh $env{'form.upfile'};
1.158     raeburn  3369:             close($fh);
                   3370:         }
1.31      albertel 3371:     }
                   3372:     return $datatoken;
                   3373: }
                   3374: 
1.56      matthew  3375: =pod
                   3376: 
1.112     bowersj2 3377: =item * load_tmp_file($r)
1.41      ng       3378: 
                   3379: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 3380: needs $env{'form.datatoken'},
                   3381: sets $env{'form.upfile'} to the contents of the file
1.41      ng       3382: 
                   3383: =cut
1.31      albertel 3384: 
                   3385: sub load_tmp_file {
                   3386:     my $r=shift;
                   3387:     my @studentdata=();
                   3388:     {
1.158     raeburn  3389:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 3390:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  3391:         if ( open(my $fh,"<$studentfile") ) {
                   3392:             @studentdata=<$fh>;
                   3393:             close($fh);
                   3394:         }
1.31      albertel 3395:     }
1.258     albertel 3396:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 3397: }
                   3398: 
1.56      matthew  3399: =pod
                   3400: 
1.112     bowersj2 3401: =item * upfile_record_sep()
1.41      ng       3402: 
                   3403: Separate uploaded file into records
                   3404: returns array of records,
1.258     albertel 3405: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       3406: 
                   3407: =cut
1.31      albertel 3408: 
                   3409: sub upfile_record_sep {
1.258     albertel 3410:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 3411:     } else {
1.248     albertel 3412: 	my @records;
1.258     albertel 3413: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 3414: 	    if ($line=~/^\s*$/) { next; }
                   3415: 	    push(@records,$line);
                   3416: 	}
                   3417: 	return @records;
1.31      albertel 3418:     }
                   3419: }
                   3420: 
1.56      matthew  3421: =pod
                   3422: 
1.112     bowersj2 3423: =item * record_sep($record)
1.41      ng       3424: 
1.258     albertel 3425: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       3426: 
                   3427: =cut
                   3428: 
1.263     www      3429: sub takeleft {
                   3430:     my $index=shift;
                   3431:     return substr('0000'.$index,-4,4);
                   3432: }
                   3433: 
1.31      albertel 3434: sub record_sep {
                   3435:     my $record=shift;
                   3436:     my %components=();
1.258     albertel 3437:     if ($env{'form.upfiletype'} eq 'xml') {
                   3438:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 3439:         my $i=0;
                   3440:         foreach (split(/\s+/,$record)) {
                   3441:             my $field=$_;
                   3442:             $field=~s/^(\"|\')//;
                   3443:             $field=~s/(\"|\')$//;
1.263     www      3444:             $components{&takeleft($i)}=$field;
1.31      albertel 3445:             $i++;
                   3446:         }
1.258     albertel 3447:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 3448:         my $i=0;
1.171     matthew  3449:         foreach (split(/\t/,$record)) {
1.31      albertel 3450:             my $field=$_;
                   3451:             $field=~s/^(\"|\')//;
                   3452:             $field=~s/(\"|\')$//;
1.263     www      3453:             $components{&takeleft($i)}=$field;
1.31      albertel 3454:             $i++;
                   3455:         }
                   3456:     } else {
                   3457:         my @allfields=split(/\,/,$record);
                   3458:         my $i=0;
                   3459:         my $j;
                   3460:         for ($j=0;$j<=$#allfields;$j++) {
                   3461:             my $field=$allfields[$j];
                   3462:             if ($field=~/^\s*(\"|\')/) {
                   3463: 		my $delimiter=$1;
                   3464:                 while (($field!~/$delimiter$/) && ($j<$#allfields)) {
                   3465: 		    $j++;
                   3466: 		    $field.=','.$allfields[$j];
                   3467: 		}
                   3468:                 $field=~s/^\s*$delimiter//;
                   3469:                 $field=~s/$delimiter\s*$//;
                   3470:             }
1.263     www      3471:             $components{&takeleft($i)}=$field;
1.31      albertel 3472: 	    $i++;
                   3473:         }
                   3474:     }
                   3475:     return %components;
                   3476: }
                   3477: 
1.144     matthew  3478: ######################################################
                   3479: ######################################################
                   3480: 
1.56      matthew  3481: =pod
                   3482: 
1.112     bowersj2 3483: =item * upfile_select_html()
1.41      ng       3484: 
1.144     matthew  3485: Return HTML code to select a file from the users machine and specify 
                   3486: the file type.
1.41      ng       3487: 
                   3488: =cut
                   3489: 
1.144     matthew  3490: ######################################################
                   3491: ######################################################
1.31      albertel 3492: sub upfile_select_html {
1.144     matthew  3493:     my %Types = (
                   3494:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
                   3495:                  space => &mt('Space separated'),
                   3496:                  tab   => &mt('Tabulator separated'),
                   3497: #                 xml   => &mt('HTML/XML'),
                   3498:                  );
                   3499:     my $Str = '<input type="file" name="upfile" size="50" />'.
                   3500:         '<br />Type: <select name="upfiletype">';
                   3501:     foreach my $type (sort(keys(%Types))) {
                   3502:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   3503:     }
                   3504:     $Str .= "</select>\n";
                   3505:     return $Str;
1.31      albertel 3506: }
                   3507: 
1.144     matthew  3508: ######################################################
                   3509: ######################################################
                   3510: 
1.56      matthew  3511: =pod
                   3512: 
1.112     bowersj2 3513: =item * csv_print_samples($r,$records)
1.41      ng       3514: 
                   3515: Prints a table of sample values from each column uploaded $r is an
                   3516: Apache Request ref, $records is an arrayref from
                   3517: &Apache::loncommon::upfile_record_sep
                   3518: 
                   3519: =cut
                   3520: 
1.144     matthew  3521: ######################################################
                   3522: ######################################################
1.31      albertel 3523: sub csv_print_samples {
                   3524:     my ($r,$records) = @_;
                   3525:     my (%sone,%stwo,%sthree);
                   3526:     %sone=&record_sep($$records[0]);
                   3527:     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
                   3528:     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144     matthew  3529:     #
                   3530:     $r->print(&mt('Samples').'<br /><table border="2"><tr>');
                   3531:     foreach (sort({$a <=> $b} keys(%sone))) { 
                   3532:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($_+1)).'</th>'); }
1.31      albertel 3533:     $r->print('</tr>');
                   3534:     foreach my $hash (\%sone,\%stwo,\%sthree) {
                   3535: 	$r->print('<tr>');
                   3536: 	foreach (sort({$a <=> $b} keys(%sone))) {
                   3537: 	    $r->print('<td>');
                   3538: 	    if (defined($$hash{$_})) { $r->print($$hash{$_}); }
                   3539: 	    $r->print('</td>');
                   3540: 	}
                   3541: 	$r->print('</tr>');
                   3542:     }
                   3543:     $r->print('</tr></table><br />'."\n");
                   3544: }
                   3545: 
1.144     matthew  3546: ######################################################
                   3547: ######################################################
                   3548: 
1.56      matthew  3549: =pod
                   3550: 
1.112     bowersj2 3551: =item * csv_print_select_table($r,$records,$d)
1.41      ng       3552: 
                   3553: Prints a table to create associations between values and table columns.
1.144     matthew  3554: 
1.41      ng       3555: $r is an Apache Request ref,
                   3556: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  3557: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       3558: 
                   3559: =cut
                   3560: 
1.144     matthew  3561: ######################################################
                   3562: ######################################################
1.31      albertel 3563: sub csv_print_select_table {
                   3564:     my ($r,$records,$d) = @_;
                   3565:     my $i=0;my %sone;
                   3566:     %sone=&record_sep($$records[0]);
1.144     matthew  3567:     $r->print(&mt('Associate columns with student attributes.')."\n".
                   3568: 	     '<table border="2"><tr>'.
                   3569:               '<th>'.&mt('Attribute').'</th>'.
                   3570:               '<th>'.&mt('Column').'</th></tr>'."\n");
1.31      albertel 3571:     foreach (@$d) {
1.174     matthew  3572: 	my ($value,$display,$defaultcol)=@{ $_ };
1.31      albertel 3573: 	$r->print('<tr><td>'.$display.'</td>');
                   3574: 
                   3575: 	$r->print('<td><select name=f'.$i.
1.32      matthew  3576: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 3577: 	$r->print('<option value="none"></option>');
                   3578: 	foreach (sort({$a <=> $b} keys(%sone))) {
1.174     matthew  3579: 	    $r->print('<option value="'.$_.'"'.
1.253     albertel 3580:                       ($_ eq $defaultcol ? ' selected="selected" ' : '').
1.174     matthew  3581:                       '>Column '.($_+1).'</option>');
1.31      albertel 3582: 	}
                   3583: 	$r->print('</select></td></tr>'."\n");
                   3584: 	$i++;
                   3585:     }
                   3586:     $i--;
                   3587:     return $i;
                   3588: }
1.56      matthew  3589: 
1.144     matthew  3590: ######################################################
                   3591: ######################################################
                   3592: 
1.56      matthew  3593: =pod
1.31      albertel 3594: 
1.112     bowersj2 3595: =item * csv_samples_select_table($r,$records,$d)
1.41      ng       3596: 
                   3597: Prints a table of sample values from the upload and can make associate samples to internal names.
                   3598: 
                   3599: $r is an Apache Request ref,
                   3600: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   3601: $d is an array of 2 element arrays (internal name, displayed name)
                   3602: 
                   3603: =cut
                   3604: 
1.144     matthew  3605: ######################################################
                   3606: ######################################################
1.31      albertel 3607: sub csv_samples_select_table {
                   3608:     my ($r,$records,$d) = @_;
                   3609:     my %sone; my %stwo; my %sthree;
                   3610:     my $i=0;
1.144     matthew  3611:     #
                   3612:     $r->print('<table border=2><tr><th>'.
                   3613:               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.31      albertel 3614:     %sone=&record_sep($$records[0]);
                   3615:     if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
                   3616:     if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144     matthew  3617:     #
1.31      albertel 3618:     foreach (sort keys %sone) {
1.144     matthew  3619: 	$r->print('<tr><td><select name="f'.$i.'"'.
1.32      matthew  3620: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 3621: 	foreach (@$d) {
1.174     matthew  3622: 	    my ($value,$display,$defaultcol)=@{ $_ };
                   3623: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 3624:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  3625:                       $display.'</option>');
1.31      albertel 3626: 	}
                   3627: 	$r->print('</select></td><td>');
1.263     www      3628: 	if (defined($sone{$_})) { $r->print($sone{$_}."<br />\n"); }
                   3629: 	if (defined($stwo{$_})) { $r->print($stwo{$_}."<br />\n"); }
                   3630: 	if (defined($sthree{$_})) { $r->print($sthree{$_}."<br />\n"); }
1.31      albertel 3631: 	$r->print('</td></tr>');
                   3632: 	$i++;
                   3633:     }
                   3634:     $i--;
                   3635:     return($i);
1.115     matthew  3636: }
                   3637: 
1.144     matthew  3638: ######################################################
                   3639: ######################################################
                   3640: 
1.115     matthew  3641: =pod
                   3642: 
                   3643: =item clean_excel_name($name)
                   3644: 
                   3645: Returns a replacement for $name which does not contain any illegal characters.
                   3646: 
                   3647: =cut
                   3648: 
1.144     matthew  3649: ######################################################
                   3650: ######################################################
1.115     matthew  3651: sub clean_excel_name {
                   3652:     my ($name) = @_;
                   3653:     $name =~ s/[:\*\?\/\\]//g;
                   3654:     if (length($name) > 31) {
                   3655:         $name = substr($name,0,31);
                   3656:     }
                   3657:     return $name;
1.25      albertel 3658: }
1.84      albertel 3659: 
1.85      albertel 3660: =pod
                   3661: 
1.112     bowersj2 3662: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 3663: 
                   3664: Returns either 1 or undef
                   3665: 
                   3666: 1 if the part is to be hidden, undef if it is to be shown
                   3667: 
                   3668: Arguments are:
                   3669: 
                   3670: $id the id of the part to be checked
                   3671: $symb, optional the symb of the resource to check
                   3672: $udom, optional the domain of the user to check for
                   3673: $uname, optional the username of the user to check for
                   3674: 
                   3675: =cut
1.84      albertel 3676: 
                   3677: sub check_if_partid_hidden {
                   3678:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 3679:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 3680: 					 $symb,$udom,$uname);
1.141     albertel 3681:     my $truth=1;
                   3682:     #if the string starts with !, then the list is the list to show not hide
                   3683:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 3684:     my @hiddenlist=split(/,/,$hiddenparts);
                   3685:     foreach my $checkid (@hiddenlist) {
1.141     albertel 3686: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 3687:     }
1.141     albertel 3688:     return !$truth;
1.84      albertel 3689: }
1.127     matthew  3690: 
1.138     matthew  3691: 
                   3692: ############################################################
                   3693: ############################################################
                   3694: 
                   3695: =pod
                   3696: 
1.157     matthew  3697: =back 
                   3698: 
1.138     matthew  3699: =head1 cgi-bin script and graphing routines
                   3700: 
1.157     matthew  3701: =over 4
                   3702: 
1.138     matthew  3703: =item get_cgi_id
                   3704: 
                   3705: Inputs: none
                   3706: 
                   3707: Returns an id which can be used to pass environment variables
                   3708: to various cgi-bin scripts.  These environment variables will
                   3709: be removed from the users environment after a given time by
                   3710: the routine &Apache::lonnet::transfer_profile_to_env.
                   3711: 
                   3712: =cut
                   3713: 
                   3714: ############################################################
                   3715: ############################################################
1.152     albertel 3716: my $uniq=0;
1.136     matthew  3717: sub get_cgi_id {
1.154     albertel 3718:     $uniq=($uniq+1)%100000;
1.280   ! albertel 3719:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  3720: }
                   3721: 
1.127     matthew  3722: ############################################################
                   3723: ############################################################
                   3724: 
                   3725: =pod
                   3726: 
1.134     matthew  3727: =item DrawBarGraph
1.127     matthew  3728: 
1.138     matthew  3729: Facilitates the plotting of data in a (stacked) bar graph.
                   3730: Puts plot definition data into the users environment in order for 
                   3731: graph.png to plot it.  Returns an <img> tag for the plot.
                   3732: The bars on the plot are labeled '1','2',...,'n'.
                   3733: 
                   3734: Inputs:
                   3735: 
                   3736: =over 4
                   3737: 
                   3738: =item $Title: string, the title of the plot
                   3739: 
                   3740: =item $xlabel: string, text describing the X-axis of the plot
                   3741: 
                   3742: =item $ylabel: string, text describing the Y-axis of the plot
                   3743: 
                   3744: =item $Max: scalar, the maximum Y value to use in the plot
                   3745: If $Max is < any data point, the graph will not be rendered.
                   3746: 
1.140     matthew  3747: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  3748: they are plotted.  If undefined, default values will be used.
                   3749: 
1.178     matthew  3750: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   3751: 
1.138     matthew  3752: =item @Values: An array of array references.  Each array reference holds data
                   3753: to be plotted in a stacked bar chart.
                   3754: 
1.239     matthew  3755: =item If the final element of @Values is a hash reference the key/value
                   3756: pairs will be added to the graph definition.
                   3757: 
1.138     matthew  3758: =back
                   3759: 
                   3760: Returns:
                   3761: 
                   3762: An <img> tag which references graph.png and the appropriate identifying
                   3763: information for the plot.
                   3764: 
1.127     matthew  3765: =cut
                   3766: 
                   3767: ############################################################
                   3768: ############################################################
1.134     matthew  3769: sub DrawBarGraph {
1.178     matthew  3770:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  3771:     #
                   3772:     if (! defined($colors)) {
                   3773:         $colors = ['#33ff00', 
                   3774:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   3775:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   3776:                   ]; 
                   3777:     }
1.228     matthew  3778:     my $extra_settings = {};
                   3779:     if (ref($Values[-1]) eq 'HASH') {
                   3780:         $extra_settings = pop(@Values);
                   3781:     }
1.127     matthew  3782:     #
1.136     matthew  3783:     my $identifier = &get_cgi_id();
                   3784:     my $id = 'cgi.'.$identifier;        
1.129     matthew  3785:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  3786:         return '';
                   3787:     }
1.225     matthew  3788:     #
                   3789:     my @Labels;
                   3790:     if (defined($labels)) {
                   3791:         @Labels = @$labels;
                   3792:     } else {
                   3793:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   3794:             push (@Labels,$i+1);
                   3795:         }
                   3796:     }
                   3797:     #
1.129     matthew  3798:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  3799:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  3800:     my %ValuesHash;
                   3801:     my $NumSets=1;
                   3802:     foreach my $array (@Values) {
                   3803:         next if (! ref($array));
1.136     matthew  3804:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  3805:             join(',',@$array);
1.129     matthew  3806:     }
1.127     matthew  3807:     #
1.136     matthew  3808:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  3809:     if ($NumBars < 3) {
                   3810:         $width = 120+$NumBars*32;
1.220     matthew  3811:         $xskip = 1;
1.225     matthew  3812:         $bar_width = 30;
                   3813:     } elsif ($NumBars < 5) {
                   3814:         $width = 120+$NumBars*20;
                   3815:         $xskip = 1;
                   3816:         $bar_width = 20;
1.220     matthew  3817:     } elsif ($NumBars < 10) {
1.136     matthew  3818:         $width = 120+$NumBars*15;
                   3819:         $xskip = 1;
                   3820:         $bar_width = 15;
                   3821:     } elsif ($NumBars <= 25) {
                   3822:         $width = 120+$NumBars*11;
                   3823:         $xskip = 5;
                   3824:         $bar_width = 8;
                   3825:     } elsif ($NumBars <= 50) {
                   3826:         $width = 120+$NumBars*8;
                   3827:         $xskip = 5;
                   3828:         $bar_width = 4;
                   3829:     } else {
                   3830:         $width = 120+$NumBars*8;
                   3831:         $xskip = 5;
                   3832:         $bar_width = 4;
                   3833:     }
                   3834:     #
1.137     matthew  3835:     $Max = 1 if ($Max < 1);
                   3836:     if ( int($Max) < $Max ) {
                   3837:         $Max++;
                   3838:         $Max = int($Max);
                   3839:     }
1.127     matthew  3840:     $Title  = '' if (! defined($Title));
                   3841:     $xlabel = '' if (! defined($xlabel));
                   3842:     $ylabel = '' if (! defined($ylabel));
1.136     matthew  3843:     $ValuesHash{$id.'.title'}    = &Apache::lonnet::escape($Title);
                   3844:     $ValuesHash{$id.'.xlabel'}   = &Apache::lonnet::escape($xlabel);
                   3845:     $ValuesHash{$id.'.ylabel'}   = &Apache::lonnet::escape($ylabel);
1.137     matthew  3846:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  3847:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   3848:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   3849:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   3850:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   3851:     $ValuesHash{$id.'.height'}   = $height;
                   3852:     $ValuesHash{$id.'.width'}    = $width;
                   3853:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   3854:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   3855:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  3856:     #
1.228     matthew  3857:     # Deal with other parameters
                   3858:     while (my ($key,$value) = each(%$extra_settings)) {
                   3859:         $ValuesHash{$id.'.'.$key} = $value;
                   3860:     }
                   3861:     #
1.137     matthew  3862:     &Apache::lonnet::appenv(%ValuesHash);
                   3863:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   3864: }
                   3865: 
                   3866: ############################################################
                   3867: ############################################################
                   3868: 
                   3869: =pod
                   3870: 
                   3871: =item DrawXYGraph
                   3872: 
1.138     matthew  3873: Facilitates the plotting of data in an XY graph.
                   3874: Puts plot definition data into the users environment in order for 
                   3875: graph.png to plot it.  Returns an <img> tag for the plot.
                   3876: 
                   3877: Inputs:
                   3878: 
                   3879: =over 4
                   3880: 
                   3881: =item $Title: string, the title of the plot
                   3882: 
                   3883: =item $xlabel: string, text describing the X-axis of the plot
                   3884: 
                   3885: =item $ylabel: string, text describing the Y-axis of the plot
                   3886: 
                   3887: =item $Max: scalar, the maximum Y value to use in the plot
                   3888: If $Max is < any data point, the graph will not be rendered.
                   3889: 
                   3890: =item $colors: Array ref containing the hex color codes for the data to be 
                   3891: plotted in.  If undefined, default values will be used.
                   3892: 
                   3893: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   3894: 
                   3895: =item $Ydata: Array ref containing Array refs.  
1.185     www      3896: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  3897: 
                   3898: =item %Values: hash indicating or overriding any default values which are 
                   3899: passed to graph.png.  
                   3900: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   3901: 
                   3902: =back
                   3903: 
                   3904: Returns:
                   3905: 
                   3906: An <img> tag which references graph.png and the appropriate identifying
                   3907: information for the plot.
                   3908: 
1.137     matthew  3909: =cut
                   3910: 
                   3911: ############################################################
                   3912: ############################################################
                   3913: sub DrawXYGraph {
                   3914:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   3915:     #
                   3916:     # Create the identifier for the graph
                   3917:     my $identifier = &get_cgi_id();
                   3918:     my $id = 'cgi.'.$identifier;
                   3919:     #
                   3920:     $Title  = '' if (! defined($Title));
                   3921:     $xlabel = '' if (! defined($xlabel));
                   3922:     $ylabel = '' if (! defined($ylabel));
                   3923:     my %ValuesHash = 
                   3924:         (
                   3925:          $id.'.title'  => &Apache::lonnet::escape($Title),
                   3926:          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
                   3927:          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
                   3928:          $id.'.y_max_value'=> $Max,
                   3929:          $id.'.labels'     => join(',',@$Xlabels),
                   3930:          $id.'.PlotType'   => 'XY',
                   3931:          );
                   3932:     #
                   3933:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   3934:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   3935:     }
                   3936:     #
                   3937:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   3938:         return '';
                   3939:     }
                   3940:     my $NumSets=1;
1.138     matthew  3941:     foreach my $array (@{$Ydata}){
1.137     matthew  3942:         next if (! ref($array));
                   3943:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   3944:     }
1.138     matthew  3945:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  3946:     #
                   3947:     # Deal with other parameters
                   3948:     while (my ($key,$value) = each(%Values)) {
                   3949:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  3950:     }
                   3951:     #
1.136     matthew  3952:     &Apache::lonnet::appenv(%ValuesHash);
                   3953:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   3954: }
                   3955: 
                   3956: ############################################################
                   3957: ############################################################
                   3958: 
                   3959: =pod
                   3960: 
1.138     matthew  3961: =item DrawXYYGraph
                   3962: 
                   3963: Facilitates the plotting of data in an XY graph with two Y axes.
                   3964: Puts plot definition data into the users environment in order for 
                   3965: graph.png to plot it.  Returns an <img> tag for the plot.
                   3966: 
                   3967: Inputs:
                   3968: 
                   3969: =over 4
                   3970: 
                   3971: =item $Title: string, the title of the plot
                   3972: 
                   3973: =item $xlabel: string, text describing the X-axis of the plot
                   3974: 
                   3975: =item $ylabel: string, text describing the Y-axis of the plot
                   3976: 
                   3977: =item $colors: Array ref containing the hex color codes for the data to be 
                   3978: plotted in.  If undefined, default values will be used.
                   3979: 
                   3980: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   3981: 
                   3982: =item $Ydata1: The first data set
                   3983: 
                   3984: =item $Min1: The minimum value of the left Y-axis
                   3985: 
                   3986: =item $Max1: The maximum value of the left Y-axis
                   3987: 
                   3988: =item $Ydata2: The second data set
                   3989: 
                   3990: =item $Min2: The minimum value of the right Y-axis
                   3991: 
                   3992: =item $Max2: The maximum value of the left Y-axis
                   3993: 
                   3994: =item %Values: hash indicating or overriding any default values which are 
                   3995: passed to graph.png.  
                   3996: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   3997: 
                   3998: =back
                   3999: 
                   4000: Returns:
                   4001: 
                   4002: An <img> tag which references graph.png and the appropriate identifying
                   4003: information for the plot.
1.136     matthew  4004: 
                   4005: =cut
                   4006: 
                   4007: ############################################################
                   4008: ############################################################
1.137     matthew  4009: sub DrawXYYGraph {
                   4010:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   4011:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  4012:     #
                   4013:     # Create the identifier for the graph
                   4014:     my $identifier = &get_cgi_id();
                   4015:     my $id = 'cgi.'.$identifier;
                   4016:     #
                   4017:     $Title  = '' if (! defined($Title));
                   4018:     $xlabel = '' if (! defined($xlabel));
                   4019:     $ylabel = '' if (! defined($ylabel));
                   4020:     my %ValuesHash = 
                   4021:         (
                   4022:          $id.'.title'  => &Apache::lonnet::escape($Title),
                   4023:          $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
                   4024:          $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
                   4025:          $id.'.labels' => join(',',@$Xlabels),
                   4026:          $id.'.PlotType' => 'XY',
                   4027:          $id.'.NumSets' => 2,
1.137     matthew  4028:          $id.'.two_axes' => 1,
                   4029:          $id.'.y1_max_value' => $Max1,
                   4030:          $id.'.y1_min_value' => $Min1,
                   4031:          $id.'.y2_max_value' => $Max2,
                   4032:          $id.'.y2_min_value' => $Min2,
1.136     matthew  4033:          );
                   4034:     #
1.137     matthew  4035:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   4036:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   4037:     }
                   4038:     #
                   4039:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   4040:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  4041:         return '';
                   4042:     }
                   4043:     my $NumSets=1;
1.137     matthew  4044:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  4045:         next if (! ref($array));
                   4046:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  4047:     }
                   4048:     #
                   4049:     # Deal with other parameters
                   4050:     while (my ($key,$value) = each(%Values)) {
                   4051:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  4052:     }
                   4053:     #
                   4054:     &Apache::lonnet::appenv(%ValuesHash);
1.130     albertel 4055:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  4056: }
                   4057: 
                   4058: ############################################################
                   4059: ############################################################
                   4060: 
                   4061: =pod
                   4062: 
1.157     matthew  4063: =back 
                   4064: 
1.139     matthew  4065: =head1 Statistics helper routines?  
                   4066: 
                   4067: Bad place for them but what the hell.
                   4068: 
1.157     matthew  4069: =over 4
                   4070: 
1.139     matthew  4071: =item &chartlink
                   4072: 
                   4073: Returns a link to the chart for a specific student.  
                   4074: 
                   4075: Inputs:
                   4076: 
                   4077: =over 4
                   4078: 
                   4079: =item $linktext: The text of the link
                   4080: 
                   4081: =item $sname: The students username
                   4082: 
                   4083: =item $sdomain: The students domain
                   4084: 
                   4085: =back
                   4086: 
1.157     matthew  4087: =back
                   4088: 
1.139     matthew  4089: =cut
                   4090: 
                   4091: ############################################################
                   4092: ############################################################
                   4093: sub chartlink {
                   4094:     my ($linktext, $sname, $sdomain) = @_;
                   4095:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.219     albertel 4096:         '&amp;SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
                   4097:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  4098:        '">'.$linktext.'</a>';
1.153     matthew  4099: }
                   4100: 
                   4101: #######################################################
                   4102: #######################################################
                   4103: 
                   4104: =pod
                   4105: 
                   4106: =head1 Course Environment Routines
1.157     matthew  4107: 
                   4108: =over 4
1.153     matthew  4109: 
                   4110: =item &restore_course_settings 
                   4111: 
                   4112: =item &store_course_settings
                   4113: 
                   4114: Restores/Store indicated form parameters from the course environment.
                   4115: Will not overwrite existing values of the form parameters.
                   4116: 
                   4117: Inputs: 
                   4118: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   4119: 
                   4120: a hash ref describing the data to be stored.  For example:
                   4121:    
                   4122: %Save_Parameters = ('Status' => 'scalar',
                   4123:     'chartoutputmode' => 'scalar',
                   4124:     'chartoutputdata' => 'scalar',
                   4125:     'Section' => 'array',
                   4126:     'StudentData' => 'array',
                   4127:     'Maps' => 'array');
                   4128: 
                   4129: Returns: both routines return nothing
                   4130: 
                   4131: =cut
                   4132: 
                   4133: #######################################################
                   4134: #######################################################
                   4135: sub store_course_settings {
                   4136:     # save to the environment
                   4137:     # appenv the same items, just to be safe
1.258     albertel 4138:     my $courseid = $env{'request.course.id'};
                   4139:     my $coursedom = $env{'course.'.$courseid.'.domain'};
1.153     matthew  4140:     my ($prefix,$Settings) = @_;
                   4141:     my %SaveHash;
                   4142:     my %AppHash;
                   4143:     while (my ($setting,$type) = each(%$Settings)) {
1.176     albertel 4144:         my $basename = 'internal.'.$prefix.'.'.$setting;
1.153     matthew  4145:         my $envname = 'course.'.$courseid.'.'.$basename;
1.258     albertel 4146:         if (exists($env{'form.'.$setting})) {
1.153     matthew  4147:             # Save this value away
                   4148:             if ($type eq 'scalar' &&
1.258     albertel 4149:                 (! exists($env{$envname}) || 
                   4150:                  $env{$envname} ne $env{'form.'.$setting})) {
                   4151:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   4152:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  4153:             } elsif ($type eq 'array') {
                   4154:                 my $stored_form;
1.258     albertel 4155:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  4156:                     $stored_form = join(',',
                   4157:                                         map {
                   4158:                                             &Apache::lonnet::escape($_);
1.258     albertel 4159:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  4160:                 } else {
                   4161:                     $stored_form = 
1.258     albertel 4162:                         &Apache::lonnet::escape($env{'form.'.$setting});
1.153     matthew  4163:                 }
                   4164:                 # Determine if the array contents are the same.
1.258     albertel 4165:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  4166:                     $SaveHash{$basename} = $stored_form;
                   4167:                     $AppHash{$envname}   = $stored_form;
                   4168:                 }
                   4169:             }
                   4170:         }
                   4171:     }
                   4172:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
                   4173:                                           $coursedom,
1.258     albertel 4174:                                           $env{'course.'.$courseid.'.num'});
1.153     matthew  4175:     if ($put_result !~ /^(ok|delayed)/) {
                   4176:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   4177:                                  'got error:'.$put_result);
                   4178:     }
                   4179:     # Make sure these settings stick around in this session, too
                   4180:     &Apache::lonnet::appenv(%AppHash);
                   4181:     return;
                   4182: }
                   4183: 
                   4184: sub restore_course_settings {
1.258     albertel 4185:     my $courseid = $env{'request.course.id'};
1.153     matthew  4186:     my ($prefix,$Settings) = @_;
                   4187:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 4188:         next if (exists($env{'form.'.$setting}));
1.176     albertel 4189:         my $envname = 'course.'.$courseid.'.internal.'.$prefix.
1.153     matthew  4190:             '.'.$setting;
1.258     albertel 4191:         if (exists($env{$envname})) {
1.153     matthew  4192:             if ($type eq 'scalar') {
1.258     albertel 4193:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  4194:             } elsif ($type eq 'array') {
1.258     albertel 4195:                 $env{'form.'.$setting} = [ 
1.153     matthew  4196:                                            map { 
                   4197:                                                &Apache::lonnet::unescape($_); 
1.258     albertel 4198:                                            } split(',',$env{$envname})
1.153     matthew  4199:                                            ];
                   4200:             }
                   4201:         }
                   4202:     }
1.127     matthew  4203: }
                   4204: 
                   4205: ############################################################
                   4206: ############################################################
1.154     albertel 4207: 
                   4208: sub propath {
                   4209:     my ($udom,$uname)=@_;
                   4210:     $udom=~s/\W//g;
                   4211:     $uname=~s/\W//g;
                   4212:     my $subdir=$uname.'__';
                   4213:     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
                   4214:     my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
                   4215:     return $proname;
1.156     albertel 4216: } 
                   4217: 
                   4218: sub icon {
                   4219:     my ($file)=@_;
1.168     albertel 4220:     my $curfext = (split(/\./,$file))[-1];
                   4221:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 4222:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 4223:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   4224: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   4225: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   4226: 	            $curfext.".gif") {
                   4227: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   4228: 		$curfext.".gif";
                   4229: 	}
                   4230:     }
1.249     albertel 4231:     return &lonhttpdurl($iconname);
1.154     albertel 4232: } 
1.84      albertel 4233: 
1.215     albertel 4234: sub lonhttpdurl {
                   4235:     my ($url)=@_;
                   4236:     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   4237:     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
                   4238:     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
                   4239: }
                   4240: 
1.213     albertel 4241: sub connection_aborted {
                   4242:     my ($r)=@_;
                   4243:     $r->print(" ");$r->rflush();
                   4244:     my $c = $r->connection;
                   4245:     return $c->aborted();
                   4246: }
                   4247: 
1.221     foxr     4248: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     4249: #    strings as 'strings'.
                   4250: sub escape_single {
1.221     foxr     4251:     my ($input) = @_;
1.223     albertel 4252:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     4253:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   4254:     return $input;
                   4255: }
1.223     albertel 4256: 
1.222     foxr     4257: #  Same as escape_single, but escape's "'s  This 
                   4258: #  can be used for  "strings"
                   4259: sub escape_double {
                   4260:     my ($input) = @_;
                   4261:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   4262:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   4263:     return $input;
                   4264: }
1.223     albertel 4265:  
1.222     foxr     4266: #   Escapes the last element of a full URL.
                   4267: sub escape_url {
                   4268:     my ($url)   = @_;
1.238     raeburn  4269:     my @urlslices = split(/\//, $url,-1);
1.223     albertel 4270:     my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
                   4271:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     4272: }
1.41      ng       4273: =pod
                   4274: 
                   4275: =back
                   4276: 
1.112     bowersj2 4277: =cut
1.41      ng       4278: 
1.112     bowersj2 4279: 1;
                   4280: __END__;
1.41      ng       4281: 

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