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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.433   ! albertel    4: # $Id: loncommon.pm,v 1.432 2006/07/19 10:52:27 albertel Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.117     www        62: use Apache::lonlocal;
1.139     matthew    63: use HTML::Entities;
1.334     albertel   64: use Apache::lonhtmlcommon();
                     65: use Apache::loncoursedata();
1.344     albertel   66: use Apache::lontexconvert();
1.369     www        67: use LONCAPA;
1.117     www        68: 
1.22      www        69: my $readit;
                     70: 
1.157     matthew    71: ##
                     72: ## Global Variables
                     73: ##
1.46      matthew    74: 
1.20      www        75: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41   76: my %language;
1.124     www        77: my %supported_language;
1.12      harris41   78: my %cprtag;
1.192     taceyjo1   79: my %scprtag;
1.351     www        80: my %fe; my %fd; my %fm;
1.41      ng         81: my %category_extensions;
1.12      harris41   82: 
1.63      www        83: # ---------------------------------------------- Designs
                     84: 
                     85: my %designhash;
                     86: 
1.46      matthew    87: # ---------------------------------------------- Thesaurus variables
1.144     matthew    88: #
                     89: # %Keywords:
                     90: #      A hash used by &keyword to determine if a word is considered a keyword.
                     91: # $thesaurus_db_file 
                     92: #      Scalar containing the full path to the thesaurus database.
1.46      matthew    93: 
                     94: my %Keywords;
                     95: my $thesaurus_db_file;
                     96: 
1.144     matthew    97: #
                     98: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                     99: # thesaurus.tab, and filecategories.tab.
                    100: #
1.18      www       101: BEGIN {
1.46      matthew   102:     # Variable initialization
                    103:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    104:     #
1.22      www       105:     unless ($readit) {
1.12      harris41  106: # ------------------------------------------------------------------- languages
                    107:     {
1.158     raeburn   108:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    109:                                    '/language.tab';
                    110:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  111:             while (my $line = <$fh>) {
                    112:                 next if ($line=~/^\#/);
                    113:                 chomp($line);
                    114:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   115:                 $language{$key}=$val.' - '.$enc;
                    116:                 if ($sup) {
                    117:                     $supported_language{$key}=$sup;
                    118:                 }
                    119:             }
                    120:             close($fh);
                    121:         }
1.12      harris41  122:     }
                    123: # ------------------------------------------------------------------ copyrights
                    124:     {
1.158     raeburn   125:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    126:                                   '/copyright.tab';
                    127:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  128:             while (my $line = <$fh>) {
                    129:                 next if ($line=~/^\#/);
                    130:                 chomp($line);
                    131:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   132:                 $cprtag{$key}=$val;
                    133:             }
                    134:             close($fh);
                    135:         }
1.12      harris41  136:     }
1.351     www       137: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  138:     {
                    139:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    140:                                   '/source_copyright.tab';
                    141:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  142:             while (my $line = <$fh>) {
                    143:                 next if ($line =~ /^\#/);
                    144:                 chomp($line);
                    145:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  146:                 $scprtag{$key}=$val;
                    147:             }
                    148:             close($fh);
                    149:         }
                    150:     }
1.63      www       151: 
                    152: # -------------------------------------------------------------- domain designs
                    153: 
                    154:     my $filename;
                    155:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                    156:     opendir(DIR,$designdir);
                    157:     while ($filename=readdir(DIR)) {
1.271     albertel  158: 	if ($filename!~/\.tab$/) { next; }
1.63      www       159: 	my ($domain)=($filename=~/^(\w+)\./);
1.271     albertel  160: 	{
                    161: 	    my $designfile = $designdir.'/'.$filename;
                    162: 	    if ( open (my $fh,"<$designfile") ) {
1.356     albertel  163: 		while (my $line = <$fh>) {
                    164: 		    next if ($line =~ /^\#/);
                    165: 		    chomp($line);
                    166: 		    my ($key,$val)=(split(/\=/,$line));
1.271     albertel  167: 		    if ($val) { $designhash{$domain.'.'.$key}=$val; }
                    168: 		}
                    169: 		close($fh);
                    170: 	    }
                    171: 	}
1.63      www       172: 
                    173:     }
                    174:     closedir(DIR);
                    175: 
                    176: 
1.15      harris41  177: # ------------------------------------------------------------- file categories
                    178:     {
1.158     raeburn   179:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    180:                                   '/filecategories.tab';
                    181:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  182: 	    while (my $line = <$fh>) {
                    183: 		next if ($line =~ /^\#/);
                    184: 		chomp($line);
                    185:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   186:                 push @{$category_extensions{lc($category)}},$extension;
                    187:             }
                    188:             close($fh);
                    189:         }
                    190: 
1.15      harris41  191:     }
1.12      harris41  192: # ------------------------------------------------------------------ file types
                    193:     {
1.158     raeburn   194:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    195:                '/filetypes.tab';
                    196:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  197:             while (my $line = <$fh>) {
                    198: 		next if ($line =~ /^\#/);
                    199: 		chomp($line);
                    200:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   201:                 if ($descr ne '') {
                    202:                     $fe{$ending}=lc($emb);
                    203:                     $fd{$ending}=$descr;
1.351     www       204:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   205:                 }
                    206:             }
                    207:             close($fh);
                    208:         }
1.12      harris41  209:     }
1.22      www       210:     &Apache::lonnet::logthis(
1.46      matthew   211:               "<font color=yellow>INFO: Read file types</font>");
1.22      www       212:     $readit=1;
1.46      matthew   213:     }  # end of unless($readit) 
1.32      matthew   214:     
                    215: }
1.112     bowersj2  216: 
1.42      matthew   217: ###############################################################
                    218: ##           HTML and Javascript Helper Functions            ##
                    219: ###############################################################
                    220: 
                    221: =pod 
                    222: 
1.112     bowersj2  223: =head1 HTML and Javascript Functions
1.42      matthew   224: 
1.112     bowersj2  225: =over 4
                    226: 
                    227: =item * browser_and_searcher_javascript ()
                    228: 
                    229: X<browsing, javascript>X<searching, javascript>Returns a string
                    230: containing javascript with two functions, C<openbrowser> and
                    231: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    232: tags.
1.42      matthew   233: 
1.112     bowersj2  234: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   235: 
                    236: inputs: formname, elementname, only, omit
                    237: 
                    238: formname and elementname indicate the name of the html form and name of
                    239: the element that the results of the browsing selection are to be placed in. 
                    240: 
                    241: Specifying 'only' will restrict the browser to displaying only files
1.185     www       242: with the given extension.  Can be a comma separated list.
1.42      matthew   243: 
                    244: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       245: with the given extension.  Can be a comma separated list.
1.42      matthew   246: 
1.112     bowersj2  247: =item * opensearcher(formname, elementname) [javascript]
1.42      matthew   248: 
                    249: Inputs: formname, elementname
                    250: 
                    251: formname and elementname specify the name of the html form and the name
                    252: of the element the selection from the search results will be placed in.
                    253: 
                    254: =cut
                    255: 
                    256: sub browser_and_searcher_javascript {
1.199     albertel  257:     my ($mode)=@_;
                    258:     if (!defined($mode)) { $mode='edit'; }
1.170     www       259:     my $resurl=&lastresurl();
1.42      matthew   260:     return <<END;
1.219     albertel  261: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   262:     var editbrowser = null;
1.135     albertel  263:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       264:         var url = '$resurl/?';
1.42      matthew   265:         if (editbrowser == null) {
                    266:             url += 'launch=1&';
                    267:         }
                    268:         url += 'catalogmode=interactive&';
1.199     albertel  269:         url += 'mode=$mode&';
1.42      matthew   270:         url += 'form=' + formname + '&';
                    271:         if (only != null) {
                    272:             url += 'only=' + only + '&';
1.217     albertel  273:         } else {
                    274:             url += 'only=&';
                    275: 	}
1.42      matthew   276:         if (omit != null) {
                    277:             url += 'omit=' + omit + '&';
1.217     albertel  278:         } else {
                    279:             url += 'omit=&';
                    280: 	}
1.135     albertel  281:         if (titleelement != null) {
                    282:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  283:         } else {
                    284: 	    url += 'titleelement=&';
                    285: 	}
1.42      matthew   286:         url += 'element=' + elementname + '';
                    287:         var title = 'Browser';
1.217     albertel  288:         var options = 'scrollbars=1,resizable=1,menubar=1,location=1';
1.42      matthew   289:         options += ',width=700,height=600';
                    290:         editbrowser = open(url,title,options,'1');
                    291:         editbrowser.focus();
                    292:     }
                    293:     var editsearcher;
1.135     albertel  294:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   295:         var url = '/adm/searchcat?';
                    296:         if (editsearcher == null) {
                    297:             url += 'launch=1&';
                    298:         }
                    299:         url += 'catalogmode=interactive&';
1.199     albertel  300:         url += 'mode=$mode&';
1.42      matthew   301:         url += 'form=' + formname + '&';
1.135     albertel  302:         if (titleelement != null) {
                    303:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  304:         } else {
                    305: 	    url += 'titleelement=&';
                    306: 	}
1.42      matthew   307:         url += 'element=' + elementname + '';
                    308:         var title = 'Search';
                    309:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    310:         options += ',width=700,height=600';
                    311:         editsearcher = open(url,title,options,'1');
                    312:         editsearcher.focus();
                    313:     }
1.219     albertel  314: // END LON-CAPA Internal -->
1.42      matthew   315: END
1.170     www       316: }
                    317: 
                    318: sub lastresurl {
1.258     albertel  319:     if ($env{'environment.lastresurl'}) {
                    320: 	return $env{'environment.lastresurl'}
1.170     www       321:     } else {
                    322: 	return '/res';
                    323:     }
                    324: }
                    325: 
                    326: sub storeresurl {
                    327:     my $resurl=&Apache::lonnet::clutter(shift);
                    328:     unless ($resurl=~/^\/res/) { return 0; }
                    329:     $resurl=~s/\/$//;
                    330:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
                    331:     &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
                    332:     return 1;
1.42      matthew   333: }
                    334: 
1.74      www       335: sub studentbrowser_javascript {
1.111     www       336:    unless (
1.258     albertel  337:             (($env{'request.course.id'}) && 
1.302     albertel  338:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    339: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    340: 					  '/'.$env{'request.course.sec'})
                    341: 	      ))
1.258     albertel  342:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       343:           ) { return ''; }  
1.74      www       344:    return (<<'ENDSTDBRW');
                    345: <script type="text/javascript" language="Javascript" >
                    346:     var stdeditbrowser;
1.111     www       347:     function openstdbrowser(formname,uname,udom,roleflag) {
1.74      www       348:         var url = '/adm/pickstudent?';
                    349:         var filter;
                    350:         eval('filter=document.'+formname+'.'+uname+'.value;');
                    351:         if (filter != null) {
                    352:            if (filter != '') {
                    353:                url += 'filter='+filter+'&';
                    354: 	   }
                    355:         }
                    356:         url += 'form=' + formname + '&unameelement='+uname+
                    357:                                     '&udomelement='+udom;
1.111     www       358: 	if (roleflag) { url+="&roles=1"; }
1.102     www       359:         var title = 'Student_Browser';
1.74      www       360:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    361:         options += ',width=700,height=600';
                    362:         stdeditbrowser = open(url,title,options,'1');
                    363:         stdeditbrowser.focus();
                    364:     }
                    365: </script>
                    366: ENDSTDBRW
                    367: }
1.42      matthew   368: 
1.74      www       369: sub selectstudent_link {
1.111     www       370:    my ($form,$unameele,$udomele)=@_;
1.258     albertel  371:    if ($env{'request.course.id'}) {  
1.302     albertel  372:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    373: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    374: 					'/'.$env{'request.course.sec'})) {
1.111     www       375: 	   return '';
                    376:        }
                    377:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       378:         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74      www       379:    }
1.258     albertel  380:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111     www       381:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       382:         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111     www       383:    }
                    384:    return '';
1.91      www       385: }
                    386: 
                    387: sub coursebrowser_javascript {
1.234     raeburn   388:     my ($domainfilter)=@_;
1.377     raeburn   389:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.128     albertel  390:    return (<<ENDSTDBRW);
1.91      www       391: <script type="text/javascript" language="Javascript" >
                    392:     var stdeditbrowser;
1.377     raeburn   393:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       394:         var url = '/adm/pickcourse?';
                    395:         var filter;
                    396:         if (filter != null) {
                    397:            if (filter != '') {
                    398:                url += 'filter='+filter+'&';
                    399: 	   }
                    400:         }
1.128     albertel  401:         var domainfilter='$domainfilter';
                    402:         if (domainfilter != null) {
                    403:            if (domainfilter != '') {
                    404:                url += 'domainfilter='+domainfilter+'&';
                    405: 	   }
                    406:         }
1.91      www       407:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  408: 	                            '&cdomelement='+udom+
                    409:                                     '&cnameelement='+desc;
1.234     raeburn   410:         if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
                    411:             url += '&roleelement='+extra_element;
                    412:             if (domainfilter == null || domainfilter == '') {
                    413:                 url += '&domainfilter='+extra_element;
                    414:             }
1.230     raeburn   415:         }
1.293     raeburn   416:         if (multflag !=null && multflag != '') {
                    417:             url += '&multiple='+multflag;
                    418:         }
1.377     raeburn   419:         if (crstype == 'Course/Group') {
                    420:             if (formname == 'cu') {
                    421:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    422:                 if (crstype == "") {
                    423:                     alert("$crs_or_grp_alert");
                    424:                     return;
                    425:                 }
                    426:             }
                    427:         }
                    428:         if (crstype !=null && crstype != '') {
                    429:             url += '&type='+crstype;
                    430:         }
1.102     www       431:         var title = 'Course_Browser';
1.91      www       432:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    433:         options += ',width=700,height=600';
                    434:         stdeditbrowser = open(url,title,options,'1');
                    435:         stdeditbrowser.focus();
                    436:     }
                    437: </script>
                    438: ENDSTDBRW
                    439: }
                    440: 
                    441: sub selectcourse_link {
1.377     raeburn   442:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.91      www       443:     return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
1.377     raeburn   444:         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select [_1]',$selecttype)."</a>";
1.74      www       445: }
1.42      matthew   446: 
1.273     raeburn   447: sub check_uncheck_jscript {
                    448:     my $jscript = <<"ENDSCRT";
                    449: function checkAll(field) {
                    450:     if (field.length > 0) {
                    451:         for (i = 0; i < field.length; i++) {
                    452:             field[i].checked = true ;
                    453:         }
                    454:     } else {
                    455:         field.checked = true
                    456:     }
                    457: }
                    458:  
                    459: function uncheckAll(field) {
                    460:     if (field.length > 0) {
                    461:         for (i = 0; i < field.length; i++) {
                    462:             field[i].checked = false ;
                    463:         }     } else {
                    464:         field.checked = false ;
                    465:     }
                    466: }
                    467: ENDSCRT
                    468:     return $jscript;
                    469: }
                    470: 
                    471: 
1.42      matthew   472: =pod
1.36      matthew   473: 
1.112     bowersj2  474: =item * linked_select_forms(...)
1.36      matthew   475: 
                    476: linked_select_forms returns a string containing a <script></script> block
                    477: and html for two <select> menus.  The select menus will be linked in that
                    478: changing the value of the first menu will result in new values being placed
                    479: in the second menu.  The values in the select menu will appear in alphabetical
                    480: order.
                    481: 
                    482: linked_select_forms takes the following ordered inputs:
                    483: 
                    484: =over 4
                    485: 
1.112     bowersj2  486: =item * $formname, the name of the <form> tag
1.36      matthew   487: 
1.112     bowersj2  488: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   489: 
1.112     bowersj2  490: =item * $firstdefault, the default value for the first menu
1.36      matthew   491: 
1.112     bowersj2  492: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   493: 
1.112     bowersj2  494: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   495: 
1.112     bowersj2  496: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   497: 
1.41      ng        498: =back 
                    499: 
1.36      matthew   500: Below is an example of such a hash.  Only the 'text', 'default', and 
                    501: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    502: values for the first select menu.  The text that coincides with the 
1.41      ng        503: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   504: and text for the second menu are given in the hash pointed to by 
                    505: $menu{$choice1}->{'select2'}.  
                    506: 
1.112     bowersj2  507:  my %menu = ( A1 => { text =>"Choice A1" ,
                    508:                        default => "B3",
                    509:                        select2 => { 
                    510:                            B1 => "Choice B1",
                    511:                            B2 => "Choice B2",
                    512:                            B3 => "Choice B3",
                    513:                            B4 => "Choice B4"
                    514:                            }
                    515:                    },
                    516:                A2 => { text =>"Choice A2" ,
                    517:                        default => "C2",
                    518:                        select2 => { 
                    519:                            C1 => "Choice C1",
                    520:                            C2 => "Choice C2",
                    521:                            C3 => "Choice C3"
                    522:                            }
                    523:                    },
                    524:                A3 => { text =>"Choice A3" ,
                    525:                        default => "D6",
                    526:                        select2 => { 
                    527:                            D1 => "Choice D1",
                    528:                            D2 => "Choice D2",
                    529:                            D3 => "Choice D3",
                    530:                            D4 => "Choice D4",
                    531:                            D5 => "Choice D5",
                    532:                            D6 => "Choice D6",
                    533:                            D7 => "Choice D7"
                    534:                            }
                    535:                    }
                    536:                );
1.36      matthew   537: 
                    538: =cut
                    539: 
                    540: sub linked_select_forms {
                    541:     my ($formname,
                    542:         $middletext,
                    543:         $firstdefault,
                    544:         $firstselectname,
                    545:         $secondselectname, 
                    546:         $hashref
                    547:         ) = @_;
                    548:     my $second = "document.$formname.$secondselectname";
                    549:     my $first = "document.$formname.$firstselectname";
                    550:     # output the javascript to do the changing
                    551:     my $result = '';
1.219     albertel  552:     $result.="<script type=\"text/javascript\">\n";
1.36      matthew   553:     $result.="var select2data = new Object();\n";
                    554:     $" = '","';
                    555:     my $debug = '';
                    556:     foreach my $s1 (sort(keys(%$hashref))) {
                    557:         $result.="select2data.d_$s1 = new Object();\n";        
                    558:         $result.="select2data.d_$s1.def = new String('".
                    559:             $hashref->{$s1}->{'default'}."');\n";
                    560:         $result.="select2data.d_$s1.values = new Array(";        
                    561:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
                    562:         $result.="\"@s2values\");\n";
                    563:         $result.="select2data.d_$s1.texts = new Array(";        
                    564:         my @s2texts;
                    565:         foreach my $value (@s2values) {
                    566:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    567:         }
                    568:         $result.="\"@s2texts\");\n";
                    569:     }
                    570:     $"=' ';
                    571:     $result.= <<"END";
                    572: 
                    573: function select1_changed() {
                    574:     // Determine new choice
                    575:     var newvalue = "d_" + $first.value;
                    576:     // update select2
                    577:     var values     = select2data[newvalue].values;
                    578:     var texts      = select2data[newvalue].texts;
                    579:     var select2def = select2data[newvalue].def;
                    580:     var i;
                    581:     // out with the old
                    582:     for (i = 0; i < $second.options.length; i++) {
                    583:         $second.options[i] = null;
                    584:     }
                    585:     // in with the nuclear
                    586:     for (i=0;i<values.length; i++) {
                    587:         $second.options[i] = new Option(values[i]);
1.143     matthew   588:         $second.options[i].value = values[i];
1.36      matthew   589:         $second.options[i].text = texts[i];
                    590:         if (values[i] == select2def) {
                    591:             $second.options[i].selected = true;
                    592:         }
                    593:     }
                    594: }
                    595: </script>
                    596: END
                    597:     # output the initial values for the selection lists
                    598:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
                    599:     foreach my $value (sort(keys(%$hashref))) {
                    600:         $result.="    <option value=\"$value\" ";
1.253     albertel  601:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       602:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   603:     }
                    604:     $result .= "</select>\n";
                    605:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    606:     $result .= $middletext;
                    607:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    608:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
                    609:     foreach my $value (sort(keys(%select2))) {
                    610:         $result.="    <option value=\"$value\" ";        
1.253     albertel  611:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       612:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   613:     }
                    614:     $result .= "</select>\n";
                    615:     #    return $debug;
                    616:     return $result;
                    617: }   #  end of sub linked_select_forms {
                    618: 
1.45      matthew   619: =pod
1.44      bowersj2  620: 
1.112     bowersj2  621: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44      bowersj2  622: 
1.112     bowersj2  623: Returns a string corresponding to an HTML link to the given help
                    624: $topic, where $topic corresponds to the name of a .tex file in
                    625: /home/httpd/html/adm/help/tex, with underscores replaced by
                    626: spaces. 
                    627: 
                    628: $text will optionally be linked to the same topic, allowing you to
                    629: link text in addition to the graphic. If you do not want to link
                    630: text, but wish to specify one of the later parameters, pass an
                    631: empty string. 
                    632: 
                    633: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    634: the link will not open a new window. If false, the link will open
                    635: a new window using Javascript. (Default is false.) 
                    636: 
                    637: $width and $height are optional numerical parameters that will
                    638: override the width and height of the popped up window, which may
                    639: be useful for certain help topics with big pictures included. 
1.44      bowersj2  640: 
                    641: =cut
                    642: 
                    643: sub help_open_topic {
1.48      bowersj2  644:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    645:     $text = "" if (not defined $text);
1.44      bowersj2  646:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  647:     if ($env{'browser.interface'} eq 'textual' ||
                    648: 	$env{'environment.remote'} eq 'off' ) {
1.79      www       649: 	$stayOnPage=1;
                    650:     }
1.44      bowersj2  651:     $width = 350 if (not defined $width);
                    652:     $height = 400 if (not defined $height);
                    653:     my $filename = $topic;
                    654:     $filename =~ s/ /_/g;
                    655: 
1.48      bowersj2  656:     my $template = "";
                    657:     my $link;
1.159     www       658: 
                    659:     $topic=~s/\W/\_/g;
1.44      bowersj2  660: 
                    661:     if (!$stayOnPage)
                    662:     {
1.72      bowersj2  663: 	$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  664:     }
                    665:     else
                    666:     {
1.48      bowersj2  667: 	$link = "/adm/help/${filename}.hlp";
                    668:     }
                    669: 
                    670:     # Add the text
                    671:     if ($text ne "")
                    672:     {
1.77      www       673: 	$template .= 
                    674:   "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.78      www       675:   "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48      bowersj2  676:     }
                    677: 
                    678:     # Add the graphic
1.179     matthew   679:     my $title = &mt('Online Help');
1.215     albertel  680:     my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48      bowersj2  681:     $template .= <<"ENDTEMPLATE";
1.218     albertel  682:  <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44      bowersj2  683: ENDTEMPLATE
1.78      www       684:     if ($text ne '') { $template.='</td></tr></table>' };
1.44      bowersj2  685:     return $template;
                    686: 
1.106     bowersj2  687: }
                    688: 
                    689: # This is a quicky function for Latex cheatsheet editing, since it 
                    690: # appears in at least four places
                    691: sub helpLatexCheatsheet {
                    692:     my $other = shift;
                    693:     my $addOther = '';
                    694:     if ($other) {
                    695: 	$addOther = Apache::loncommon::help_open_topic($other, shift,
                    696: 						       undef, undef, 600) .
                    697: 							   '</td><td>';
                    698:     }
                    699:     return '<table><tr><td>'.
                    700: 	$addOther .
                    701: 	&Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
                    702: 					    undef,undef,600)
                    703: 	.'</td><td>'.
                    704: 	&Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
                    705: 					    undef,undef,600)
                    706: 	.'</td></tr></table>';
1.172     www       707: }
                    708: 
1.430     albertel  709: sub general_help {
                    710:     my $helptopic='Student_Intro';
                    711:     if ($env{'request.role'}=~/^(ca|au)/) {
                    712: 	$helptopic='Authoring_Intro';
                    713:     } elsif ($env{'request.role'}=~/^cc/) {
                    714: 	$helptopic='Course_Coordination_Intro';
                    715:     }
                    716:     return $helptopic;
                    717: }
                    718: 
                    719: sub update_help_link {
                    720:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                    721:     my $origurl = $ENV{'REQUEST_URI'};
                    722:     $origurl=~s|^/~|/priv/|;
                    723:     my $timestamp = time;
                    724:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                    725:         $$datum = &escape($$datum);
                    726:     }
                    727: 
                    728:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                    729:     my $output .= <<"ENDOUTPUT";
                    730: <script type="text/javascript">
                    731: // <!-- BEGIN LON-CAPA Internal
                    732: banner_link = '$banner_link';
                    733: // END LON-CAPA Internal -->
                    734: </script>
                    735: ENDOUTPUT
                    736:     return $output;
                    737: }
                    738: 
                    739: # now just updates the help link and generates a blue icon
1.193     raeburn   740: sub help_open_menu {
1.430     albertel  741:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
                    742: 	= @_;
                    743:     
                    744:     $stayOnPage = 0 if (not defined $stayOnPage);
                    745:     if ($env{'browser.interface'} eq 'textual' ||
                    746: 	$env{'environment.remote'} eq 'off' ) {
                    747: 	$stayOnPage=1;
                    748:     }
                    749:     my $output;
                    750:     if ($component_help) {
                    751: 	if (!$text) {
                    752: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                    753: 				       $width,$height);
                    754: 	} else {
                    755: 	    my $help_text;
                    756: 	    $help_text=&unescape($topic);
                    757: 	    $output='<table><tr><td>'.
                    758: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                    759: 				 $width,$height).'</td></tr></table>';
                    760: 	}
                    761:     }
                    762:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                    763:     return $output.$banner_link;
                    764: }
                    765: 
                    766: sub top_nav_help {
                    767:     my ($text) = @_;
                    768: 
                    769:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height);
                    770:    
1.193     raeburn   771:     $text = "" if (not defined $text);
                    772:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  773:     if ($env{'browser.interface'} eq 'textual' ||
                    774:         $env{'environment.remote'} eq 'off' ) {
1.193     raeburn   775:         $stayOnPage=1;
                    776:     }
                    777:     $width = 620 if (not defined $width);
                    778:     $height = 600 if (not defined $height);
                    779:     my $link='';
1.201     raeburn   780:     my $title = &mt('Get help');
1.430     albertel  781:     if ($stayOnPage) {
                    782: 	$link = "javascript:helpMenu('display')";
1.195     albertel  783:     } else {
1.430     albertel  784:         $link = "javascript:helpMenu('open')";
1.193     raeburn   785:     }
1.430     albertel  786:     my $helptopic=&general_help();
                    787:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                    788:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.196     albertel  789:     my $template;
1.261     albertel  790:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.215     albertel  791:     my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
1.331     albertel  792:     my $start_page =
                    793:         &Apache::loncommon::start_page('Help Menu', undef,
                    794: 				       {'frameset'    => 1,
                    795: 					'js_ready'    => 1,
                    796: 					'add_entries' => {
                    797: 					    'border' => '0',
                    798: 					    'rows'   => "105,*",},});
                    799:     my $end_page =
                    800:         &Apache::loncommon::end_page({'frameset' => 1,
                    801: 				      'js_ready' => 1,});
                    802: 
1.196     albertel  803:     $template .= <<"ENDTEMPLATE";
1.219     albertel  804:  <script type="text/javascript">
1.253     albertel  805: // <!-- BEGIN LON-CAPA Internal
                    806: // <![CDATA[
1.430     albertel  807: var banner_link = '';
1.243     raeburn   808: function helpMenu(target) {
                    809:     var caller = this;
                    810:     if (target == 'open') {
                    811:         var newWindow = null;
                    812:         try {
1.262     albertel  813:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn   814:         }
                    815:         catch(error) {
                    816:             writeHelp(caller);
                    817:             return;
                    818:         }
                    819:         if (newWindow) {
                    820:             caller = newWindow;
                    821:         }
1.193     raeburn   822:     }
1.243     raeburn   823:     writeHelp(caller);
                    824:     return;
                    825: }
                    826: function writeHelp(caller) {
1.430     albertel  827:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn   828:     caller.document.close()
                    829:     caller.focus()
1.193     raeburn   830: }
1.253     albertel  831: // ]]>
1.219     albertel  832: // END LON-CAPA Internal -->
1.193     raeburn   833:  </script>
1.430     albertel  834: $banner_link
1.431     albertel  835:  <a href="$link" title="$title">$text</a>
1.193     raeburn   836: ENDTEMPLATE
                    837:     return $template;
                    838: }
                    839: 
1.172     www       840: sub help_open_bug {
                    841:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel  842:     unless ($env{'user.adv'}) { return ''; }
1.172     www       843:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                    844:     $text = "" if (not defined $text);
                    845:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  846:     if ($env{'browser.interface'} eq 'textual' ||
                    847: 	$env{'environment.remote'} eq 'off' ) {
1.172     www       848: 	$stayOnPage=1;
                    849:     }
1.184     albertel  850:     $width = 600 if (not defined $width);
                    851:     $height = 600 if (not defined $height);
1.172     www       852: 
                    853:     $topic=~s/\W+/\+/g;
                    854:     my $link='';
                    855:     my $template='';
1.379     albertel  856:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                    857: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www       858:     if (!$stayOnPage)
                    859:     {
                    860: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                    861:     }
                    862:     else
                    863:     {
                    864: 	$link = $url;
                    865:     }
                    866:     # Add the text
                    867:     if ($text ne "")
                    868:     {
                    869: 	$template .= 
                    870:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
                    871:   "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
                    872:     }
                    873: 
                    874:     # Add the graphic
1.179     matthew   875:     my $title = &mt('Report a Bug');
1.215     albertel  876:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www       877:     $template .= <<"ENDTEMPLATE";
1.218     albertel  878:  <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www       879: ENDTEMPLATE
                    880:     if ($text ne '') { $template.='</td></tr></table>' };
                    881:     return $template;
                    882: 
                    883: }
                    884: 
                    885: sub help_open_faq {
                    886:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel  887:     unless ($env{'user.adv'}) { return ''; }
1.172     www       888:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                    889:     $text = "" if (not defined $text);
                    890:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel  891:     if ($env{'browser.interface'} eq 'textual' ||
                    892: 	$env{'environment.remote'} eq 'off' ) {
1.172     www       893: 	$stayOnPage=1;
                    894:     }
                    895:     $width = 350 if (not defined $width);
                    896:     $height = 400 if (not defined $height);
                    897: 
                    898:     $topic=~s/\W+/\+/g;
                    899:     my $link='';
                    900:     my $template='';
                    901:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                    902:     if (!$stayOnPage)
                    903:     {
                    904: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                    905:     }
                    906:     else
                    907:     {
                    908: 	$link = $url;
                    909:     }
                    910: 
                    911:     # Add the text
                    912:     if ($text ne "")
                    913:     {
                    914: 	$template .= 
1.173     www       915:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
                    916:   "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172     www       917:     }
                    918: 
                    919:     # Add the graphic
1.179     matthew   920:     my $title = &mt('View the FAQ');
1.215     albertel  921:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www       922:     $template .= <<"ENDTEMPLATE";
1.218     albertel  923:  <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www       924: ENDTEMPLATE
                    925:     if ($text ne '') { $template.='</td></tr></table>' };
                    926:     return $template;
                    927: 
1.44      bowersj2  928: }
1.37      matthew   929: 
1.180     matthew   930: ###############################################################
                    931: ###############################################################
                    932: 
1.45      matthew   933: =pod
                    934: 
1.256     matthew   935: =item * change_content_javascript():
                    936: 
                    937: This and the next function allow you to create small sections of an
                    938: otherwise static HTML page that you can update on the fly with
                    939: Javascript, even in Netscape 4.
                    940: 
                    941: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                    942: must be written to the HTML page once. It will prove the Javascript
                    943: function "change(name, content)". Calling the change function with the
                    944: name of the section 
                    945: you want to update, matching the name passed to C<changable_area>, and
                    946: the new content you want to put in there, will put the content into
                    947: that area.
                    948: 
                    949: B<Note>: Netscape 4 only reserves enough space for the changable area
                    950: to contain room for the original contents. You need to "make space"
                    951: for whatever changes you wish to make, and be B<sure> to check your
                    952: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                    953: it's adequate for updating a one-line status display, but little more.
                    954: This script will set the space to 100% width, so you only need to
                    955: worry about height in Netscape 4.
                    956: 
                    957: Modern browsers are much less limiting, and if you can commit to the
                    958: user not using Netscape 4, this feature may be used freely with
                    959: pretty much any HTML.
                    960: 
                    961: =cut
                    962: 
                    963: sub change_content_javascript {
                    964:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel  965:     if ($env{'browser.type'} eq 'netscape' &&
                    966: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew   967: 	return (<<NETSCAPE4);
                    968: 	function change(name, content) {
                    969: 	    doc = document.layers[name+"___escape"].layers[0].document;
                    970: 	    doc.open();
                    971: 	    doc.write(content);
                    972: 	    doc.close();
                    973: 	}
                    974: NETSCAPE4
                    975:     } else {
                    976: 	# Otherwise, we need to use semi-standards-compliant code
                    977: 	# (technically, "innerHTML" isn't standard but the equivalent
                    978: 	# is really scary, and every useful browser supports it
                    979: 	return (<<DOMBASED);
                    980: 	function change(name, content) {
                    981: 	    element = document.getElementById(name);
                    982: 	    element.innerHTML = content;
                    983: 	}
                    984: DOMBASED
                    985:     }
                    986: }
                    987: 
                    988: =pod
                    989: 
                    990: =item * changable_area($name, $origContent):
                    991: 
                    992: This provides a "changable area" that can be modified on the fly via
                    993: the Javascript code provided in C<change_content_javascript>. $name is
                    994: the name you will use to reference the area later; do not repeat the
                    995: same name on a given HTML page more then once. $origContent is what
                    996: the area will originally contain, which can be left blank.
                    997: 
                    998: =cut
                    999: 
                   1000: sub changable_area {
                   1001:     my ($name, $origContent) = @_;
                   1002: 
1.258     albertel 1003:     if ($env{'browser.type'} eq 'netscape' &&
                   1004: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1005: 	# If this is netscape 4, we need to use the Layer tag
                   1006: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1007:     } else {
                   1008: 	return "<span id='$name'>$origContent</span>";
                   1009:     }
                   1010: }
                   1011: 
                   1012: =pod
                   1013: 
                   1014: =back
                   1015: 
                   1016: =head1 Excel and CSV file utility routines
                   1017: 
                   1018: =over 4
                   1019: 
                   1020: =cut
                   1021: 
                   1022: ###############################################################
                   1023: ###############################################################
                   1024: 
                   1025: =pod
                   1026: 
1.112     bowersj2 1027: =item * csv_translate($text) 
1.37      matthew  1028: 
1.185     www      1029: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1030: format.
                   1031: 
                   1032: =cut
                   1033: 
1.180     matthew  1034: ###############################################################
                   1035: ###############################################################
1.37      matthew  1036: sub csv_translate {
                   1037:     my $text = shift;
                   1038:     $text =~ s/\"/\"\"/g;
1.209     albertel 1039:     $text =~ s/\n/ /g;
1.37      matthew  1040:     return $text;
                   1041: }
1.180     matthew  1042: 
                   1043: ###############################################################
                   1044: ###############################################################
                   1045: 
                   1046: =pod
                   1047: 
                   1048: =item * define_excel_formats
                   1049: 
                   1050: Define some commonly used Excel cell formats.
                   1051: 
                   1052: Currently supported formats:
                   1053: 
                   1054: =over 4
                   1055: 
                   1056: =item header
                   1057: 
                   1058: =item bold
                   1059: 
                   1060: =item h1
                   1061: 
                   1062: =item h2
                   1063: 
                   1064: =item h3
                   1065: 
1.256     matthew  1066: =item h4
                   1067: 
                   1068: =item i
                   1069: 
1.180     matthew  1070: =item date
                   1071: 
                   1072: =back
                   1073: 
                   1074: Inputs: $workbook
                   1075: 
                   1076: Returns: $format, a hash reference.
                   1077: 
                   1078: =cut
                   1079: 
                   1080: ###############################################################
                   1081: ###############################################################
                   1082: sub define_excel_formats {
                   1083:     my ($workbook) = @_;
                   1084:     my $format;
                   1085:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1086:                                                 bottom    => 1,
                   1087:                                                 align     => 'center');
                   1088:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1089:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1090:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1091:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1092:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1093:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1094:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1095:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1096:     return $format;
                   1097: }
                   1098: 
                   1099: ###############################################################
                   1100: ###############################################################
1.113     bowersj2 1101: 
                   1102: =pod
                   1103: 
1.256     matthew  1104: =item * create_workbook
1.255     matthew  1105: 
                   1106: Create an Excel worksheet.  If it fails, output message on the
                   1107: request object and return undefs.
                   1108: 
                   1109: Inputs: Apache request object
                   1110: 
                   1111: Returns (undef) on failure, 
                   1112:     Excel worksheet object, scalar with filename, and formats 
                   1113:     from &Apache::loncommon::define_excel_formats on success
                   1114: 
                   1115: =cut
                   1116: 
                   1117: ###############################################################
                   1118: ###############################################################
                   1119: sub create_workbook {
                   1120:     my ($r) = @_;
                   1121:         #
                   1122:     # Create the excel spreadsheet
                   1123:     my $filename = '/prtspool/'.
1.258     albertel 1124:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1125:         time.'_'.rand(1000000000).'.xls';
                   1126:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1127:     if (! defined($workbook)) {
                   1128:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1129:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1130:                             "This error has been logged.  ".
                   1131:                             "Please alert your LON-CAPA administrator").
                   1132:                   '</p>');
                   1133:         return (undef);
                   1134:     }
                   1135:     #
                   1136:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1137:     #
                   1138:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1139:     return ($workbook,$filename,$format);
                   1140: }
                   1141: 
                   1142: ###############################################################
                   1143: ###############################################################
                   1144: 
                   1145: =pod
                   1146: 
1.256     matthew  1147: =item * create_text_file
1.113     bowersj2 1148: 
1.256     matthew  1149: Create a file to write to and eventually make available to the usre.
                   1150: If file creation fails, outputs an error message on the request object and 
                   1151: return undefs.
1.113     bowersj2 1152: 
1.256     matthew  1153: Inputs: Apache request object, and file suffix
1.113     bowersj2 1154: 
1.256     matthew  1155: Returns (undef) on failure, 
                   1156:     Filehandle and filename on success.
1.113     bowersj2 1157: 
                   1158: =cut
                   1159: 
1.256     matthew  1160: ###############################################################
                   1161: ###############################################################
                   1162: sub create_text_file {
                   1163:     my ($r,$suffix) = @_;
                   1164:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1165:     my $fh;
                   1166:     my $filename = '/prtspool/'.
1.258     albertel 1167:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1168:         time.'_'.rand(1000000000).'.'.$suffix;
                   1169:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1170:     if (! defined($fh)) {
                   1171:         $r->log_error("Couldn't open $filename for output $!");
                   1172:         $r->print("Problems occured in creating the output file.  ".
                   1173:                   "This error has been logged.  ".
                   1174:                   "Please alert your LON-CAPA administrator.");
1.113     bowersj2 1175:     }
1.256     matthew  1176:     return ($fh,$filename)
1.113     bowersj2 1177: }
                   1178: 
                   1179: 
1.256     matthew  1180: =pod 
1.113     bowersj2 1181: 
                   1182: =back
                   1183: 
                   1184: =cut
1.37      matthew  1185: 
                   1186: ###############################################################
1.33      matthew  1187: ##        Home server <option> list generating code          ##
                   1188: ###############################################################
1.35      matthew  1189: 
1.45      matthew  1190: =pod
                   1191: 
1.112     bowersj2 1192: =head1 Home Server option list generating code
                   1193: 
                   1194: =over 4
                   1195: 
                   1196: =item * get_domains()
1.35      matthew  1197: 
                   1198: Returns an array containing each of the domains listed in the hosts.tab
                   1199: file.
                   1200: 
                   1201: =cut
                   1202: 
                   1203: #-------------------------------------------
1.34      matthew  1204: sub get_domains {
                   1205:     # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
                   1206:     my @domains;
                   1207:     my %seen;
1.356     albertel 1208:     foreach my $dom (sort(values(%Apache::lonnet::hostdom))) {
                   1209: 	push(@domains,$dom) unless $seen{$dom}++;
1.34      matthew  1210:     }
                   1211:     return @domains;
                   1212: }
1.88      www      1213: 
1.169     www      1214: # ------------------------------------------
                   1215: 
                   1216: sub domain_select {
                   1217:     my ($name,$value,$multiple)=@_;
                   1218:     my %domains=map { 
                   1219: 	$_ => $_.' '.$Apache::lonnet::domaindescription{$_} 
                   1220:     } &get_domains;
                   1221:     if ($multiple) {
                   1222: 	$domains{''}=&mt('Any domain');
1.287     albertel 1223: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1224:     } else {
                   1225: 	return &select_form($name,$value,%domains);
                   1226:     }
                   1227: }
                   1228: 
1.282     albertel 1229: #-------------------------------------------
                   1230: 
                   1231: =pod
                   1232: 
1.287     albertel 1233: =item * multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1234: 
                   1235: Returns a string containing a <select> element int multiple mode
                   1236: 
                   1237: 
                   1238: Args:
                   1239:   $name - name of the <select> element
                   1240:   $value - sclara or array ref of values that should already be selected
                   1241:   $size - number of rows long the select element is
1.283     albertel 1242:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1243:           (shown text should already have been &mt())
1.284     albertel 1244:   $order - (optional) array ref of the order to show the elments in
1.283     albertel 1245: 
1.282     albertel 1246: =cut
                   1247: 
                   1248: #-------------------------------------------
1.169     www      1249: sub multiple_select_form {
1.284     albertel 1250:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1251:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1252:     my $output='';
1.191     matthew  1253:     if (! defined($size)) {
                   1254:         $size = 4;
1.283     albertel 1255:         if (scalar(keys(%$hash))<4) {
                   1256:             $size = scalar(keys(%$hash));
1.191     matthew  1257:         }
                   1258:     }
1.169     www      1259:     $output.="\n<select name='$name' size='$size' multiple='1'>";
1.286     banghart 1260:     my @order = ref($order) ? @$order
1.284     albertel 1261:                             : sort(keys(%$hash));
                   1262:     foreach my $key (@order) {
1.356     albertel 1263:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1264:         $output.='selected="selected" ' if ($selected{$key});
                   1265:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1266:     }
                   1267:     $output.="</select>\n";
                   1268:     return $output;
                   1269: }
                   1270: 
1.88      www      1271: #-------------------------------------------
                   1272: 
                   1273: =pod
                   1274: 
1.112     bowersj2 1275: =item * select_form($defdom,$name,%hash)
1.88      www      1276: 
                   1277: Returns a string containing a <select name='$name' size='1'> form to 
                   1278: allow a user to select options from a hash option_name => displayed text.  
                   1279: See lonrights.pm for an example invocation and use.
                   1280: 
                   1281: =cut
                   1282: 
                   1283: #-------------------------------------------
                   1284: sub select_form {
                   1285:     my ($def,$name,%hash) = @_;
                   1286:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1287:     my @keys;
                   1288:     if (exists($hash{'select_form_order'})) {
                   1289: 	@keys=@{$hash{'select_form_order'}};
                   1290:     } else {
                   1291: 	@keys=sort(keys(%hash));
                   1292:     }
1.356     albertel 1293:     foreach my $key (@keys) {
                   1294:         $selectform.=
                   1295: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1296:             ($key eq $def ? 'selected="selected" ' : '').
                   1297:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1298:     }
                   1299:     $selectform.="</select>";
                   1300:     return $selectform;
                   1301: }
                   1302: 
1.167     www      1303: sub gradeleveldescription {
                   1304:     my $gradelevel=shift;
                   1305:     my %gradelevels=(0 => 'Not specified',
                   1306: 		     1 => 'Grade 1',
                   1307: 		     2 => 'Grade 2',
                   1308: 		     3 => 'Grade 3',
                   1309: 		     4 => 'Grade 4',
                   1310: 		     5 => 'Grade 5',
                   1311: 		     6 => 'Grade 6',
                   1312: 		     7 => 'Grade 7',
                   1313: 		     8 => 'Grade 8',
                   1314: 		     9 => 'Grade 9',
                   1315: 		     10 => 'Grade 10',
                   1316: 		     11 => 'Grade 11',
                   1317: 		     12 => 'Grade 12',
                   1318: 		     13 => 'Grade 13',
                   1319: 		     14 => '100 Level',
                   1320: 		     15 => '200 Level',
                   1321: 		     16 => '300 Level',
                   1322: 		     17 => '400 Level',
                   1323: 		     18 => 'Graduate Level');
                   1324:     return &mt($gradelevels{$gradelevel});
                   1325: }
                   1326: 
1.163     www      1327: sub select_level_form {
                   1328:     my ($deflevel,$name)=@_;
                   1329:     unless ($deflevel) { $deflevel=0; }
1.167     www      1330:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1331:     for (my $i=0; $i<=18; $i++) {
                   1332:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1333:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1334:                 ">".&gradeleveldescription($i)."</option>\n";
                   1335:     }
                   1336:     $selectform.="</select>";
                   1337:     return $selectform;
1.163     www      1338: }
1.167     www      1339: 
1.35      matthew  1340: #-------------------------------------------
                   1341: 
1.45      matthew  1342: =pod
                   1343: 
1.112     bowersj2 1344: =item * select_dom_form($defdom,$name,$includeempty)
1.35      matthew  1345: 
                   1346: Returns a string containing a <select name='$name' size='1'> form to 
                   1347: allow a user to select the domain to preform an operation in.  
                   1348: See loncreateuser.pm for an example invocation and use.
                   1349: 
1.90      www      1350: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1351: selected");
                   1352: 
1.35      matthew  1353: =cut
                   1354: 
                   1355: #-------------------------------------------
1.34      matthew  1356: sub select_dom_form {
1.90      www      1357:     my ($defdom,$name,$includeempty) = @_;
1.34      matthew  1358:     my @domains = get_domains();
1.90      www      1359:     if ($includeempty) { @domains=('',@domains); }
1.34      matthew  1360:     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356     albertel 1361:     foreach my $dom (@domains) {
                   1362:         $selectdomain.="<option value=\"$dom\" ".
                   1363:             ($dom eq $defdom ? 'selected="selected" ' : '').
                   1364:                 ">$dom</option>\n";
1.34      matthew  1365:     }
                   1366:     $selectdomain.="</select>";
                   1367:     return $selectdomain;
                   1368: }
                   1369: 
1.35      matthew  1370: #-------------------------------------------
                   1371: 
1.45      matthew  1372: =pod
                   1373: 
1.112     bowersj2 1374: =item * get_library_servers($domain)
1.35      matthew  1375: 
                   1376: Returns a hash which contains keys like '103l3' and values like 
                   1377: 'kirk.lite.msu.edu'.  All of the keys will be for machines in the
                   1378: given $domain.
                   1379: 
                   1380: =cut
                   1381: 
                   1382: #-------------------------------------------
1.52      matthew  1383: sub get_library_servers {
1.33      matthew  1384:     my $domain = shift;
1.52      matthew  1385:     my %library_servers;
1.356     albertel 1386:     foreach my $hostid (keys(%Apache::lonnet::libserv)) {
                   1387:         if ($Apache::lonnet::hostdom{$hostid} eq $domain) {
                   1388:             $library_servers{$hostid} = $Apache::lonnet::hostname{$hostid};
1.33      matthew  1389:         }
                   1390:     }
1.52      matthew  1391:     return %library_servers;
1.33      matthew  1392: }
                   1393: 
1.35      matthew  1394: #-------------------------------------------
                   1395: 
1.45      matthew  1396: =pod
                   1397: 
1.112     bowersj2 1398: =item * home_server_option_list($domain)
1.35      matthew  1399: 
                   1400: returns a string which contains an <option> list to be used in a 
                   1401: <select> form input.  See loncreateuser.pm for an example.
                   1402: 
                   1403: =cut
                   1404: 
                   1405: #-------------------------------------------
1.33      matthew  1406: sub home_server_option_list {
                   1407:     my $domain = shift;
1.52      matthew  1408:     my %servers = &get_library_servers($domain);
1.33      matthew  1409:     my $result = '';
1.356     albertel 1410:     foreach my $hostid (sort(keys(%servers))) {
1.33      matthew  1411:         $result.=
1.356     albertel 1412:             '<option value="'.$hostid.'">'.
                   1413: 	    $hostid.' '.$servers{$hostid}."</option>\n";
1.33      matthew  1414:     }
                   1415:     return $result;
                   1416: }
1.112     bowersj2 1417: 
                   1418: =pod
                   1419: 
                   1420: =back
                   1421: 
                   1422: =cut
1.87      matthew  1423: 
                   1424: ###############################################################
1.112     bowersj2 1425: ##                  Decoding User Agent                      ##
1.87      matthew  1426: ###############################################################
                   1427: 
                   1428: =pod
                   1429: 
1.112     bowersj2 1430: =head1 Decoding the User Agent
                   1431: 
                   1432: =over 4
                   1433: 
                   1434: =item * &decode_user_agent()
1.87      matthew  1435: 
                   1436: Inputs: $r
                   1437: 
                   1438: Outputs:
                   1439: 
                   1440: =over 4
                   1441: 
1.112     bowersj2 1442: =item * $httpbrowser
1.87      matthew  1443: 
1.112     bowersj2 1444: =item * $clientbrowser
1.87      matthew  1445: 
1.112     bowersj2 1446: =item * $clientversion
1.87      matthew  1447: 
1.112     bowersj2 1448: =item * $clientmathml
1.87      matthew  1449: 
1.112     bowersj2 1450: =item * $clientunicode
1.87      matthew  1451: 
1.112     bowersj2 1452: =item * $clientos
1.87      matthew  1453: 
                   1454: =back
                   1455: 
1.157     matthew  1456: =back 
                   1457: 
1.87      matthew  1458: =cut
                   1459: 
                   1460: ###############################################################
                   1461: ###############################################################
                   1462: sub decode_user_agent {
1.247     albertel 1463:     my ($r)=@_;
1.87      matthew  1464:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1465:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1466:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1467:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1468:     my $clientbrowser='unknown';
                   1469:     my $clientversion='0';
                   1470:     my $clientmathml='';
                   1471:     my $clientunicode='0';
                   1472:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1473:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1474: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1475: 	    $clientbrowser=$bname;
                   1476:             $httpbrowser=~/$vreg/i;
                   1477: 	    $clientversion=$1;
                   1478:             $clientmathml=($clientversion>=$minv);
                   1479:             $clientunicode=($clientversion>=$univ);
                   1480: 	}
                   1481:     }
                   1482:     my $clientos='unknown';
                   1483:     if (($httpbrowser=~/linux/i) ||
                   1484:         ($httpbrowser=~/unix/i) ||
                   1485:         ($httpbrowser=~/ux/i) ||
                   1486:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1487:     if (($httpbrowser=~/vax/i) ||
                   1488:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1489:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1490:     if (($httpbrowser=~/mac/i) ||
                   1491:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1492:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1493:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1494:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1495:             $clientunicode,$clientos,);
                   1496: }
                   1497: 
1.32      matthew  1498: ###############################################################
                   1499: ##    Authentication changing form generation subroutines    ##
                   1500: ###############################################################
                   1501: ##
                   1502: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1503: ## hash, and have reasonable default values.
                   1504: ##
                   1505: ##    formname = the name given in the <form> tag.
1.35      matthew  1506: #-------------------------------------------
                   1507: 
1.45      matthew  1508: =pod
                   1509: 
1.112     bowersj2 1510: =head1 Authentication Routines
                   1511: 
                   1512: =over 4
                   1513: 
                   1514: =item * authform_xxxxxx
1.35      matthew  1515: 
                   1516: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1517: handle some of the conveniences required for authentication forms.  
                   1518: This is not an optimal method, but it works.  
                   1519: 
                   1520: See loncreateuser.pm for invocation and use examples.
                   1521: 
                   1522: =over 4
                   1523: 
1.112     bowersj2 1524: =item * authform_header
1.35      matthew  1525: 
1.112     bowersj2 1526: =item * authform_authorwarning
1.35      matthew  1527: 
1.112     bowersj2 1528: =item * authform_nochange
1.35      matthew  1529: 
1.112     bowersj2 1530: =item * authform_kerberos
1.35      matthew  1531: 
1.112     bowersj2 1532: =item * authform_internal
1.35      matthew  1533: 
1.112     bowersj2 1534: =item * authform_filesystem
1.35      matthew  1535: 
                   1536: =back
                   1537: 
1.157     matthew  1538: =back 
                   1539: 
1.35      matthew  1540: =cut
                   1541: 
                   1542: #-------------------------------------------
1.32      matthew  1543: sub authform_header{  
                   1544:     my %in = (
                   1545:         formname => 'cu',
1.80      albertel 1546:         kerb_def_dom => '',
1.32      matthew  1547:         @_,
                   1548:     );
                   1549:     $in{'formname'} = 'document.' . $in{'formname'};
                   1550:     my $result='';
1.80      albertel 1551: 
                   1552: #---------------------------------------------- Code for upper case translation
                   1553:     my $Javascript_toUpperCase;
                   1554:     unless ($in{kerb_def_dom}) {
                   1555:         $Javascript_toUpperCase =<<"END";
                   1556:         switch (choice) {
                   1557:            case 'krb': currentform.elements[choicearg].value =
                   1558:                currentform.elements[choicearg].value.toUpperCase();
                   1559:                break;
                   1560:            default:
                   1561:         }
                   1562: END
                   1563:     } else {
                   1564:         $Javascript_toUpperCase = "";
                   1565:     }
                   1566: 
1.165     raeburn  1567:     my $radioval = "'nochange'";
1.174     matthew  1568:     if (exists($in{'curr_authtype'}) &&
                   1569:         defined($in{'curr_authtype'}) &&
                   1570:         $in{'curr_authtype'} ne '') {
                   1571:         $radioval = "'$in{'curr_authtype'}arg'";
                   1572:     }
1.165     raeburn  1573:     my $argfield = 'null';
                   1574:     if ( grep/^mode$/,(keys %in) ) {
                   1575:         if ($in{'mode'} eq 'modifycourse')  {
                   1576:             if ( grep/^curr_authtype$/,(keys %in) ) {
                   1577:                 $radioval = "'$in{'curr_authtype'}'";
                   1578:             }
                   1579:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1580:                 unless ($in{'curr_autharg'} eq '') {
                   1581:                     $argfield = "'$in{'curr_autharg'}'";
                   1582:                 }
                   1583:             }
                   1584:         }
                   1585:     }
                   1586: 
1.32      matthew  1587:     $result.=<<"END";
                   1588: var current = new Object();
1.165     raeburn  1589: current.radiovalue = $radioval;
                   1590: current.argfield = $argfield;
1.32      matthew  1591: 
                   1592: function changed_radio(choice,currentform) {
                   1593:     var choicearg = choice + 'arg';
                   1594:     // If a radio button in changed, we need to change the argfield
                   1595:     if (current.radiovalue != choice) {
                   1596:         current.radiovalue = choice;
                   1597:         if (current.argfield != null) {
                   1598:             currentform.elements[current.argfield].value = '';
                   1599:         }
                   1600:         if (choice == 'nochange') {
                   1601:             current.argfield = null;
                   1602:         } else {
                   1603:             current.argfield = choicearg;
                   1604:             switch(choice) {
                   1605:                 case 'krb': 
                   1606:                     currentform.elements[current.argfield].value = 
                   1607:                         "$in{'kerb_def_dom'}";
                   1608:                 break;
                   1609:               default:
                   1610:                 break;
                   1611:             }
                   1612:         }
                   1613:     }
                   1614:     return;
                   1615: }
1.22      www      1616: 
1.32      matthew  1617: function changed_text(choice,currentform) {
                   1618:     var choicearg = choice + 'arg';
                   1619:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 1620:         $Javascript_toUpperCase
1.32      matthew  1621:         // clear old field
                   1622:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   1623:             currentform.elements[current.argfield].value = '';
                   1624:         }
                   1625:         current.argfield = choicearg;
                   1626:     }
                   1627:     set_auth_radio_buttons(choice,currentform);
                   1628:     return;
1.20      www      1629: }
1.32      matthew  1630: 
                   1631: function set_auth_radio_buttons(newvalue,currentform) {
                   1632:     var i=0;
                   1633:     while (i < currentform.login.length) {
                   1634:         if (currentform.login[i].value == newvalue) { break; }
                   1635:         i++;
                   1636:     }
                   1637:     if (i == currentform.login.length) {
                   1638:         return;
                   1639:     }
                   1640:     current.radiovalue = newvalue;
                   1641:     currentform.login[i].checked = true;
                   1642:     return;
                   1643: }
                   1644: END
                   1645:     return $result;
                   1646: }
                   1647: 
                   1648: sub authform_authorwarning{
                   1649:     my $result='';
1.144     matthew  1650:     $result='<i>'.
                   1651:         &mt('As a general rule, only authors or co-authors should be '.
                   1652:             'filesystem authenticated '.
                   1653:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  1654:     return $result;
                   1655: }
                   1656: 
                   1657: sub authform_nochange{  
                   1658:     my %in = (
                   1659:               formname => 'document.cu',
                   1660:               kerb_def_dom => 'MSU.EDU',
                   1661:               @_,
                   1662:           );
1.281     albertel 1663:     my $result = '<label>'.&mt('[_1] Do not change login data',
1.144     matthew  1664:                      '<input type="radio" name="login" value="nochange" '.
                   1665:                      'checked="checked" onclick="'.
1.281     albertel 1666:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   1667: 	    '</label>';
1.32      matthew  1668:     return $result;
                   1669: }
                   1670: 
                   1671: sub authform_kerberos{  
                   1672:     my %in = (
                   1673:               formname => 'document.cu',
                   1674:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 1675:               kerb_def_auth => 'krb4',
1.32      matthew  1676:               @_,
                   1677:               );
1.165     raeburn  1678:     my ($check4,$check5,$krbarg);
1.80      albertel 1679:     if ($in{'kerb_def_auth'} eq 'krb5') {
                   1680:        $check5 = " checked=\"on\"";
                   1681:     } else {
                   1682:        $check4 = " checked=\"on\"";
                   1683:     }
1.165     raeburn  1684:     $krbarg = $in{'kerb_def_dom'};
                   1685: 
                   1686:     my $krbcheck = "";
                   1687:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1688:         if ($in{'curr_authtype'} =~ m/^krb/) {
                   1689:             $krbcheck = " checked=\"on\"";
                   1690:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1691:                 $krbarg = $in{'curr_autharg'};
                   1692:             }
                   1693:         }
                   1694:     }
                   1695: 
1.144     matthew  1696:     my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   1697:     my $result .= &mt
                   1698:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 1699:          '[_3] Version 4 [_4] Version 5 [_5]',
                   1700:          '<label><input type="radio" name="login" value="krb" '.
1.165     raeburn  1701:              'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.281     albertel 1702:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  1703:              'value="'.$krbarg.'" '.
1.144     matthew  1704:              'onchange="'.$jscall.'" />',
1.281     albertel 1705:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   1706:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   1707: 	 '</label>');
1.32      matthew  1708:     return $result;
                   1709: }
                   1710: 
                   1711: sub authform_internal{  
                   1712:     my %args = (
                   1713:                 formname => 'document.cu',
                   1714:                 kerb_def_dom => 'MSU.EDU',
                   1715:                 @_,
                   1716:                 );
1.165     raeburn  1717: 
                   1718:     my $intcheck = "";
                   1719:     my $intarg = 'value=""';
                   1720:     if ( grep/^curr_authtype$/,(keys %args) ) {
                   1721:         if ($args{'curr_authtype'} eq 'int') {
                   1722:             $intcheck = " checked=\"on\"";
                   1723:             if ( grep/^curr_autharg$/,(keys %args) ) {
                   1724:                 $intarg = "value=\"$args{'curr_autharg'}\"";
                   1725:             }
                   1726:         }
                   1727:     }
                   1728: 
1.144     matthew  1729:     my $jscall = "javascript:changed_radio('int',$args{'formname'});";
                   1730:     my $result.=&mt
                   1731:         ('[_1] Internally authenticated (with initial password [_2])',
1.281     albertel 1732:          '<label><input type="radio" name="login" value="int" '.$intcheck.
1.165     raeburn  1733:              ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1734:          '</label><input type="text" size="10" name="intarg" '.$intarg.
1.165     raeburn  1735:              ' onchange="'.$jscall.'" />');
1.32      matthew  1736:     return $result;
                   1737: }
                   1738: 
                   1739: sub authform_local{  
                   1740:     my %in = (
                   1741:               formname => 'document.cu',
                   1742:               kerb_def_dom => 'MSU.EDU',
                   1743:               @_,
                   1744:               );
1.165     raeburn  1745: 
                   1746:     my $loccheck = "";
                   1747:     my $locarg = 'value=""';
                   1748:     if ( grep/^curr_authtype$/,(keys %in) ) {
                   1749:         if ($in{'curr_authtype'} eq 'loc') {
                   1750:             $loccheck = " checked=\"on\"";
                   1751:             if ( grep/^curr_autharg$/,(keys %in) ) {
                   1752:                 $locarg = "value=\"$in{'curr_autharg'}\"";
                   1753:             }
                   1754:         }
                   1755:     }
                   1756: 
1.144     matthew  1757:     my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160     matthew  1758:     my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.281     albertel 1759:                     '<label><input type="radio" name="login" value="loc" '.$loccheck.
1.165     raeburn  1760:                         ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1761:                     '</label><input type="text" size="10" name="locarg" '.$locarg.
1.165     raeburn  1762:                         ' onchange="'.$jscall.'" />');
1.32      matthew  1763:     return $result;
                   1764: }
                   1765: 
                   1766: sub authform_filesystem{  
                   1767:     my %in = (
                   1768:               formname => 'document.cu',
                   1769:               kerb_def_dom => 'MSU.EDU',
                   1770:               @_,
                   1771:               );
1.144     matthew  1772:     my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   1773:     my $result.= &mt
                   1774:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 1775:          '<label><input type="radio" name="login" value="fsys" '.
1.144     matthew  1776:          'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281     albertel 1777:          '</label><input type="text" size="10" name="fsysarg" value="" '.
1.144     matthew  1778:                   'onchange="'.$jscall.'" />');
1.32      matthew  1779:     return $result;
                   1780: }
                   1781: 
1.80      albertel 1782: ###############################################################
                   1783: ##    Get Authentication Defaults for Domain                 ##
                   1784: ###############################################################
                   1785: 
                   1786: =pod
                   1787: 
1.112     bowersj2 1788: =head1 Domains and Authentication
                   1789: 
                   1790: Returns default authentication type and an associated argument as
                   1791: listed in file 'domain.tab'.
                   1792: 
                   1793: =over 4
                   1794: 
                   1795: =item * get_auth_defaults
1.80      albertel 1796: 
                   1797: get_auth_defaults($target_domain) returns the default authentication
                   1798: type and an associated argument (initial password or a kerberos domain).
                   1799: These values are stored in lonTabs/domain.tab
                   1800: 
                   1801: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
                   1802: 
                   1803: If target_domain is not found in domain.tab, returns nothing ('').
                   1804: 
                   1805: =cut
                   1806: 
                   1807: #-------------------------------------------
                   1808: sub get_auth_defaults {
                   1809:     my $domain=shift;
                   1810:     return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
                   1811: }
                   1812: ###############################################################
                   1813: ##   End Get Authentication Defaults for Domain              ##
                   1814: ###############################################################
                   1815: 
                   1816: ###############################################################
                   1817: ##    Get Kerberos Defaults for Domain                 ##
                   1818: ###############################################################
                   1819: ##
                   1820: ## Returns default kerberos version and an associated argument
                   1821: ## as listed in file domain.tab. If not listed, provides
                   1822: ## appropriate default domain and kerberos version.
                   1823: ##
                   1824: #-------------------------------------------
                   1825: 
                   1826: =pod
                   1827: 
1.112     bowersj2 1828: =item * get_kerberos_defaults
1.80      albertel 1829: 
                   1830: get_kerberos_defaults($target_domain) returns the default kerberos
                   1831: version and domain. If not found in domain.tabs, it defaults to
                   1832: version 4 and the domain of the server.
                   1833: 
                   1834: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   1835: 
                   1836: =cut
                   1837: 
                   1838: #-------------------------------------------
                   1839: sub get_kerberos_defaults {
                   1840:     my $domain=shift;
                   1841:     my ($krbdef,$krbdefdom) =
                   1842:         &Apache::loncommon::get_auth_defaults($domain);
                   1843:     unless ($krbdef =~/^krb/ && $krbdefdom) {
                   1844:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   1845:         my $krbdefdom=$1;
                   1846:         $krbdefdom=~tr/a-z/A-Z/;
                   1847:         $krbdef = "krb4";
                   1848:     }
                   1849:     return ($krbdef,$krbdefdom);
                   1850: }
1.112     bowersj2 1851: 
                   1852: =pod
                   1853: 
                   1854: =back
                   1855: 
                   1856: =cut
1.32      matthew  1857: 
1.46      matthew  1858: ###############################################################
                   1859: ##                Thesaurus Functions                        ##
                   1860: ###############################################################
1.20      www      1861: 
1.46      matthew  1862: =pod
1.20      www      1863: 
1.112     bowersj2 1864: =head1 Thesaurus Functions
                   1865: 
                   1866: =over 4
                   1867: 
                   1868: =item * initialize_keywords
1.46      matthew  1869: 
                   1870: Initializes the package variable %Keywords if it is empty.  Uses the
                   1871: package variable $thesaurus_db_file.
                   1872: 
                   1873: =cut
                   1874: 
                   1875: ###################################################
                   1876: 
                   1877: sub initialize_keywords {
                   1878:     return 1 if (scalar keys(%Keywords));
                   1879:     # If we are here, %Keywords is empty, so fill it up
                   1880:     #   Make sure the file we need exists...
                   1881:     if (! -e $thesaurus_db_file) {
                   1882:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   1883:                                  " failed because it does not exist");
                   1884:         return 0;
                   1885:     }
                   1886:     #   Set up the hash as a database
                   1887:     my %thesaurus_db;
                   1888:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1889:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1890:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   1891:                                  $thesaurus_db_file);
                   1892:         return 0;
                   1893:     } 
                   1894:     #  Get the average number of appearances of a word.
                   1895:     my $avecount = $thesaurus_db{'average.count'};
                   1896:     #  Put keywords (those that appear > average) into %Keywords
                   1897:     while (my ($word,$data)=each (%thesaurus_db)) {
                   1898:         my ($count,undef) = split /:/,$data;
                   1899:         $Keywords{$word}++ if ($count > $avecount);
                   1900:     }
                   1901:     untie %thesaurus_db;
                   1902:     # Remove special values from %Keywords.
1.356     albertel 1903:     foreach my $value ('total.count','average.count') {
                   1904:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.46      matthew  1905:     }
                   1906:     return 1;
                   1907: }
                   1908: 
                   1909: ###################################################
                   1910: 
                   1911: =pod
                   1912: 
1.112     bowersj2 1913: =item * keyword($word)
1.46      matthew  1914: 
                   1915: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   1916: than the average number of times in the thesaurus database.  Calls 
                   1917: &initialize_keywords
                   1918: 
                   1919: =cut
                   1920: 
                   1921: ###################################################
1.20      www      1922: 
                   1923: sub keyword {
1.46      matthew  1924:     return if (!&initialize_keywords());
                   1925:     my $word=lc(shift());
                   1926:     $word=~s/\W//g;
                   1927:     return exists($Keywords{$word});
1.20      www      1928: }
1.46      matthew  1929: 
                   1930: ###############################################################
                   1931: 
                   1932: =pod 
1.20      www      1933: 
1.112     bowersj2 1934: =item * get_related_words
1.46      matthew  1935: 
1.160     matthew  1936: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  1937: an array of words.  If the keyword is not in the thesaurus, an empty array
                   1938: will be returned.  The order of the words returned is determined by the
                   1939: database which holds them.
                   1940: 
                   1941: Uses global $thesaurus_db_file.
                   1942: 
                   1943: =cut
                   1944: 
                   1945: ###############################################################
                   1946: sub get_related_words {
                   1947:     my $keyword = shift;
                   1948:     my %thesaurus_db;
                   1949:     if (! -e $thesaurus_db_file) {
                   1950:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   1951:                                  "failed because the file does not exist");
                   1952:         return ();
                   1953:     }
                   1954:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 1955:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  1956:         return ();
                   1957:     } 
                   1958:     my @Words=();
1.429     www      1959:     my $count=0;
1.46      matthew  1960:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 1961: 	# The first element is the number of times
                   1962: 	# the word appears.  We do not need it now.
1.429     www      1963: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   1964: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   1965: 	my $threshold=$mostfrequentcount/10;
                   1966:         foreach my $possibleword (@RelatedWords) {
                   1967:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   1968:             if ($wordcount>$threshold) {
                   1969: 		push(@Words,$word);
                   1970:                 $count++;
                   1971:                 if ($count>10) { last; }
                   1972: 	    }
1.20      www      1973:         }
                   1974:     }
1.46      matthew  1975:     untie %thesaurus_db;
                   1976:     return @Words;
1.14      harris41 1977: }
1.46      matthew  1978: 
1.112     bowersj2 1979: =pod
                   1980: 
                   1981: =back
                   1982: 
                   1983: =cut
1.61      www      1984: 
                   1985: # -------------------------------------------------------------- Plaintext name
1.81      albertel 1986: =pod
                   1987: 
1.112     bowersj2 1988: =head1 User Name Functions
                   1989: 
                   1990: =over 4
                   1991: 
1.226     albertel 1992: =item * plainname($uname,$udom,$first)
1.81      albertel 1993: 
1.112     bowersj2 1994: Takes a users logon name and returns it as a string in
1.226     albertel 1995: "first middle last generation" form 
                   1996: if $first is set to 'lastname' then it returns it as
                   1997: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 1998: 
                   1999: =cut
1.61      www      2000: 
1.295     www      2001: 
1.81      albertel 2002: ###############################################################
1.61      www      2003: sub plainname {
1.226     albertel 2004:     my ($uname,$udom,$first)=@_;
1.295     www      2005:     my %names=&getnames($uname,$udom);
1.226     albertel 2006:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2007: 					  $names{'middlename'},
                   2008: 					  $names{'lastname'},
                   2009: 					  $names{'generation'},$first);
                   2010:     $name=~s/^\s+//;
1.62      www      2011:     $name=~s/\s+$//;
                   2012:     $name=~s/\s+/ /g;
1.353     albertel 2013:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2014:     return $name;
1.61      www      2015: }
1.66      www      2016: 
                   2017: # -------------------------------------------------------------------- Nickname
1.81      albertel 2018: =pod
                   2019: 
1.112     bowersj2 2020: =item * nickname($uname,$udom)
1.81      albertel 2021: 
                   2022: Gets a users name and returns it as a string as
                   2023: 
                   2024: "&quot;nickname&quot;"
1.66      www      2025: 
1.81      albertel 2026: if the user has a nickname or
                   2027: 
                   2028: "first middle last generation"
                   2029: 
                   2030: if the user does not
                   2031: 
                   2032: =cut
1.66      www      2033: 
                   2034: sub nickname {
                   2035:     my ($uname,$udom)=@_;
1.295     www      2036:     my %names=&getnames($uname,$udom);
1.68      albertel 2037:     my $name=$names{'nickname'};
1.66      www      2038:     if ($name) {
                   2039:        $name='&quot;'.$name.'&quot;'; 
                   2040:     } else {
                   2041:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2042: 	     $names{'lastname'}.' '.$names{'generation'};
                   2043:        $name=~s/\s+$//;
                   2044:        $name=~s/\s+/ /g;
                   2045:     }
                   2046:     return $name;
                   2047: }
                   2048: 
1.295     www      2049: sub getnames {
                   2050:     my ($uname,$udom)=@_;
1.433   ! albertel 2051:     if ($udom eq 'public' && $uname eq 'public') {
        !          2052: 	return ('lastname' => &mt('Public'));
        !          2053:     }
1.295     www      2054:     my $id=$uname.':'.$udom;
                   2055:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2056:     if ($cached) {
                   2057: 	return %{$names};
                   2058:     } else {
                   2059: 	my %loadnames=&Apache::lonnet::get('environment',
                   2060:                     ['firstname','middlename','lastname','generation','nickname'],
                   2061: 					 $udom,$uname);
                   2062: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2063: 	return %loadnames;
                   2064:     }
                   2065: }
1.61      www      2066: 
                   2067: # ------------------------------------------------------------------ Screenname
1.81      albertel 2068: 
                   2069: =pod
                   2070: 
1.112     bowersj2 2071: =item * screenname($uname,$udom)
1.81      albertel 2072: 
                   2073: Gets a users screenname and returns it as a string
                   2074: 
                   2075: =cut
1.61      www      2076: 
                   2077: sub screenname {
                   2078:     my ($uname,$udom)=@_;
1.258     albertel 2079:     if ($uname eq $env{'user.name'} &&
                   2080: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2081:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2082:     return $names{'screenname'};
1.62      www      2083: }
                   2084: 
1.212     albertel 2085: 
1.62      www      2086: # ------------------------------------------------------------- Message Wrapper
                   2087: 
                   2088: sub messagewrapper {
1.369     www      2089:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2090:     return 
1.200     matthew  2091:         '<a href="/adm/email?compose=individual&'.
1.369     www      2092:         'recname='.$username.'&recdom='.$domain.
                   2093: 	'&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200     matthew  2094:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2095: }
                   2096: # --------------------------------------------------------------- Notes Wrapper
                   2097: 
                   2098: sub noteswrapper {
                   2099:     my ($link,$un,$do)=@_;
                   2100:     return 
                   2101: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2102: }
                   2103: # ------------------------------------------------------------- Aboutme Wrapper
                   2104: 
                   2105: sub aboutmewrapper {
1.166     www      2106:     my ($link,$username,$domain,$target)=@_;
1.205     www      2107:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.200     matthew  2108: 	($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
1.62      www      2109: }
                   2110: 
                   2111: # ------------------------------------------------------------ Syllabus Wrapper
                   2112: 
                   2113: 
                   2114: sub syllabuswrapper {
1.109     matthew  2115:     my ($linktext,$coursedir,$domain,$fontcolor)=@_;
                   2116:     if ($fontcolor) { 
                   2117:         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
                   2118:     }
1.208     matthew  2119:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2120: }
1.14      harris41 2121: 
1.208     matthew  2122: sub track_student_link {
1.268     albertel 2123:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2124:     my $link ="/adm/trackstudent?";
1.208     matthew  2125:     my $title = 'View recent activity';
                   2126:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2127:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2128:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2129:         $title .= ' of this student';
1.268     albertel 2130:     } 
1.208     matthew  2131:     if (defined($target) && $target !~ /^\s*$/) {
                   2132:         $target = qq{target="$target"};
                   2133:     } else {
                   2134:         $target = '';
                   2135:     }
1.268     albertel 2136:     if ($start) { $link.='&amp;start='.$start; }
1.208     matthew  2137:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   2138: }
                   2139: 
1.112     bowersj2 2140: =pod
                   2141: 
                   2142: =back
                   2143: 
                   2144: =head1 Access .tab File Data
                   2145: 
                   2146: =over 4
                   2147: 
                   2148: =item * languageids() 
                   2149: 
                   2150: returns list of all language ids
                   2151: 
                   2152: =cut
                   2153: 
1.14      harris41 2154: sub languageids {
1.16      harris41 2155:     return sort(keys(%language));
1.14      harris41 2156: }
                   2157: 
1.112     bowersj2 2158: =pod
                   2159: 
                   2160: =item * languagedescription() 
                   2161: 
                   2162: returns description of a specified language id
                   2163: 
                   2164: =cut
                   2165: 
1.14      harris41 2166: sub languagedescription {
1.125     www      2167:     my $code=shift;
                   2168:     return  ($supported_language{$code}?'* ':'').
                   2169:             $language{$code}.
1.126     www      2170: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2171: }
                   2172: 
                   2173: sub plainlanguagedescription {
                   2174:     my $code=shift;
                   2175:     return $language{$code};
                   2176: }
                   2177: 
                   2178: sub supportedlanguagecode {
                   2179:     my $code=shift;
                   2180:     return $supported_language{$code};
1.97      www      2181: }
                   2182: 
1.112     bowersj2 2183: =pod
                   2184: 
                   2185: =item * copyrightids() 
                   2186: 
                   2187: returns list of all copyrights
                   2188: 
                   2189: =cut
                   2190: 
                   2191: sub copyrightids {
                   2192:     return sort(keys(%cprtag));
                   2193: }
                   2194: 
                   2195: =pod
                   2196: 
                   2197: =item * copyrightdescription() 
                   2198: 
                   2199: returns description of a specified copyright id
                   2200: 
                   2201: =cut
                   2202: 
                   2203: sub copyrightdescription {
1.166     www      2204:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2205: }
1.197     matthew  2206: 
                   2207: =pod
                   2208: 
1.192     taceyjo1 2209: =item * source_copyrightids() 
                   2210: 
                   2211: returns list of all source copyrights
                   2212: 
                   2213: =cut
                   2214: 
                   2215: sub source_copyrightids {
                   2216:     return sort(keys(%scprtag));
                   2217: }
                   2218: 
                   2219: =pod
                   2220: 
                   2221: =item * source_copyrightdescription() 
                   2222: 
                   2223: returns description of a specified source copyright id
                   2224: 
                   2225: =cut
                   2226: 
                   2227: sub source_copyrightdescription {
                   2228:     return &mt($scprtag{shift(@_)});
                   2229: }
1.112     bowersj2 2230: 
                   2231: =pod
                   2232: 
                   2233: =item * filecategories() 
                   2234: 
                   2235: returns list of all file categories
                   2236: 
                   2237: =cut
                   2238: 
                   2239: sub filecategories {
                   2240:     return sort(keys(%category_extensions));
                   2241: }
                   2242: 
                   2243: =pod
                   2244: 
                   2245: =item * filecategorytypes() 
                   2246: 
                   2247: returns list of file types belonging to a given file
                   2248: category
                   2249: 
                   2250: =cut
                   2251: 
                   2252: sub filecategorytypes {
1.356     albertel 2253:     my ($cat) = @_;
                   2254:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 2255: }
                   2256: 
                   2257: =pod
                   2258: 
                   2259: =item * fileembstyle() 
                   2260: 
                   2261: returns embedding style for a specified file type
                   2262: 
                   2263: =cut
                   2264: 
                   2265: sub fileembstyle {
                   2266:     return $fe{lc(shift(@_))};
1.169     www      2267: }
                   2268: 
1.351     www      2269: sub filemimetype {
                   2270:     return $fm{lc(shift(@_))};
                   2271: }
                   2272: 
1.169     www      2273: 
                   2274: sub filecategoryselect {
                   2275:     my ($name,$value)=@_;
1.189     matthew  2276:     return &select_form($value,$name,
1.169     www      2277: 			'' => &mt('Any category'),
                   2278: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 2279: }
                   2280: 
                   2281: =pod
                   2282: 
                   2283: =item * filedescription() 
                   2284: 
                   2285: returns description for a specified file type
                   2286: 
                   2287: =cut
                   2288: 
                   2289: sub filedescription {
1.188     matthew  2290:     my $file_description = $fd{lc(shift())};
                   2291:     $file_description =~ s:([\[\]]):~$1:g;
                   2292:     return &mt($file_description);
1.112     bowersj2 2293: }
                   2294: 
                   2295: =pod
                   2296: 
                   2297: =item * filedescriptionex() 
                   2298: 
                   2299: returns description for a specified file type with
                   2300: extra formatting
                   2301: 
                   2302: =cut
                   2303: 
                   2304: sub filedescriptionex {
                   2305:     my $ex=shift;
1.188     matthew  2306:     my $file_description = $fd{lc($ex)};
                   2307:     $file_description =~ s:([\[\]]):~$1:g;
                   2308:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 2309: }
                   2310: 
                   2311: # End of .tab access
                   2312: =pod
                   2313: 
                   2314: =back
                   2315: 
                   2316: =cut
                   2317: 
                   2318: # ------------------------------------------------------------------ File Types
                   2319: sub fileextensions {
                   2320:     return sort(keys(%fe));
                   2321: }
                   2322: 
1.97      www      2323: # ----------------------------------------------------------- Display Languages
                   2324: # returns a hash with all desired display languages
                   2325: #
                   2326: 
                   2327: sub display_languages {
                   2328:     my %languages=();
1.356     albertel 2329:     foreach my $lang (&preferred_languages()) {
                   2330: 	$languages{$lang}=1;
1.97      www      2331:     }
                   2332:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 2333:     if ($env{'form.displaylanguage'}) {
1.356     albertel 2334: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   2335: 	    $languages{$lang}=1;
1.97      www      2336:         }
                   2337:     }
                   2338:     return %languages;
1.14      harris41 2339: }
                   2340: 
1.117     www      2341: sub preferred_languages {
                   2342:     my @languages=();
1.258     albertel 2343:     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117     www      2344: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258     albertel 2345: 	         $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177     www      2346:     }
1.258     albertel 2347:     if ($env{'environment.languages'}) {
                   2348: 	@languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
1.118     www      2349:     }
1.162     www      2350:     my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
                   2351:     if ($browser) {
                   2352: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
                   2353:     }
1.258     albertel 2354:     if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
1.118     www      2355: 	@languages=(@languages,
1.258     albertel 2356: 		$Apache::lonnet::domain_lang_def{$env{'user.domain'}});
1.118     www      2357:     }
1.258     albertel 2358:     if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
1.118     www      2359: 	@languages=(@languages,
1.258     albertel 2360: 		$Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
1.118     www      2361:     }
                   2362:     if ($Apache::lonnet::domain_lang_def{
                   2363: 	                          $Apache::lonnet::perlvar{'lonDefDomain'}}) {
                   2364: 	@languages=(@languages,
                   2365: 		$Apache::lonnet::domain_lang_def{
                   2366:                                   $Apache::lonnet::perlvar{'lonDefDomain'}});
                   2367:     }
                   2368: # turn "en-ca" into "en-ca,en"
                   2369:     my @genlanguages;
1.356     albertel 2370:     foreach my $lang (@languages) {
                   2371: 	unless ($lang=~/\w/) { next; }
                   2372: 	push (@genlanguages,$lang);
                   2373: 	if ($lang=~/(\-|\_)/) {
                   2374: 	    push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118     www      2375: 	}
                   2376:     }
                   2377:     return @genlanguages;
1.117     www      2378: }
                   2379: 
1.112     bowersj2 2380: ###############################################################
                   2381: ##               Student Answer Attempts                     ##
                   2382: ###############################################################
                   2383: 
                   2384: =pod
                   2385: 
                   2386: =head1 Alternate Problem Views
                   2387: 
                   2388: =over 4
                   2389: 
                   2390: =item * get_previous_attempt($symb, $username, $domain, $course,
                   2391:     $getattempt, $regexp, $gradesub)
                   2392: 
                   2393: Return string with previous attempt on problem. Arguments:
                   2394: 
                   2395: =over 4
                   2396: 
                   2397: =item * $symb: Problem, including path
                   2398: 
                   2399: =item * $username: username of the desired student
                   2400: 
                   2401: =item * $domain: domain of the desired student
1.14      harris41 2402: 
1.112     bowersj2 2403: =item * $course: Course ID
1.14      harris41 2404: 
1.112     bowersj2 2405: =item * $getattempt: Leave blank for all attempts, otherwise put
                   2406:     something
1.14      harris41 2407: 
1.112     bowersj2 2408: =item * $regexp: if string matches this regexp, the string will be
                   2409:     sent to $gradesub
1.14      harris41 2410: 
1.112     bowersj2 2411: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 2412: 
1.112     bowersj2 2413: =back
1.14      harris41 2414: 
1.112     bowersj2 2415: The output string is a table containing all desired attempts, if any.
1.16      harris41 2416: 
1.112     bowersj2 2417: =cut
1.1       albertel 2418: 
                   2419: sub get_previous_attempt {
1.43      ng       2420:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 2421:   my $prevattempts='';
1.43      ng       2422:   no strict 'refs';
1.1       albertel 2423:   if ($symb) {
1.3       albertel 2424:     my (%returnhash)=
                   2425:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 2426:     if ($returnhash{'version'}) {
                   2427:       my %lasthash=();
                   2428:       my $version;
                   2429:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 2430:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   2431: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 2432:         }
1.1       albertel 2433:       }
1.43      ng       2434:       $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40      ng       2435:       $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.356     albertel 2436:       foreach my $key (sort(keys(%lasthash))) {
                   2437: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       2438: 	if ($#parts > 0) {
1.31      albertel 2439: 	  my $data=$parts[-1];
                   2440: 	  pop(@parts);
1.40      ng       2441: 	  $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.'&nbsp;</td>';
1.31      albertel 2442: 	} else {
1.41      ng       2443: 	  if ($#parts == 0) {
                   2444: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   2445: 	  } else {
                   2446: 	    $prevattempts.='<th>'.$ign.'</th>';
                   2447: 	  }
1.31      albertel 2448: 	}
1.16      harris41 2449:       }
1.40      ng       2450:       if ($getattempt eq '') {
                   2451: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
                   2452: 	  $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
1.356     albertel 2453: 	    foreach my $key (sort(keys(%lasthash))) {
1.40      ng       2454: 	       my $value;
1.356     albertel 2455: 	       if ($key =~ /timestamp/) {
                   2456: 		  $value=scalar(localtime($returnhash{$version.':'.$key}));
1.40      ng       2457: 	       } else {
1.356     albertel 2458: 		  $value=$returnhash{$version.':'.$key};
1.40      ng       2459: 	       }
1.369     www      2460: 	       $prevattempts.='<td>'.&unescape($value).'&nbsp;</td>';   
1.40      ng       2461: 	    }
                   2462: 	 }
1.1       albertel 2463:       }
1.40      ng       2464:       $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.356     albertel 2465:       foreach my $key (sort(keys(%lasthash))) {
1.5       albertel 2466: 	my $value;
1.356     albertel 2467: 	if ($key =~ /timestamp/) {
                   2468: 	  $value=scalar(localtime($lasthash{$key}));
1.5       albertel 2469: 	} else {
1.356     albertel 2470: 	  $value=$lasthash{$key};
1.5       albertel 2471: 	}
1.369     www      2472: 	$value=&unescape($value);
1.356     albertel 2473: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       2474: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 2475:       }
1.40      ng       2476:       $prevattempts.='</tr></table></td></tr></table>';
1.1       albertel 2477:     } else {
                   2478:       $prevattempts='Nothing submitted - no attempts.';
                   2479:     }
                   2480:   } else {
                   2481:     $prevattempts='No data.';
                   2482:   }
1.10      albertel 2483: }
                   2484: 
1.107     albertel 2485: sub relative_to_absolute {
                   2486:     my ($url,$output)=@_;
                   2487:     my $parser=HTML::TokeParser->new(\$output);
                   2488:     my $token;
                   2489:     my $thisdir=$url;
                   2490:     my @rlinks=();
                   2491:     while ($token=$parser->get_token) {
                   2492: 	if ($token->[0] eq 'S') {
                   2493: 	    if ($token->[1] eq 'a') {
                   2494: 		if ($token->[2]->{'href'}) {
                   2495: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   2496: 		}
                   2497: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   2498: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   2499: 	    } elsif ($token->[1] eq 'base') {
                   2500: 		$thisdir=$token->[2]->{'href'};
                   2501: 	    }
                   2502: 	}
                   2503:     }
                   2504:     $thisdir=~s-/[^/]*$--;
1.356     albertel 2505:     foreach my $link (@rlinks) {
                   2506: 	unless (($link=~/^http:\/\//i) ||
                   2507: 		($link=~/^\//) ||
                   2508: 		($link=~/^javascript:/i) ||
                   2509: 		($link=~/^mailto:/i) ||
                   2510: 		($link=~/^\#/)) {
                   2511: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   2512: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 2513: 	}
                   2514:     }
                   2515: # -------------------------------------------------- Deal with Applet codebases
                   2516:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   2517:     return $output;
                   2518: }
                   2519: 
1.112     bowersj2 2520: =pod
                   2521: 
                   2522: =item * get_student_view
                   2523: 
                   2524: show a snapshot of what student was looking at
                   2525: 
                   2526: =cut
                   2527: 
1.10      albertel 2528: sub get_student_view {
1.186     albertel 2529:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      2530:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2531:   my (%form);
1.10      albertel 2532:   my @elements=('symb','courseid','domain','username');
                   2533:   foreach my $element (@elements) {
1.186     albertel 2534:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2535:   }
1.186     albertel 2536:   if (defined($moreenv)) {
                   2537:       %form=(%form,%{$moreenv});
                   2538:   }
1.236     albertel 2539:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 2540:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.186     albertel 2541:   my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 2542:   $userview=~s/\<body[^\>]*\>//gi;
                   2543:   $userview=~s/\<\/body\>//gi;
                   2544:   $userview=~s/\<html\>//gi;
                   2545:   $userview=~s/\<\/html\>//gi;
                   2546:   $userview=~s/\<head\>//gi;
                   2547:   $userview=~s/\<\/head\>//gi;
                   2548:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 2549:   $userview=&relative_to_absolute($feedurl,$userview);
1.11      albertel 2550:   return $userview;
                   2551: }
                   2552: 
1.112     bowersj2 2553: =pod
                   2554: 
                   2555: =item * get_student_answers() 
                   2556: 
                   2557: show a snapshot of how student was answering problem
                   2558: 
                   2559: =cut
                   2560: 
1.11      albertel 2561: sub get_student_answers {
1.100     sakharuk 2562:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      2563:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 2564:   my (%moreenv);
1.11      albertel 2565:   my @elements=('symb','courseid','domain','username');
                   2566:   foreach my $element (@elements) {
1.186     albertel 2567:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 2568:   }
1.186     albertel 2569:   $moreenv{'grade_target'}='answer';
                   2570:   %moreenv=(%form,%moreenv);
                   2571:   my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10      albertel 2572:   return $userview;
1.1       albertel 2573: }
1.116     albertel 2574: 
                   2575: =pod
                   2576: 
                   2577: =item * &submlink()
                   2578: 
1.242     albertel 2579: Inputs: $text $uname $udom $symb $target
1.116     albertel 2580: 
                   2581: Returns: A link to grades.pm such as to see the SUBM view of a student
                   2582: 
                   2583: =cut
                   2584: 
                   2585: ###############################################
                   2586: sub submlink {
1.242     albertel 2587:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 2588:     if (!($uname && $udom)) {
                   2589: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2590: 	    &Apache::lonxml::whichuser($symb);
                   2591: 	if (!$symb) { $symb=$cursymb; }
                   2592:     }
1.254     matthew  2593:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      2594:     $symb=&escape($symb);
1.242     albertel 2595:     if ($target) { $target="target=\"$target\""; }
                   2596:     return '<a href="/adm/grades?&command=submission&'.
                   2597: 	'symb='.$symb.'&student='.$uname.
                   2598: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   2599: }
                   2600: ##############################################
                   2601: 
                   2602: =pod
                   2603: 
                   2604: =item * &pgrdlink()
                   2605: 
                   2606: Inputs: $text $uname $udom $symb $target
                   2607: 
                   2608: Returns: A link to grades.pm such as to see the PGRD view of a student
                   2609: 
                   2610: =cut
                   2611: 
                   2612: ###############################################
                   2613: sub pgrdlink {
                   2614:     my $link=&submlink(@_);
                   2615:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   2616:     return $link;
                   2617: }
                   2618: ##############################################
                   2619: 
                   2620: =pod
                   2621: 
                   2622: =item * &pprmlink()
                   2623: 
                   2624: Inputs: $text $uname $udom $symb $target
                   2625: 
                   2626: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 2627: student and a specific resource
1.242     albertel 2628: 
                   2629: =cut
                   2630: 
                   2631: ###############################################
                   2632: sub pprmlink {
                   2633:     my ($text,$uname,$udom,$symb,$target)=@_;
                   2634:     if (!($uname && $udom)) {
                   2635: 	(my $cursymb, my $courseid,$udom,$uname)=
                   2636: 	    &Apache::lonxml::whichuser($symb);
                   2637: 	if (!$symb) { $symb=$cursymb; }
                   2638:     }
1.254     matthew  2639:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      2640:     $symb=&escape($symb);
1.242     albertel 2641:     if ($target) { $target="target=\"$target\""; }
                   2642:     return '<a href="/adm/parmset?&command=set&'.
                   2643: 	'symb='.$symb.'&uname='.$uname.
                   2644: 	'&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 2645: }
                   2646: ##############################################
1.37      matthew  2647: 
1.112     bowersj2 2648: =pod
                   2649: 
                   2650: =back
                   2651: 
                   2652: =cut
                   2653: 
1.37      matthew  2654: ###############################################
1.51      www      2655: 
                   2656: 
                   2657: sub timehash {
                   2658:     my @ltime=localtime(shift);
                   2659:     return ( 'seconds' => $ltime[0],
                   2660:              'minutes' => $ltime[1],
                   2661:              'hours'   => $ltime[2],
                   2662:              'day'     => $ltime[3],
                   2663:              'month'   => $ltime[4]+1,
                   2664:              'year'    => $ltime[5]+1900,
                   2665:              'weekday' => $ltime[6],
                   2666:              'dayyear' => $ltime[7]+1,
                   2667:              'dlsav'   => $ltime[8] );
                   2668: }
                   2669: 
1.370     www      2670: sub utc_string {
                   2671:     my ($date)=@_;
1.371     www      2672:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      2673: }
                   2674: 
1.51      www      2675: sub maketime {
                   2676:     my %th=@_;
                   2677:     return POSIX::mktime(
                   2678:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      2679:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      2680: }
                   2681: 
                   2682: #########################################
1.51      www      2683: 
                   2684: sub findallcourses {
1.355     albertel 2685:     my ($roles) = @_;
                   2686:     my %roles;
                   2687:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 2688:     my %courses;
1.51      www      2689:     my $now=time;
1.348     albertel 2690:     foreach my $key (keys(%env)) {
                   2691: 	if ( $key=~m{^user\.role\.(\w+)\./(\w+)/(\w+)} ) {
                   2692: 	    my ($role,$domain,$id) = ($1,$2,$3);
                   2693: 	    next if ($role eq 'ca' || $role eq 'aa');
1.355     albertel 2694: 	    next if (%roles && !exists($roles{$role}));
1.354     albertel 2695: 	    my ($starttime,$endtime)=split(/\./,$env{$key});
1.51      www      2696:             my $active=1;
                   2697:             if ($starttime) {
                   2698: 		if ($now<$starttime) { $active=0; }
                   2699:             }
                   2700:             if ($endtime) {
                   2701:                 if ($now>$endtime) { $active=0; }
                   2702:             }
1.348     albertel 2703:             if ($active) { $courses{$domain.'_'.$id}=1; }
1.51      www      2704:         }
                   2705:     }
1.348     albertel 2706:     return keys(%courses);
1.51      www      2707: }
1.37      matthew  2708: 
1.54      www      2709: ###############################################
1.60      matthew  2710: ###############################################
                   2711: 
                   2712: =pod
                   2713: 
1.112     bowersj2 2714: =head1 Domain Template Functions
                   2715: 
                   2716: =over 4
                   2717: 
                   2718: =item * &determinedomain()
1.60      matthew  2719: 
                   2720: Inputs: $domain (usually will be undef)
                   2721: 
1.63      www      2722: Returns: Determines which domain should be used for designs
1.60      matthew  2723: 
                   2724: =cut
1.54      www      2725: 
1.60      matthew  2726: ###############################################
1.63      www      2727: sub determinedomain {
                   2728:     my $domain=shift;
                   2729:    if (! $domain) {
1.60      matthew  2730:         # Determine domain if we have not been given one
                   2731:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 2732:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   2733:         if ($env{'request.role.domain'}) { 
                   2734:             $domain=$env{'request.role.domain'}; 
1.60      matthew  2735:         }
                   2736:     }
1.63      www      2737:     return $domain;
                   2738: }
                   2739: ###############################################
                   2740: =pod
                   2741: 
1.112     bowersj2 2742: =item * &domainlogo()
1.63      www      2743: 
                   2744: Inputs: $domain (usually will be undef)
                   2745: 
                   2746: Returns: A link to a domain logo, if the domain logo exists.
                   2747: If the domain logo does not exist, a description of the domain.
                   2748: 
                   2749: =cut
1.112     bowersj2 2750: 
1.63      www      2751: ###############################################
                   2752: sub domainlogo {
                   2753:     my $domain = &determinedomain(shift);    
                   2754:      # See if there is a logo
1.59      www      2755:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215     albertel 2756: 	my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
                   2757:         return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60      matthew  2758:     } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
                   2759:         return $Apache::lonnet::domaindescription{$domain};
1.59      www      2760:     } else {
1.60      matthew  2761:         return '';
1.59      www      2762:     }
                   2763: }
1.63      www      2764: ##############################################
                   2765: 
                   2766: =pod
                   2767: 
1.112     bowersj2 2768: =item * &designparm()
1.63      www      2769: 
                   2770: Inputs: $which parameter; $domain (usually will be undef)
                   2771: 
                   2772: Returns: value of designparamter $which
                   2773: 
                   2774: =cut
1.112     bowersj2 2775: 
1.397     albertel 2776: 
1.400     albertel 2777: ##############################################
1.397     albertel 2778: sub designparm {
                   2779:     my ($which,$domain)=@_;
1.258     albertel 2780:     if ($env{'browser.blackwhite'} eq 'on') {
1.110     www      2781: 	if ($which=~/\.(font|alink|vlink|link)$/) {
                   2782: 	    return '#000000';
                   2783: 	}
                   2784: 	if ($which=~/\.(pgbg|sidebg)$/) {
                   2785: 	    return '#FFFFFF';
                   2786: 	}
                   2787: 	if ($which=~/\.tabbg$/) {
                   2788: 	    return '#CCCCCC';
                   2789: 	}
                   2790:     }
1.397     albertel 2791:     if (exists($env{'environment.color.'.$which})) {
1.258     albertel 2792: 	return $env{'environment.color.'.$which};
1.96      www      2793:     }
1.63      www      2794:     $domain=&determinedomain($domain);
1.397     albertel 2795:     if (exists($designhash{$domain.'.'.$which})) {
1.63      www      2796: 	return $designhash{$domain.'.'.$which};
                   2797:     } else {
                   2798:         return $designhash{'default.'.$which};
                   2799:     }
                   2800: }
1.59      www      2801: 
1.60      matthew  2802: ###############################################
                   2803: ###############################################
                   2804: 
                   2805: =pod
                   2806: 
1.112     bowersj2 2807: =back
                   2808: 
                   2809: =head1 HTTP Helpers
                   2810: 
                   2811: =over 4
                   2812: 
                   2813: =item * &bodytag()
1.60      matthew  2814: 
                   2815: Returns a uniform header for LON-CAPA web pages.
                   2816: 
                   2817: Inputs: 
                   2818: 
1.112     bowersj2 2819: =over 4
                   2820: 
                   2821: =item * $title, A title to be displayed on the page.
                   2822: 
                   2823: =item * $function, the current role (can be undef).
                   2824: 
                   2825: =item * $addentries, extra parameters for the <body> tag.
                   2826: 
                   2827: =item * $bodyonly, if defined, only return the <body> tag.
                   2828: 
                   2829: =item * $domain, if defined, force a given domain.
                   2830: 
                   2831: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      2832:             text interface only)
1.60      matthew  2833: 
1.326     albertel 2834: =item * $customtitle, alternate text to use instead of $title
                   2835:                       in the title box that appears, this text
                   2836:                       is not auto translated like the $title is
1.309     albertel 2837: 
                   2838: =item * $notopbar, if true, keep the 'what is this' info but remove the
                   2839:                    navigational links
1.317     albertel 2840: 
1.338     albertel 2841: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   2842: 
                   2843: =item * $notitle, if true keep the nav controls, but remove the title bar
                   2844: 
1.361     albertel 2845: =item * $no_inline_link, if true and in remote mode, don't show the 
                   2846:          'Switch To Inline Menu' link
                   2847: 
1.112     bowersj2 2848: =back
                   2849: 
1.60      matthew  2850: Returns: A uniform header for LON-CAPA web pages.  
                   2851: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   2852: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   2853: other decorations will be returned.
                   2854: 
                   2855: =cut
                   2856: 
1.54      www      2857: sub bodytag {
1.309     albertel 2858:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.361     albertel 2859: 	$notopbar,$bgcolor,$notitle,$no_inline_link)=@_;
1.339     albertel 2860: 
1.117     www      2861:     $title=&mt($title);
1.339     albertel 2862: 
1.183     matthew  2863:     $function = &get_users_function() if (!$function);
1.339     albertel 2864:     my $img =    &designparm($function.'.img',$domain);
                   2865:     my $font =   &designparm($function.'.font',$domain);
                   2866:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   2867: 
                   2868:     my %design = ( 'style'   => 'margin-top: 0px',
                   2869: 		   'bgcolor' => $pgbg,
                   2870: 		   'text'    => $font,
                   2871:                    'alink'   => &designparm($function.'.alink',$domain),
                   2872: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   2873: 		   'link'    => &designparm($function.'.link',$domain),);
                   2874:     @$addentries{keys(%design)} = @design{keys(%design)};
                   2875: 
1.63      www      2876:  # role and realm
1.378     raeburn  2877:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   2878:     if ($role  eq 'ca') {
                   2879:         my ($rdom,$rname) = ($realm =~ m-^/(\w+)/(\w+)$-);
                   2880:         $realm = &plainname($rname,$rdom).':'.$rdom;
                   2881:     } 
1.55      www      2882: # realm
1.258     albertel 2883:     if ($env{'request.course.id'}) {
1.378     raeburn  2884:         if ($env{'request.role'} !~ /^cr/) {
                   2885:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   2886:         }
1.359     albertel 2887: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  2888:     } else {
                   2889:         $role = &Apache::lonnet::plaintext($role);
1.54      www      2890:     }
1.433   ! albertel 2891: 
1.359     albertel 2892:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      2893: # Set messages
1.60      matthew  2894:     my $messages=&domainlogo($domain);
1.101     www      2895: # Port for miniserver
1.83      albertel 2896:     my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   2897:     if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.330     albertel 2898: 
                   2899:     my $extra_body_attr = &make_attr_string($forcereg,$addentries);
1.329     albertel 2900: 
1.101     www      2901: # construct main body tag
1.359     albertel 2902:     my $bodytag = "<body $extra_body_attr>".
                   2903: 	&Apache::lontexconvert::init_math_support();
1.252     albertel 2904: 
1.332     albertel 2905:     if ($bodyonly 
                   2906: 	|| ($env{'request.state'} eq 'construct' 
                   2907: 	    && $env{'environment.remote'} ne 'off' )) {
1.60      matthew  2908:         return $bodytag;
1.258     albertel 2909:     } elsif ($env{'browser.interface'} eq 'textual') {
1.95      www      2910: # Accessibility
1.224     raeburn  2911:           
1.337     albertel 2912: 	$bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338     albertel 2913: 	if (!$notitle) {
1.337     albertel 2914: 	    $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
                   2915: 	}
                   2916: 	return $bodytag;
1.359     albertel 2917:     }
                   2918: 
1.410     albertel 2919:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433   ! albertel 2920:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
        !          2921: 	undef($role);
        !          2922:     }
1.359     albertel 2923:     
                   2924:     my $roleinfo=(<<ENDROLE);
                   2925: <td class="LC_title_bar_who">
                   2926: <div class="LC_title_bar_name">
1.410     albertel 2927:     $name
1.361     albertel 2928:     &nbsp;
1.359     albertel 2929: </div>
                   2930: <div class="LC_title_bar_role">
1.361     albertel 2931: $role&nbsp;
1.359     albertel 2932: </div>
                   2933: <div class="LC_title_bar_realm">
1.361     albertel 2934: $realm&nbsp;
1.359     albertel 2935: </div>
1.206     albertel 2936: </td>
                   2937: ENDROLE
1.235     raeburn  2938: 
1.359     albertel 2939:     my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
                   2940:     if ($customtitle) {
                   2941:         $titleinfo = $customtitle;
                   2942:     }
                   2943:     #
                   2944:     # Extra info if you are the DC
                   2945:     my $dc_info = '';
                   2946:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   2947:                         $env{'course.'.$env{'request.course.id'}.
                   2948:                                  '.domain'}.'/'})) {
                   2949:         my $cid = $env{'request.course.id'};
                   2950:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      2951:         $dc_info =~ s/\s+$//;
1.359     albertel 2952:         $dc_info = '('.$dc_info.')';
                   2953:     }
                   2954: 
                   2955:     if ($env{'environment.remote'} eq 'off') {
                   2956:         # No Remote
1.258     albertel 2957: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 2958: 	    $forcereg=1;
                   2959: 	}
                   2960: 
                   2961: 	if (!$customtitle && $env{'request.state'} eq 'construct') {
                   2962: 	    # this is for resources; directories have customtitle, and crumbs
                   2963:             # and select recent are created in lonpubdir.pm  
1.229     albertel 2964: 	    my ($uname,$thisdisfn)=
1.258     albertel 2965: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 2966: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   2967: 	    $formaction=~s/\/+/\//g;
                   2968: 
1.359     albertel 2969: 	    my $parentpath = '';
                   2970: 	    my $lastitem = '';
                   2971: 	    if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   2972: 		$parentpath = $1;
                   2973: 		$lastitem = $2;
                   2974: 	    } else {
                   2975: 		$lastitem = $thisdisfn;
                   2976: 	    }
                   2977: 	    $titleinfo = 
1.401     albertel 2978: 		&Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359     albertel 2979: 		'<b>Construction Space</b>:&nbsp;'. 
                   2980: 		'<form name="dirs" method="post" action="'.$formaction
                   2981: 		.'" target="_top"><tt><b>'
                   2982: 		.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
                   2983: 		.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   2984: 		.'</form>'
                   2985: 		.&Apache::lonmenu::constspaceform();
1.235     raeburn  2986:         }
1.359     albertel 2987: 
1.337     albertel 2988:         my $titletable;
1.338     albertel 2989: 	if (!$notitle) {
1.337     albertel 2990: 	    $titletable =
1.359     albertel 2991: 		'<table id="LC_title_bar">'.
                   2992:                          "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
                   2993: 			 '</tr></table>';
1.337     albertel 2994: 	}
1.359     albertel 2995: 	if ($notopbar) {
                   2996: 	    $bodytag .= $titletable;
                   2997: 	} else {
                   2998: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 2999:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   3000: 							  $titletable);
1.272     raeburn  3001:             } else {
1.336     albertel 3002:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 3003: 		    $titletable;
1.272     raeburn  3004:             }
1.235     raeburn  3005:         }
                   3006:         return $bodytag;
1.94      www      3007:     }
1.95      www      3008: 
1.93      www      3009: #
1.95      www      3010: # Top frame rendering, Remote is up
1.93      www      3011: #
1.359     albertel 3012: 
                   3013:     my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
                   3014:         $lonhttpdPort.$img.'" alt="'.$function.'" />';
                   3015: 
1.305     www      3016:     # Explicit link to get inline menu
1.361     albertel 3017:     my $menu= ($no_inline_link?''
                   3018: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  3019:     #
1.338     albertel 3020:     if ($notitle) {
1.337     albertel 3021: 	return $bodytag;
                   3022:     }
1.94      www      3023:     return(<<ENDBODY);
1.60      matthew  3024: $bodytag
1.359     albertel 3025: <table id="LC_title_bar" class="LC_with_remote">
1.368     albertel 3026: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359     albertel 3027:     <td class="LC_title_bar_domain_logo">$messages&nbsp;</td>
1.54      www      3028: </tr>
1.359     albertel 3029: <tr><td>$titleinfo $dc_info $menu</td>
                   3030: $roleinfo
1.368     albertel 3031: </tr>
1.356     albertel 3032: </table>
1.54      www      3033: ENDBODY
1.182     matthew  3034: }
                   3035: 
1.330     albertel 3036: sub make_attr_string {
                   3037:     my ($register,$attr_ref) = @_;
                   3038: 
                   3039:     if ($attr_ref && !ref($attr_ref)) {
                   3040: 	die("addentries Must be a hash ref ".
                   3041: 	    join(':',caller(1))." ".
                   3042: 	    join(':',caller(0))." ");
                   3043:     }
                   3044: 
                   3045:     if ($register) {
1.339     albertel 3046: 	my ($on_load,$on_unload);
                   3047: 	foreach my $key (keys(%{$attr_ref})) {
                   3048: 	    if      (lc($key) eq 'onload') {
                   3049: 		$on_load.=$attr_ref->{$key}.';';
                   3050: 		delete($attr_ref->{$key});
                   3051: 
                   3052: 	    } elsif (lc($key) eq 'onunload') {
                   3053: 		$on_unload.=$attr_ref->{$key}.';';
                   3054: 		delete($attr_ref->{$key});
                   3055: 	    }
                   3056: 	}
                   3057: 	$attr_ref->{'onload'}  =
                   3058: 	    &Apache::lonmenu::loadevents().  $on_load;
                   3059: 	$attr_ref->{'onunload'}=
                   3060: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   3061:     }
                   3062: 
                   3063: # Accessibility font enhance
                   3064:     if ($env{'browser.fontenhance'} eq 'on') {
                   3065: 	my $style;
                   3066: 	foreach my $key (keys(%{$attr_ref})) {
                   3067: 	    if (lc($key) eq 'style') {
                   3068: 		$style.=$attr_ref->{$key}.';';
                   3069: 		delete($attr_ref->{$key});
                   3070: 	    }
                   3071: 	}
                   3072: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 3073:     }
1.339     albertel 3074: 
                   3075:     if ($env{'browser.blackwhite'} eq 'on') {
                   3076: 	delete($attr_ref->{'font'});
                   3077: 	delete($attr_ref->{'link'});
                   3078: 	delete($attr_ref->{'alink'});
                   3079: 	delete($attr_ref->{'vlink'});
                   3080: 	delete($attr_ref->{'bgcolor'});
                   3081: 	delete($attr_ref->{'background'});
                   3082:     }
                   3083: 
1.330     albertel 3084:     my $attr_string;
                   3085:     foreach my $attr (keys(%$attr_ref)) {
                   3086: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   3087:     }
                   3088:     return $attr_string;
                   3089: }
                   3090: 
                   3091: 
1.182     matthew  3092: ###############################################
1.251     albertel 3093: ###############################################
                   3094: 
                   3095: =pod
                   3096: 
                   3097: =back
                   3098: 
1.306     albertel 3099: =head1 HTML Helpers
1.251     albertel 3100: 
                   3101: =over 4
                   3102: 
                   3103: =item * &endbodytag()
                   3104: 
                   3105: Returns a uniform footer for LON-CAPA web pages.
                   3106: 
1.306     albertel 3107: Inputs: none
1.251     albertel 3108: 
                   3109: =back
                   3110: 
                   3111: =cut
                   3112: 
                   3113: sub endbodytag {
                   3114:     my $endbodytag='</body>';
1.269     albertel 3115:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 3116:     if ( exists( $env{'internal.head.redirect'} ) ) {
                   3117: 	$endbodytag=
                   3118: 	    "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   3119: 	    &mt('Continue').'</a>'.
                   3120: 	    $endbodytag;
                   3121:     }
1.251     albertel 3122:     return $endbodytag;
                   3123: }
                   3124: 
1.352     albertel 3125: =pod
                   3126: 
                   3127: =over 4
                   3128: 
                   3129: =item * &standard_css()
                   3130: 
                   3131: Returns a style sheet
                   3132: 
                   3133: Inputs: (all optional)
                   3134:             domain         -> force to color decorate a page for a specific
                   3135:                                domain
                   3136:             function       -> force usage of a specific rolish color scheme
                   3137:             bgcolor        -> override the default page bgcolor
                   3138: 
                   3139: =back
                   3140: 
                   3141: =cut
                   3142: 
1.343     albertel 3143: sub standard_css {
1.345     albertel 3144:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 3145:     $function  = &get_users_function() if (!$function);
                   3146:     my $img    = &designparm($function.'.img',   $domain);
                   3147:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   3148:     my $font   = &designparm($function.'.font',  $domain);
1.345     albertel 3149:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 3150:     my $pgbg_or_bgcolor =
                   3151: 	         $bgcolor ||
1.352     albertel 3152: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 3153:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 3154:     my $alink  = &designparm($function.'.alink', $domain);
                   3155:     my $vlink  = &designparm($function.'.vlink', $domain);
                   3156:     my $link   = &designparm($function.'.link',  $domain);
                   3157: 
                   3158:     my $sans                 = 'Arial,Helvetica,sans-serif';
1.395     albertel 3159:     my $mono                 = 'monospace';
1.352     albertel 3160:     my $data_table_head      = $tabbg;
                   3161:     my $data_table_light     = '#EEEEEE';
                   3162:     my $data_table_dark      = '#DDD';
1.424     albertel 3163:     my $data_table_darker    = '#CCC';
1.349     albertel 3164:     my $data_table_highlight = '#FFFF00';
1.352     albertel 3165:     my $mail_new             = '#FFBB77';
                   3166:     my $mail_new_hover       = '#DD9955';
                   3167:     my $mail_read            = '#BBBB77';
                   3168:     my $mail_read_hover      = '#999944';
                   3169:     my $mail_replied         = '#AAAA88';
                   3170:     my $mail_replied_hover   = '#888855';
                   3171:     my $mail_other           = '#99BBBB';
                   3172:     my $mail_other_hover     = '#669999';
1.391     albertel 3173:     my $table_header         = '#DDDDDD';
1.392     albertel 3174: 
                   3175:     my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
                   3176: 	                                              : '0px 3px 0px 4px';
1.343     albertel 3177:     return <<END;
1.345     albertel 3178: h1, h2, h3, th { font-family: $sans }
1.343     albertel 3179: a:focus { color: red; background: yellow } 
                   3180: table.thinborder { border-collapse: collapse; }
1.426     albertel 3181: table.thinborder tr th {  border-style: solid; border-width: 1px; background: $tabbg;}
                   3182: table.thinborder tr td { border-style: solid; border-width: 1px}
                   3183: 
1.343     albertel 3184: form, .inline { display: inline; }
                   3185: .center { text-align: center; }
1.395     albertel 3186: .LC_filename {font-family: $mono;}
1.350     albertel 3187: .LC_error {
                   3188:   color: red;
                   3189:   font-size: larger;
                   3190: }
1.394     albertel 3191: .LC_warning {
                   3192:   color: red;
                   3193: }
1.350     albertel 3194: .LC_success {
                   3195:   color: green;
                   3196: }
1.346     albertel 3197: 
1.392     albertel 3198: table#LC_top_nav, table#LC_menubuttons {
1.345     albertel 3199:   width: 100%;
                   3200:   background: $pgbg;
1.392     albertel 3201:   border: 2px;
1.402     albertel 3202:   border-collapse: separate;
1.403     albertel 3203:   padding: 0px;
1.345     albertel 3204: }
1.392     albertel 3205: 
1.409     albertel 3206: table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
1.393     albertel 3207: table#LC_title_bar.LC_with_remote {
1.359     albertel 3208:   width: 100%;
1.392     albertel 3209:   border-color: $pgbg;
                   3210:   border-style: solid;
                   3211:   border-width: $border;
                   3212: 
1.379     albertel 3213:   background: $pgbg;
                   3214:   font-family: $sans;
1.392     albertel 3215:   border-collapse: collapse;
1.403     albertel 3216:   padding: 0px;
1.359     albertel 3217: }
1.392     albertel 3218: 
1.409     albertel 3219: table.LC_docs_path {
                   3220:   width: 100%;
                   3221:   border: 0;
                   3222:   background: $pgbg;
                   3223:   font-family: $sans;
                   3224:   border-collapse: collapse;
                   3225:   padding: 0px;
                   3226: }
                   3227: 
1.359     albertel 3228: table#LC_title_bar td {
                   3229:   background: $tabbg;
                   3230: }
                   3231: table#LC_title_bar td.LC_title_bar_who {
                   3232:   background: $tabbg;
                   3233:   color: $font;
1.427     albertel 3234:   font: small $sans;
1.359     albertel 3235:   text-align: right;
                   3236: }
                   3237: span.LC_title_bar_title {
1.416     albertel 3238:   font: bold x-large $sans;
1.359     albertel 3239: }
                   3240: table#LC_title_bar td.LC_title_bar_domain_logo {
                   3241:   background: $sidebg;
                   3242:   text-align: right;
1.368     albertel 3243:   padding: 0px;
                   3244: }
                   3245: table#LC_title_bar td.LC_title_bar_role_logo {
                   3246:   background: $sidebg;
                   3247:   padding: 0px;
1.359     albertel 3248: }
                   3249: 
1.346     albertel 3250: table#LC_menubuttons_mainmenu {
                   3251:   background: $pgbg;
                   3252:   border: 0px;
                   3253:   border-spacing: 1px;
1.372     albertel 3254:   padding: 0px 1px;
1.346     albertel 3255:   margin: 0px;
                   3256:   border-collapse: separate;
                   3257: }
                   3258: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
                   3259:   border: 0px;
                   3260: }
1.345     albertel 3261: table#LC_top_nav td {
                   3262:   background: $tabbg;
1.392     albertel 3263:   border: 0px;
1.407     albertel 3264:   font-size: small;
1.345     albertel 3265: }
                   3266: table#LC_top_nav td a, div#LC_top_nav a {
                   3267:   color: $font;
                   3268:   font-family: $sans;
                   3269: }
1.364     albertel 3270: table#LC_top_nav td.LC_top_nav_logo {
                   3271:   background: $tabbg;
1.432     albertel 3272:   text-align: left;
1.408     albertel 3273:   white-space: nowrap;
1.432     albertel 3274:   width: 31px;
1.408     albertel 3275: }
                   3276: table#LC_top_nav td.LC_top_nav_logo img {
1.432     albertel 3277:   border: 0px;
1.408     albertel 3278:   vertical-align: bottom;
1.364     albertel 3279: }
1.432     albertel 3280: table#LC_top_nav td.LC_top_nav_exit,
                   3281: table#LC_top_nav td.LC_top_nav_help {
                   3282:   width: 2.0em;
                   3283: }
1.409     albertel 3284: table.LC_breadcrumbs td, table.LC_docs_path td  {
1.357     albertel 3285:   background: $tabbg;
                   3286:   color: $font;
                   3287:   font-family: $sans;
1.358     albertel 3288:   font-size: smaller;
1.357     albertel 3289: }
1.411     albertel 3290: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409     albertel 3291: table.LC_docs_path td.LC_docs_path_component {
1.357     albertel 3292:   background: $tabbg;
                   3293:   color: $font;
                   3294:   font-family: $sans;
                   3295:   font-size: larger;
                   3296:   text-align: right;
                   3297: }
1.383     albertel 3298: td.LC_table_cell_checkbox {
                   3299:   text-align: center;
                   3300: }
                   3301: 
1.346     albertel 3302: .LC_menubuttons_inline_text {
                   3303:   color: $font;
                   3304:   font-family: $sans;
                   3305:   font-size: smaller;
                   3306: }
                   3307: 
                   3308: td.LC_menubuttons_text {
                   3309:   color: $font;
                   3310:   font-family: $sans;
                   3311: }
                   3312: td.LC_menubuttons_img {
                   3313:   background: $tabbg;
                   3314: }
                   3315: .LC_current_location {
                   3316:   font-family: $sans;
                   3317:   background: $tabbg;
                   3318: }
                   3319: .LC_new_mail {
                   3320:   font-family: $sans;
                   3321:   font-weight: bold;
                   3322: }
1.347     albertel 3323: 
1.349     albertel 3324: table.LC_data_table, table.LC_mail_list {
1.347     albertel 3325:   border: 1px solid #000000;
1.402     albertel 3326:   border-collapse: separate;
1.426     albertel 3327:   border-spacing: 1px;
1.347     albertel 3328: }
1.422     albertel 3329: .LC_data_table_dense {
                   3330:   font-size: small;
                   3331: }
1.349     albertel 3332: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th {
                   3333:   font-weight: bold;
                   3334:   background-color: $data_table_head;
1.421     albertel 3335:   font-size: smaller;
1.347     albertel 3336: }
                   3337: table.LC_data_table tr td {
1.349     albertel 3338:   background-color: $data_table_light;
1.425     albertel 3339:   padding: 2px;
1.347     albertel 3340: }
                   3341: table.LC_data_table tr.LC_even_row td {
1.349     albertel 3342:   background-color: $data_table_dark;
1.347     albertel 3343: }
1.425     albertel 3344: table.LC_data_table tr.LC_data_table_highlight td {
                   3345:   background-color: $data_table_darker;
                   3346: }
1.421     albertel 3347: table.LC_data_table tr.LC_empty_row td {
1.347     albertel 3348:   background-color: #FFFFFF;
1.421     albertel 3349:   font-weight: bold;
                   3350:   font-style: italic;
                   3351:   text-align: center;
                   3352:   padding: 8px;
1.347     albertel 3353: }
                   3354: 
1.349     albertel 3355: table.LC_calendar {
                   3356:   border: 1px solid #000000;
                   3357:   border-collapse: collapse;
                   3358: }
                   3359: table.LC_calendar_pickdate {
                   3360:   font-size: xx-small;
                   3361: }
                   3362: table.LC_calendar tr td {
                   3363:   border: 1px solid #000000;
                   3364:   vertical-align: top;
                   3365: }
                   3366: table.LC_calendar tr td.LC_calendar_day_empty {
                   3367:   background-color: $data_table_dark;
                   3368: }
                   3369: table.LC_calendar tr td.LC_calendar_day_current {
                   3370:   background-color: $data_table_highlight;
                   3371: }
                   3372: 
                   3373: table.LC_mail_list tr.LC_mail_new {
                   3374:   background-color: $mail_new;
                   3375: }
                   3376: table.LC_mail_list tr.LC_mail_new:hover {
                   3377:   background-color: $mail_new_hover;
                   3378: }
                   3379: table.LC_mail_list tr.LC_mail_read {
                   3380:   background-color: $mail_read;
                   3381: }
                   3382: table.LC_mail_list tr.LC_mail_read:hover {
                   3383:   background-color: $mail_read_hover;
                   3384: }
                   3385: table.LC_mail_list tr.LC_mail_replied {
                   3386:   background-color: $mail_replied;
                   3387: }
                   3388: table.LC_mail_list tr.LC_mail_replied:hover {
                   3389:   background-color: $mail_replied_hover;
                   3390: }
                   3391: table.LC_mail_list tr.LC_mail_other {
                   3392:   background-color: $mail_other;
                   3393: }
                   3394: table.LC_mail_list tr.LC_mail_other:hover {
                   3395:   background-color: $mail_other_hover;
                   3396: }
1.385     albertel 3397: 
1.386     albertel 3398: table#LC_portfolio_actions {
                   3399:   width: auto;
                   3400:   background: $pgbg;
                   3401:   border: 0px;
                   3402:   border-spacing: 2px 2px;
                   3403:   padding: 0px;
                   3404:   margin: 0px;
                   3405:   border-collapse: separate;
                   3406: }
                   3407: table#LC_portfolio_actions td.LC_label {
                   3408:   background: $tabbg;
                   3409:   text-align: right;
                   3410: }
                   3411: table#LC_portfolio_actions td.LC_value {
                   3412:   background: $tabbg;
                   3413: }
1.385     albertel 3414: 
1.391     albertel 3415: table#LC_cstr_controls {
                   3416:   width: 100%;
                   3417:   border-collapse: collapse;
                   3418: }
                   3419: table#LC_cstr_controls tr td {
                   3420:   border: 4px solid $pgbg;
                   3421:   padding: 4px;
                   3422:   text-align: center;
                   3423:   background: $tabbg;
                   3424: }
                   3425: table#LC_cstr_controls tr th {
                   3426:   border: 4px solid $pgbg;
                   3427:   background: $table_header;
                   3428:   text-align: center;
                   3429:   font-family: $sans;
                   3430:   font-size: smaller;
                   3431: }
                   3432: 
1.389     albertel 3433: table#LC_browser {
                   3434:  
                   3435: }
                   3436: table#LC_browser tr th {
1.391     albertel 3437:   background: $table_header;
1.389     albertel 3438: }
1.390     albertel 3439: table#LC_browser tr td {
                   3440:   padding: 2px;
                   3441: }
1.389     albertel 3442: table#LC_browser tr.LC_browser_file,
                   3443: table#LC_browser tr.LC_browser_file_published {
                   3444:   background: #CCFF88;
                   3445: }
                   3446: table#LC_browser tr.LC_browser_file_locked,
                   3447: table#LC_browser tr.LC_browser_file_unpublished {
                   3448:   background: #FFAA99;
1.387     albertel 3449: }
1.389     albertel 3450: table#LC_browser tr.LC_browser_file_obsolete {
                   3451:   background: #AAAAAA;
1.387     albertel 3452: }
1.389     albertel 3453: table#LC_browser tr.LC_browser_file_modified {
                   3454:   background: #FFFF77;
1.387     albertel 3455: }
1.389     albertel 3456: table#LC_browser tr.LC_browser_folder {
                   3457:   background: #CCCCFF;
1.387     albertel 3458: }
1.388     albertel 3459: span.LC_current_location {
                   3460:   font-size: x-large;
                   3461:   background: $pgbg;
                   3462: }
1.387     albertel 3463: 
1.395     albertel 3464: span.LC_parm_menu_item {
                   3465:   font-size: larger;
                   3466:   font-family: $sans;
                   3467: }
                   3468: span.LC_parm_scope_all {
                   3469:   color: red;
                   3470: }
                   3471: span.LC_parm_scope_folder {
                   3472:   color: green;
                   3473: }
                   3474: span.LC_parm_scope_resource {
                   3475:   color: orange;
                   3476: }
                   3477: span.LC_parm_part {
                   3478:   color: blue;
                   3479: }
                   3480: span.LC_parm_folder, span.LC_parm_symb {
                   3481:   font-size: x-small;
                   3482:   font-family: $mono;
                   3483:   color: #AAAAAA;
                   3484: }
                   3485: 
1.396     albertel 3486: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
                   3487: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
                   3488:   border: 1px solid black;
                   3489:   border-collapse: collapse;
                   3490: }
                   3491: table.LC_parm_overview_restrictions td {
                   3492:   border-width: 1px 4px 1px 4px;
                   3493:   border-style: solid;
                   3494:   border-color: $pgbg;
                   3495:   text-align: center;
                   3496: }
                   3497: table.LC_parm_overview_restrictions th {
                   3498:   background: $tabbg;
                   3499:   border-width: 1px 4px 1px 4px;
                   3500:   border-style: solid;
                   3501:   border-color: $pgbg;
                   3502: }
1.398     albertel 3503: table#LC_helpmenu {
                   3504:   border: 0px;
                   3505:   height: 55px;
                   3506:   border-spacing: 0px;
                   3507: }
                   3508: 
                   3509: table#LC_helpmenu fieldset legend {
                   3510:   font-size: larger;
                   3511:   font-weight: bold;
                   3512: }
1.397     albertel 3513: table#LC_helpmenu_links {
                   3514:   width: 100%;
                   3515:   border: 1px solid black;
                   3516:   background: $pgbg;
                   3517:   padding: 0px;
                   3518:   border-spacing: 1px;
                   3519: }
                   3520: table#LC_helpmenu_links tr td {
                   3521:   padding: 1px;
                   3522:   background: $tabbg;
1.399     albertel 3523:   text-align: center;
                   3524:   font-weight: bold;
1.397     albertel 3525: }
1.396     albertel 3526: 
1.397     albertel 3527: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
                   3528: table#LC_helpmenu_links a:active {
                   3529:   text-decoration: none;
                   3530:   color: $font;
                   3531: }
                   3532: table#LC_helpmenu_links a:hover {
                   3533:   text-decoration: underline;
                   3534:   color: $vlink;
                   3535: }
1.396     albertel 3536: 
1.417     albertel 3537: .LC_chrt_popup_exists {
                   3538:   border: 1px solid #339933;
                   3539:   margin: -1px;
                   3540: }
                   3541: .LC_chrt_popup_up {
                   3542:   border: 1px solid yellow;
                   3543:   margin: -1px;
                   3544: }
                   3545: .LC_chrt_popup {
                   3546:   border: 1px solid #8888FF;
                   3547:   background: #CCCCFF;
                   3548: }
                   3549: 
1.421     albertel 3550: table.LC_pick_box {
                   3551:   width: 100%;
                   3552:   border-collapse: separate;
                   3553:   background: white;
                   3554:   border: 1px solid black;
                   3555:   border-spacing: 1px;
                   3556: }
                   3557: table.LC_pick_box td.LC_pick_box_title {
                   3558:   background: $tabbg;
                   3559:   font-weight: bold;
                   3560:   text-align: right;
                   3561:   width: 184px;
                   3562:   padding: 8px;
                   3563: }
1.424     albertel 3564: table.LC_pick_box td.LC_pick_box_separator {
1.421     albertel 3565:   padding: 0px;
                   3566:   height: 1px;
                   3567:   background: black;
                   3568: }
                   3569: table.LC_pick_box td.LC_pick_box_submit {
                   3570:   text-align: right;
                   3571: }
                   3572: 
1.424     albertel 3573: table.LC_group_priv_box {
                   3574:   background: white;
                   3575:   border: 1px solid black;
                   3576:   border-spacing: 1px;
                   3577: }
                   3578: table.LC_group_priv_box td.LC_pick_box_title {
                   3579:   background: $tabbg;
                   3580:   font-weight: bold;
                   3581:   text-align: right;
                   3582:   width: 184px;
                   3583: }
                   3584: table.LC_group_priv_box td.LC_groups_fixed {
                   3585:   background: $data_table_light;
                   3586:   text-align: center;
                   3587: }
                   3588: table.LC_group_priv_box td.LC_groups_optional {
                   3589:   background: $data_table_dark;
                   3590:   text-align: center;
                   3591: }
                   3592: table.LC_group_priv_box td.LC_groups_functionality {
                   3593:   background: $data_table_darker;
                   3594:   text-align: center;
                   3595:   font-weight: bold;
                   3596: }
                   3597: table.LC_group_priv td {
                   3598:   text-align: left;
                   3599:   padding: 0px;
                   3600: }
                   3601: 
1.421     albertel 3602: table.LC_notify_front_page {
                   3603:   background: white;
                   3604:   border: 1px solid black;
                   3605:   padding: 8px;
                   3606: }
                   3607: table.LC_notify_front_page td {
                   3608:   padding: 8px;
                   3609: }
1.424     albertel 3610: .LC_navbuttons {
                   3611:   margin: 2ex 0ex 2ex 0ex;
                   3612: }
1.423     albertel 3613: .LC_topic_bar {
                   3614:   font-family: $sans;
                   3615:   font-weight: bold;
                   3616:   width: 100%;
                   3617:   background: $tabbg;
                   3618:   vertical-align: middle;
                   3619:   margin: 2ex 0ex 2ex 0ex;
                   3620: }
                   3621: .LC_topic_bar span {
                   3622:   vertical-align: middle;
                   3623: }
                   3624: .LC_topic_bar img {
                   3625:   vertical-align: bottom;
                   3626: }
                   3627: table.LC_course_group_status {
                   3628:   margin: 20px;
                   3629: }
                   3630: table.LC_status_selector td {
                   3631:   vertical-align: top;
                   3632:   text-align: center;
1.424     albertel 3633:   padding: 4px;
                   3634: }
                   3635: table.LC_descriptive_input td.LC_description {
                   3636:   vertical-align: top;
                   3637:   text-align: right;
                   3638:   font-weight: bold;
1.423     albertel 3639: }
1.421     albertel 3640: 
1.343     albertel 3641: END
                   3642: }
                   3643: 
1.306     albertel 3644: =pod
                   3645: 
                   3646: =over 4
                   3647: 
                   3648: =item * &headtag()
                   3649: 
                   3650: Returns a uniform footer for LON-CAPA web pages.
                   3651: 
1.307     albertel 3652: Inputs: $title - optional title for the head
                   3653:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 3654:         $args - optional arguments
1.319     albertel 3655:             force_register - if is true call registerurl so the remote is 
                   3656:                              informed
1.415     albertel 3657:             redirect       -> array ref of
                   3658:                                    1- seconds before redirect occurs
                   3659:                                    2- url to redirect to
                   3660:                                    3- whether the side effect should occur
1.315     albertel 3661:                            (side effect of setting 
                   3662:                                $env{'internal.head.redirect'} to the url 
                   3663:                                redirected too)
1.352     albertel 3664:             domain         -> force to color decorate a page for a specific
                   3665:                                domain
                   3666:             function       -> force usage of a specific rolish color scheme
                   3667:             bgcolor        -> override the default page bgcolor
                   3668: 
1.306     albertel 3669: =back
                   3670: 
                   3671: =cut
                   3672: 
                   3673: sub headtag {
1.313     albertel 3674:     my ($title,$head_extra,$args) = @_;
1.306     albertel 3675:     
1.363     albertel 3676:     my $function = $args->{'function'} || &get_users_function();
                   3677:     my $domain   = $args->{'domain'}   || &determinedomain();
                   3678:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 3679:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
                   3680: 		   #time(),
                   3681: 		   $env{'environment.color.timestamp'},
1.363     albertel 3682: 		   $function,$domain,$bgcolor);
                   3683: 
1.369     www      3684:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 3685: 
1.308     albertel 3686:     my $result =
                   3687: 	'<head>'.
1.340     albertel 3688: 	&font_settings().
1.308     albertel 3689: 	&Apache::lonhtmlcommon::htmlareaheaders();
1.319     albertel 3690: 
                   3691:     if ($args->{'force_register'}) {
                   3692: 	$result .= &Apache::lonmenu::registerurl(1);
                   3693:     }
                   3694: 
1.314     albertel 3695:     if (ref($args->{'redirect'})) {
1.414     albertel 3696: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 3697: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 3698: 	if (!$inhibit_continue) {
                   3699: 	    $env{'internal.head.redirect'} = $url;
                   3700: 	}
1.313     albertel 3701: 	$result.=<<ADDMETA
                   3702: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 3703: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 3704: ADDMETA
                   3705:     }
1.306     albertel 3706:     if (!defined($title)) {
                   3707: 	$title = 'The LearningOnline Network with CAPA';
                   3708:     }
                   3709:     
1.414     albertel 3710:     $result .= '<title> LON-CAPA '.&mt($title).'</title>'
                   3711: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   3712: 	.$head_extra;
1.306     albertel 3713:     return $result;
                   3714: }
                   3715: 
                   3716: =pod
                   3717: 
                   3718: =over 4
                   3719: 
1.340     albertel 3720: =item * &font_settings()
                   3721: 
                   3722: Returns neccessary <meta> to set the proper encoding
                   3723: 
                   3724: Inputs: none
                   3725: 
                   3726: =back
                   3727: 
                   3728: =cut
                   3729: 
                   3730: sub font_settings {
                   3731:     my $headerstring='';
                   3732:     if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) { 
                   3733: 	$headerstring.=
                   3734: 	    '<meta Content-Type="text/html; charset=x-mac-roman" />';
                   3735:     } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
                   3736: 	$headerstring.=
                   3737: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   3738:     }
                   3739:     return $headerstring;
                   3740: }
                   3741: 
1.341     albertel 3742: =pod
                   3743: 
                   3744: =over 4
                   3745: 
                   3746: =item * &xml_begin()
                   3747: 
                   3748: Returns the needed doctype and <html>
                   3749: 
                   3750: Inputs: none
                   3751: 
                   3752: =back
                   3753: 
                   3754: =cut
                   3755: 
                   3756: sub xml_begin {
                   3757:     my $output='';
                   3758: 
1.342     albertel 3759:     &Apache::lonhtmlcommon::init_htmlareafields();
                   3760: 
1.341     albertel 3761:     if ($env{'browser.mathml'}) {
                   3762: 	$output='<?xml version="1.0"?>'
                   3763:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   3764: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   3765:             
                   3766: #	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
                   3767: 	    .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
                   3768:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   3769: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   3770:     } else {
                   3771: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   3772:     }
                   3773:     return $output;
                   3774: }
1.340     albertel 3775: 
                   3776: =pod
                   3777: 
                   3778: =over 4
                   3779: 
1.306     albertel 3780: =item * &endheadtag()
                   3781: 
                   3782: Returns a uniform </head> for LON-CAPA web pages.
                   3783: 
                   3784: Inputs: none
                   3785: 
                   3786: =back
                   3787: 
                   3788: =cut
                   3789: 
                   3790: sub endheadtag {
                   3791:     return '</head>';
                   3792: }
                   3793: 
                   3794: =pod
                   3795: 
                   3796: =over 4
                   3797: 
                   3798: =item * &head()
                   3799: 
                   3800: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   3801: 
                   3802: Inputs: $title - optional title for the page
1.307     albertel 3803:         $head_extra - optional extra HTML to put inside the <head>
1.405     albertel 3804: 
1.306     albertel 3805: =back
                   3806: 
                   3807: =cut
                   3808: 
                   3809: sub head {
1.325     albertel 3810:     my ($title,$head_extra,$args) = @_;
                   3811:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 3812: }
                   3813: 
                   3814: =pod
                   3815: 
                   3816: =over 4
                   3817: 
                   3818: =item * &start_page()
                   3819: 
                   3820: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   3821: 
                   3822: Inputs: $title - optional title for the page
                   3823:         $head_extra - optional extra HTML to incude inside the <head>
1.315     albertel 3824:         $args - additional optional args supported are:
1.317     albertel 3825:                   only_body      -> is true will set &bodytag() onlybodytag
                   3826:                                     arg on
                   3827:                   no_nav_bar     -> is true will set &bodytag() notopbar arg on
                   3828:                   add_entries    -> additional attributes to add to the  <body>
                   3829:                   domain         -> force to color decorate a page for a 
                   3830:                                     specific domain
                   3831:                   function       -> force usage of a specific rolish color
                   3832:                                     scheme
                   3833:                   redirect       -> see &headtag()
                   3834:                   bgcolor        -> override the default page bg color
                   3835:                   js_ready       -> return a string ready for being used in 
                   3836:                                     a javascript writeln
1.320     albertel 3837:                   html_encode    -> return a string ready for being used in 
                   3838:                                     a html attribute
1.317     albertel 3839:                   force_register -> if is true will turn on the &bodytag()
                   3840:                                     $forcereg arg
1.326     albertel 3841:                   body_title     -> alternate text to use instead of $title
                   3842:                                     in the title box that appears, this text
                   3843:                                     is not auto translated like the $title is
1.330     albertel 3844:                   frameset       -> if true will start with a <frameset>
                   3845:                                     rather than <body>
1.338     albertel 3846:                   no_title       -> if true the title bar won't be shown
                   3847:                   skip_phases    -> hash ref of 
                   3848:                                     head -> skip the <html><head> generation
                   3849:                                     body -> skip all <body> generation
1.337     albertel 3850: 
1.361     albertel 3851:                   no_inline_link -> if true and in remote mode, don't show the 
                   3852:                                     'Switch To Inline Menu' link
                   3853: 
1.306     albertel 3854: =back
                   3855: 
                   3856: =cut
                   3857: 
                   3858: sub start_page {
1.309     albertel 3859:     my ($title,$head_extra,$args) = @_;
1.318     albertel 3860:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 3861:     my %head_args;
1.352     albertel 3862:     foreach my $arg ('redirect','force_register','domain','function',
                   3863: 		     'bgcolor') {
1.319     albertel 3864: 	if (defined($args->{$arg})) {
1.324     raeburn  3865: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 3866: 	}
1.313     albertel 3867:     }
1.319     albertel 3868: 
1.315     albertel 3869:     $env{'internal.start_page'}++;
1.338     albertel 3870:     my $result;
                   3871:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   3872: 	$result.=
1.341     albertel 3873: 	    &xml_begin().
1.338     albertel 3874: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   3875:     }
                   3876:     
                   3877:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   3878: 	if ($args->{'frameset'}) {
                   3879: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   3880: 						$args->{'add_entries'});
                   3881: 	    $result .= "\n<frameset $attr_string>\n";
                   3882: 	} else {
                   3883: 	    $result .=
                   3884: 		&bodytag($title, 
                   3885: 			 $args->{'function'},       $args->{'add_entries'},
                   3886: 			 $args->{'only_body'},      $args->{'domain'},
                   3887: 			 $args->{'force_register'}, $args->{'body_title'},
                   3888: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.361     albertel 3889: 			 $args->{'no_title'},       $args->{'no_inline_link'});
1.338     albertel 3890: 	}
1.330     albertel 3891:     }
1.338     albertel 3892: 
1.315     albertel 3893:     if ($args->{'js_ready'}) {
1.317     albertel 3894: 	$result = &js_ready($result);
1.315     albertel 3895:     }
1.320     albertel 3896:     if ($args->{'html_encode'}) {
                   3897: 	$result = &html_encode($result);
                   3898:     }
1.315     albertel 3899:     return $result;
1.306     albertel 3900: }
                   3901: 
1.330     albertel 3902: 
1.306     albertel 3903: =pod
                   3904: 
                   3905: =over 4
                   3906: 
                   3907: =item * &head()
                   3908: 
                   3909: Returns a complete </body></html> section for LON-CAPA web pages.
                   3910: 
1.315     albertel 3911: Inputs:         $args - additional optional args supported are:
                   3912:                  js_ready     -> return a string ready for being used in 
                   3913:                                  a javascript writeln
1.320     albertel 3914:                  html_encode  -> return a string ready for being used in 
                   3915:                                  a html attribute
1.330     albertel 3916:                  frameset     -> if true will start with a <frameset>
                   3917:                                  rather than <body>
1.306     albertel 3918: 
                   3919: =cut
                   3920: 
                   3921: sub end_page {
1.315     albertel 3922:     my ($args) = @_;
                   3923:     $env{'internal.end_page'}++;
1.330     albertel 3924:     my $result;
1.335     albertel 3925:     if ($args->{'discussion'}) {
                   3926: 	my ($target,$parser);
                   3927: 	if (ref($args->{'discussion'})) {
                   3928: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   3929: 				$args->{'discussion'}{'parser'});
                   3930: 	}
                   3931: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   3932:     }
                   3933: 
1.330     albertel 3934:     if ($args->{'frameset'}) {
                   3935: 	$result .= '</frameset>';
                   3936:     } else {
                   3937: 	$result .= &endbodytag();
                   3938:     }
                   3939:     $result .= "\n</html>";
                   3940: 
1.315     albertel 3941:     if ($args->{'js_ready'}) {
1.317     albertel 3942: 	$result = &js_ready($result);
1.315     albertel 3943:     }
1.335     albertel 3944: 
1.320     albertel 3945:     if ($args->{'html_encode'}) {
                   3946: 	$result = &html_encode($result);
                   3947:     }
1.335     albertel 3948: 
1.315     albertel 3949:     return $result;
                   3950: }
                   3951: 
1.320     albertel 3952: sub html_encode {
                   3953:     my ($result) = @_;
                   3954: 
1.322     albertel 3955:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 3956:     
                   3957:     return $result;
                   3958: }
1.317     albertel 3959: sub js_ready {
                   3960:     my ($result) = @_;
                   3961: 
1.323     albertel 3962:     $result =~ s/[\n\r]/ /xmsg;
                   3963:     $result =~ s/\\/\\\\/xmsg;
                   3964:     $result =~ s/'/\\'/xmsg;
1.372     albertel 3965:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 3966:     
                   3967:     return $result;
                   3968: }
                   3969: 
1.315     albertel 3970: sub validate_page {
                   3971:     if (  exists($env{'internal.start_page'})
1.316     albertel 3972: 	  &&     $env{'internal.start_page'} > 1) {
                   3973: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 3974: 				 $env{'internal.start_page'}.' '.
1.316     albertel 3975: 				 $ENV{'request.filename'});
1.315     albertel 3976:     }
                   3977:     if (  exists($env{'internal.end_page'})
1.316     albertel 3978: 	  &&     $env{'internal.end_page'} > 1) {
                   3979: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 3980: 				 $env{'internal.end_page'}.' '.
1.316     albertel 3981: 				 $env{'request.filename'});
1.315     albertel 3982:     }
                   3983:     if (     exists($env{'internal.start_page'})
                   3984: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 3985: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   3986: 				 $env{'request.filename'});
1.315     albertel 3987:     }
                   3988:     if (   ! exists($env{'internal.start_page'})
                   3989: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 3990: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   3991: 				 $env{'request.filename'});
1.315     albertel 3992:     }
1.306     albertel 3993: }
1.315     albertel 3994: 
1.318     albertel 3995: sub simple_error_page {
                   3996:     my ($r,$title,$msg) = @_;
                   3997:     my $page =
                   3998: 	&Apache::loncommon::start_page($title).
                   3999: 	&mt($msg).
                   4000: 	&Apache::loncommon::end_page();
                   4001:     if (ref($r)) {
                   4002: 	$r->print($page);
1.327     albertel 4003: 	return;
1.318     albertel 4004:     }
                   4005:     return $page;
                   4006: }
1.347     albertel 4007: 
                   4008: {
                   4009:     my $row_count;
                   4010:     sub start_data_table {
1.422     albertel 4011: 	my ($add_class) = @_;
                   4012: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.347     albertel 4013: 	undef($row_count);
1.422     albertel 4014: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 4015:     }
                   4016: 
                   4017:     sub end_data_table {
                   4018: 	undef($row_count);
1.389     albertel 4019: 	return '</table>'."\n";;
1.347     albertel 4020:     }
                   4021: 
                   4022:     sub start_data_table_row {
1.422     albertel 4023: 	my ($add_class) = @_;
1.347     albertel 4024: 	$row_count++;
1.422     albertel 4025: 	my $css_class = ($row_count % 2)?'':'LC_even_row';
1.428     albertel 4026: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 4027: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 4028:     }
                   4029: 
                   4030:     sub end_data_table_row {
1.389     albertel 4031: 	return '</tr>'."\n";;
1.347     albertel 4032:     }
1.367     www      4033: 
1.421     albertel 4034:     sub start_data_table_empty_row {
                   4035: 	$row_count++;
                   4036: 	return  '<tr class="LC_empty_row" >'."\n";;
                   4037:     }
                   4038: 
                   4039:     sub end_data_table_empty_row {
                   4040: 	return '</tr>'."\n";;
                   4041:     }
                   4042: 
1.367     www      4043:     sub start_data_table_header_row {
1.389     albertel 4044: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      4045:     }
                   4046: 
                   4047:     sub end_data_table_header_row {
1.389     albertel 4048: 	return '</tr>'."\n";;
1.367     www      4049:     }
1.347     albertel 4050: }
                   4051: 
1.251     albertel 4052: ###############################################
1.182     matthew  4053: 
                   4054: =pod
                   4055: 
1.405     albertel 4056: =item * &get_users_function()
1.182     matthew  4057: 
                   4058: Used by &bodytag to determine the current users primary role.
                   4059: Returns either 'student','coordinator','admin', or 'author'.
                   4060: 
                   4061: =cut
                   4062: 
                   4063: ###############################################
                   4064: sub get_users_function {
                   4065:     my $function = 'student';
1.258     albertel 4066:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  4067:         $function='coordinator';
                   4068:     }
1.258     albertel 4069:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  4070:         $function='admin';
                   4071:     }
1.258     albertel 4072:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  4073:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   4074:         $function='author';
                   4075:     }
                   4076:     return $function;
1.54      www      4077: }
1.99      www      4078: 
                   4079: ###############################################
                   4080: 
1.233     raeburn  4081: =pod
                   4082: 
1.405     albertel 4083: =item * &check_user_status
1.274     raeburn  4084: 
                   4085: Determines current status of supplied role for a
                   4086: specific user. Roles can be active, previous or future.
                   4087: 
                   4088: Inputs: 
                   4089: user's domain, user's username, course's domain,
1.375     raeburn  4090: course's number, optional section ID.
1.274     raeburn  4091: 
                   4092: Outputs:
                   4093: role status: active, previous or future. 
                   4094: 
                   4095: =cut
                   4096: 
                   4097: sub check_user_status {
1.412     raeburn  4098:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  4099:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   4100:     my @uroles = keys %userinfo;
                   4101:     my $srchstr;
                   4102:     my $active_chk = 'none';
1.412     raeburn  4103:     my $now = time;
1.274     raeburn  4104:     if (@uroles > 0) {
1.412     raeburn  4105:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  4106:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   4107:         } else {
1.412     raeburn  4108:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   4109:         }
                   4110:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  4111:             my $role_end = 0;
                   4112:             my $role_start = 0;
                   4113:             $active_chk = 'active';
1.412     raeburn  4114:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   4115:                 $role_end = $1;
                   4116:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   4117:                     $role_start = $1;
1.274     raeburn  4118:                 }
                   4119:             }
                   4120:             if ($role_start > 0) {
1.412     raeburn  4121:                 if ($now < $role_start) {
1.274     raeburn  4122:                     $active_chk = 'future';
                   4123:                 }
                   4124:             }
                   4125:             if ($role_end > 0) {
1.412     raeburn  4126:                 if ($now > $role_end) {
1.274     raeburn  4127:                     $active_chk = 'previous';
                   4128:                 }
                   4129:             }
                   4130:         }
                   4131:     }
                   4132:     return $active_chk;
                   4133: }
                   4134: 
                   4135: ###############################################
                   4136: 
                   4137: =pod
                   4138: 
1.405     albertel 4139: =item * &get_sections()
1.233     raeburn  4140: 
                   4141: Determines all the sections for a course including
                   4142: sections with students and sections containing other roles.
1.419     raeburn  4143: Incoming parameters: 
                   4144: 
                   4145: 1. domain
                   4146: 2. course number 
                   4147: 3. reference to array containing roles for which sections should 
                   4148: be gathered (optional).
                   4149: 4. reference to array containing status types for which sections 
                   4150: should be gathered (optional).
                   4151: 
                   4152: If the third argument is undefined, sections are gathered for any role. 
                   4153: If the fourth argument is undefined, sections are gathered for any status.
                   4154: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  4155:  
1.374     raeburn  4156: Returns section hash (keys are section IDs, values are
                   4157: number of users in each section), subject to the
1.419     raeburn  4158: optional roles filter, optional status filter 
1.233     raeburn  4159: 
                   4160: =cut
                   4161: 
                   4162: ###############################################
                   4163: sub get_sections {
1.419     raeburn  4164:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 4165:     if (!defined($cdom) || !defined($cnum)) {
                   4166:         my $cid =  $env{'request.course.id'};
                   4167: 
                   4168: 	return if (!defined($cid));
                   4169: 
                   4170:         $cdom = $env{'course.'.$cid.'.domain'};
                   4171:         $cnum = $env{'course.'.$cid.'.num'};
                   4172:     }
                   4173: 
                   4174:     my %sectioncount;
1.419     raeburn  4175:     my $now = time;
1.240     albertel 4176: 
1.366     albertel 4177:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 4178: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 4179: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   4180: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  4181:         my $start_index = &Apache::loncoursedata::CL_START();
                   4182:         my $end_index = &Apache::loncoursedata::CL_END();
                   4183:         my $status;
1.366     albertel 4184: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  4185: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   4186: 				                     $data->[$status_index],
                   4187:                                                      $data->[$start_index],
                   4188:                                                      $data->[$end_index]);
                   4189:             if ($stu_status eq 'Active') {
                   4190:                 $status = 'active';
                   4191:             } elsif ($end < $now) {
                   4192:                 $status = 'previous';
                   4193:             } elsif ($start > $now) {
                   4194:                 $status = 'future';
                   4195:             } 
                   4196: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   4197:                 if ((!defined($possible_status)) || (($status ne '') && 
                   4198:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   4199: 		    $sectioncount{$section}++;
                   4200:                 }
1.240     albertel 4201: 	    }
                   4202: 	}
                   4203:     }
                   4204:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   4205:     foreach my $user (sort(keys(%courseroles))) {
                   4206: 	if ($user !~ /^(\w{2})/) { next; }
                   4207: 	my ($role) = ($user =~ /^(\w{2})/);
                   4208: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  4209: 	my ($section,$status);
1.240     albertel 4210: 	if ($role eq 'cr' &&
                   4211: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   4212: 	    $section=$1;
                   4213: 	}
                   4214: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   4215: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  4216:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   4217:         if ($end == -1 && $start == -1) {
                   4218:             next; #deleted role
                   4219:         }
                   4220:         if (!defined($possible_status)) { 
                   4221:             $sectioncount{$section}++;
                   4222:         } else {
                   4223:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   4224:                 $status = 'active';
                   4225:             } elsif ($end < $now) {
                   4226:                 $status = 'future';
                   4227:             } elsif ($start > $now) {
                   4228:                 $status = 'previous';
                   4229:             }
                   4230:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   4231:                 $sectioncount{$section}++;
                   4232:             }
                   4233:         }
1.233     raeburn  4234:     }
1.366     albertel 4235:     return %sectioncount;
1.233     raeburn  4236: }
                   4237: 
1.274     raeburn  4238: ###############################################
1.294     raeburn  4239: 
                   4240: =pod
1.405     albertel 4241: 
                   4242: =item * &get_course_users()
                   4243: 
1.275     raeburn  4244: Retrieves usernames:domains for users in the specified course
                   4245: with specific role(s), and access status. 
                   4246: 
                   4247: Incoming parameters:
1.277     albertel 4248: 1. course domain
                   4249: 2. course number
                   4250: 3. access status: users must have - either active, 
1.275     raeburn  4251: previous, future, or all.
1.277     albertel 4252: 4. reference to array of permissible roles
1.288     raeburn  4253: 5. reference to array of section restrictions (optional)
                   4254: 6. reference to results object (hash of hashes).
                   4255: 7. reference to optional userdata hash
1.275     raeburn  4256: Keys of top level hash are roles.
                   4257: Keys of inner hashes are username:domain, with 
                   4258: values set to access type.
1.288     raeburn  4259: Optional userdata hash returns an array with arguments in the 
                   4260: same order as loncoursedata::get_classlist() for student data.
                   4261: 
                   4262: Entries for end, start, section and status are blank because
                   4263: of the possibility of multiple values for non-student roles.
                   4264: 
1.275     raeburn  4265: =cut
1.405     albertel 4266: 
1.275     raeburn  4267: ###############################################
1.405     albertel 4268: 
1.275     raeburn  4269: sub get_course_users {
1.288     raeburn  4270:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
                   4271:     my %idx = ();
1.419     raeburn  4272:     my %seclists;
1.288     raeburn  4273: 
                   4274:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   4275:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   4276:     $idx{end} = &Apache::loncoursedata::CL_END();
                   4277:     $idx{start} = &Apache::loncoursedata::CL_START();
                   4278:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   4279:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   4280:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   4281:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   4282: 
1.290     albertel 4283:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 4284:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  4285:         my $now = time;
1.277     albertel 4286:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  4287:             my $match = 0;
1.412     raeburn  4288:             my $secmatch = 0;
1.419     raeburn  4289:             my $section = $$classlist{$student}[$idx{section}];
                   4290:             if ($section eq '') {
                   4291:                 $section = 'none';
                   4292:             }
1.291     albertel 4293:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 4294:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  4295:                     $secmatch = 1;
                   4296:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 4297:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  4298:                         $secmatch = 1;
                   4299:                     }
                   4300:                 } else {  
1.419     raeburn  4301: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  4302: 		        $secmatch = 1;
                   4303:                     }
1.290     albertel 4304: 		}
1.412     raeburn  4305:                 if (!$secmatch) {
                   4306:                     next;
                   4307:                 }
1.419     raeburn  4308:             }
1.420     albertel 4309:             push(@{$seclists{$student}},$section); 
1.275     raeburn  4310:             if (defined($$types{'active'})) {
1.288     raeburn  4311:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  4312:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  4313:                     $match = 1;
1.275     raeburn  4314:                 }
                   4315:             }
                   4316:             if (defined($$types{'previous'})) {
1.288     raeburn  4317:                 if ($$classlist{$student}[$idx{end}] <= $now) {
1.275     raeburn  4318:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  4319:                     $match = 1;
1.275     raeburn  4320:                 }
                   4321:             }
                   4322:             if (defined($$types{'future'})) {
1.288     raeburn  4323:                 if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
1.275     raeburn  4324:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  4325:                     $match = 1;
1.275     raeburn  4326:                 }
                   4327:             }
1.412     raeburn  4328:             if ($match && ref($userdata) eq 'HASH') {
1.288     raeburn  4329:                 $$userdata{$student} = $$classlist{$student};
                   4330:             }
1.275     raeburn  4331:         }
                   4332:     }
1.412     raeburn  4333:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.275     raeburn  4334:         my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
                   4335:         foreach my $person (@coursepersonnel) {
1.288     raeburn  4336:             my $match = 0;
1.412     raeburn  4337:             my $secmatch = 0;
                   4338:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  4339:             $user =~ s/:$//;
1.290     albertel 4340:             if (($role) && (grep(/^\Q$role\E$/,@{$roles}))) {
1.412     raeburn  4341:                 my ($uname,$udom) = split(/:/,$user);
                   4342:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 4343:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  4344:                         $secmatch = 1;
                   4345:                     } elsif ($usec eq '') {
1.420     albertel 4346:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  4347:                             $secmatch = 1;
                   4348:                         }
                   4349:                     } else {
                   4350:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   4351:                             $secmatch = 1;
                   4352:                         }
                   4353:                     }
                   4354:                     if (!$secmatch) {
                   4355:                         next;
                   4356:                     }
1.288     raeburn  4357:                 }
1.419     raeburn  4358:                 if ($usec eq '') {
                   4359:                     $usec = 'none';
                   4360:                 }
1.275     raeburn  4361:                 if ($uname ne '' && $udom ne '') {
1.412     raeburn  4362:                     my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role,
                   4363:                                                     $usec);
1.277     albertel 4364:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  4365:                         if ($status eq $type) {
1.420     albertel 4366:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  4367:                                 push(@{$$users{$role}{$user}},$type);
                   4368:                             }
1.288     raeburn  4369:                             $match = 1;
                   4370:                         }
                   4371:                     }
1.419     raeburn  4372:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   4373:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   4374: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   4375:                         }
1.420     albertel 4376:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  4377:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   4378:                         }
1.275     raeburn  4379:                     }
                   4380:                 }
                   4381:             }
                   4382:         }
1.290     albertel 4383:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  4384:             if ((defined($cdom)) && (defined($cnum))) {
                   4385:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   4386:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   4387:                     my $owner = $csettings{'internal.courseowner'};
1.288     raeburn  4388:                     @{$$users{'ow'}{$owner.':'.$cdom}} = 'any';
1.290     albertel 4389:                     if (defined($userdata) && 
                   4390: 			!exists($$userdata{$owner.':'.$cdom})) {
                   4391: 			&get_user_info($cdom,$owner,\%idx,$userdata);
1.420     albertel 4392:                         if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
1.419     raeburn  4393:                             push(@{$seclists{$owner.':'.$cdom}},'none');
                   4394:                         }
1.290     albertel 4395: 		    }
1.279     raeburn  4396:                 }
                   4397:             }
                   4398:         }
1.419     raeburn  4399:         foreach my $user (keys(%seclists)) {
                   4400:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   4401:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   4402:         }
1.275     raeburn  4403:     }
                   4404:     return;
                   4405: }
                   4406: 
1.288     raeburn  4407: sub get_user_info {
                   4408:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 4409:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   4410: 	&plainname($uname,$udom,'lastname');
1.291     albertel 4411:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  4412:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.288     raeburn  4413:     return;
                   4414: }
1.275     raeburn  4415: 
1.384     raeburn  4416: sub get_secgrprole_info {
                   4417:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   4418:     my %sections_count = &get_sections($cdom,$cnum);
                   4419:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   4420:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   4421:     my @groups = sort(keys(%curr_groups));
                   4422:     my $allroles = [];
                   4423:     my $rolehash;
                   4424:     my $accesshash = {
                   4425:                      active => 'Currently has access',
                   4426:                      future => 'Will have future access',
                   4427:                      previous => 'Previously had access',
                   4428:                   };
                   4429:     if ($needroles) {
                   4430:         $rolehash = {'all' => 'all'};
1.385     albertel 4431:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   4432: 	if (&Apache::lonnet::error(%user_roles)) {
                   4433: 	    undef(%user_roles);
                   4434: 	}
                   4435:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  4436:             my ($role)=split(/\:/,$item,2);
                   4437:             if ($role eq 'cr') { next; }
                   4438:             if ($role =~ /^cr/) {
                   4439:                 $$rolehash{$role} = (split('/',$role))[3];
                   4440:             } else {
                   4441:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   4442:             }
                   4443:         }
                   4444:         foreach my $key (sort(keys(%{$rolehash}))) {
                   4445:             push(@{$allroles},$key);
                   4446:         }
                   4447:         push (@{$allroles},'st');
                   4448:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   4449:     }
                   4450:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   4451: }
                   4452: 
1.112     bowersj2 4453: =pod
                   4454: 
                   4455: =item * get_unprocessed_cgi($query,$possible_names)
                   4456: 
1.258     albertel 4457: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 4458: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 4459: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 4460: 
                   4461: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   4462: $possible_names is an ref to an array of form element names.  As an example:
                   4463: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 4464: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 4465: 
                   4466: =cut
1.1       albertel 4467: 
1.6       albertel 4468: sub get_unprocessed_cgi {
1.25      albertel 4469:   my ($query,$possible_names)= @_;
1.26      matthew  4470:   # $Apache::lonxml::debug=1;
1.356     albertel 4471:   foreach my $pair (split(/&/,$query)) {
                   4472:     my ($name, $value) = split(/=/,$pair);
1.369     www      4473:     $name = &unescape($name);
1.25      albertel 4474:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   4475:       $value =~ tr/+/ /;
                   4476:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 4477:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 4478:     }
1.16      harris41 4479:   }
1.6       albertel 4480: }
                   4481: 
1.112     bowersj2 4482: =pod
                   4483: 
                   4484: =item * cacheheader() 
                   4485: 
                   4486: returns cache-controlling header code
                   4487: 
                   4488: =cut
                   4489: 
1.7       albertel 4490: sub cacheheader {
1.258     albertel 4491:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 4492:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   4493:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 4494:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   4495:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 4496:     return $output;
1.7       albertel 4497: }
                   4498: 
1.112     bowersj2 4499: =pod
                   4500: 
                   4501: =item * no_cache($r) 
                   4502: 
                   4503: specifies header code to not have cache
                   4504: 
                   4505: =cut
                   4506: 
1.9       albertel 4507: sub no_cache {
1.216     albertel 4508:     my ($r) = @_;
                   4509:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 4510: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 4511:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   4512:     $r->no_cache(1);
                   4513:     $r->header_out("Expires" => $date);
                   4514:     $r->header_out("Pragma" => "no-cache");
1.123     www      4515: }
                   4516: 
                   4517: sub content_type {
1.181     albertel 4518:     my ($r,$type,$charset) = @_;
1.299     foxr     4519:     if ($r) {
                   4520: 	#  Note that printout.pl calls this with undef for $r.
                   4521: 	&no_cache($r);
                   4522:     }
1.258     albertel 4523:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 4524:     unless ($charset) {
                   4525: 	$charset=&Apache::lonlocal::current_encoding;
                   4526:     }
                   4527:     if ($charset) { $type.='; charset='.$charset; }
                   4528:     if ($r) {
                   4529: 	$r->content_type($type);
                   4530:     } else {
                   4531: 	print("Content-type: $type\n\n");
                   4532:     }
1.9       albertel 4533: }
1.25      albertel 4534: 
1.112     bowersj2 4535: =pod
                   4536: 
                   4537: =item * add_to_env($name,$value) 
                   4538: 
1.258     albertel 4539: adds $name to the %env hash with value
1.112     bowersj2 4540: $value, if $name already exists, the entry is converted to an array
                   4541: reference and $value is added to the array.
                   4542: 
                   4543: =cut
                   4544: 
1.25      albertel 4545: sub add_to_env {
                   4546:   my ($name,$value)=@_;
1.258     albertel 4547:   if (defined($env{$name})) {
                   4548:     if (ref($env{$name})) {
1.25      albertel 4549:       #already have multiple values
1.258     albertel 4550:       push(@{ $env{$name} },$value);
1.25      albertel 4551:     } else {
                   4552:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 4553:       my $first=$env{$name};
                   4554:       undef($env{$name});
                   4555:       push(@{ $env{$name} },$first,$value);
1.25      albertel 4556:     }
                   4557:   } else {
1.258     albertel 4558:     $env{$name}=$value;
1.25      albertel 4559:   }
1.31      albertel 4560: }
1.149     albertel 4561: 
                   4562: =pod
                   4563: 
                   4564: =item * get_env_multiple($name) 
                   4565: 
1.258     albertel 4566: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 4567: values may be defined and end up as an array ref.
                   4568: 
                   4569: returns an array of values
                   4570: 
                   4571: =cut
                   4572: 
                   4573: sub get_env_multiple {
                   4574:     my ($name) = @_;
                   4575:     my @values;
1.258     albertel 4576:     if (defined($env{$name})) {
1.149     albertel 4577:         # exists is it an array
1.258     albertel 4578:         if (ref($env{$name})) {
                   4579:             @values=@{ $env{$name} };
1.149     albertel 4580:         } else {
1.258     albertel 4581:             $values[0]=$env{$name};
1.149     albertel 4582:         }
                   4583:     }
                   4584:     return(@values);
                   4585: }
                   4586: 
1.31      albertel 4587: 
1.41      ng       4588: =pod
1.45      matthew  4589: 
                   4590: =back 
1.41      ng       4591: 
1.112     bowersj2 4592: =head1 CSV Upload/Handling functions
1.38      albertel 4593: 
1.41      ng       4594: =over 4
                   4595: 
1.112     bowersj2 4596: =item * upfile_store($r)
1.41      ng       4597: 
                   4598: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 4599: needs $env{'form.upfile'}
1.41      ng       4600: returns $datatoken to be put into hidden field
                   4601: 
                   4602: =cut
1.31      albertel 4603: 
                   4604: sub upfile_store {
                   4605:     my $r=shift;
1.258     albertel 4606:     $env{'form.upfile'}=~s/\r/\n/gs;
                   4607:     $env{'form.upfile'}=~s/\f/\n/gs;
                   4608:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   4609:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 4610: 
1.258     albertel 4611:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   4612: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 4613:     {
1.158     raeburn  4614:         my $datafile = $r->dir_config('lonDaemons').
                   4615:                            '/tmp/'.$datatoken.'.tmp';
                   4616:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 4617:             print $fh $env{'form.upfile'};
1.158     raeburn  4618:             close($fh);
                   4619:         }
1.31      albertel 4620:     }
                   4621:     return $datatoken;
                   4622: }
                   4623: 
1.56      matthew  4624: =pod
                   4625: 
1.112     bowersj2 4626: =item * load_tmp_file($r)
1.41      ng       4627: 
                   4628: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 4629: needs $env{'form.datatoken'},
                   4630: sets $env{'form.upfile'} to the contents of the file
1.41      ng       4631: 
                   4632: =cut
1.31      albertel 4633: 
                   4634: sub load_tmp_file {
                   4635:     my $r=shift;
                   4636:     my @studentdata=();
                   4637:     {
1.158     raeburn  4638:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 4639:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  4640:         if ( open(my $fh,"<$studentfile") ) {
                   4641:             @studentdata=<$fh>;
                   4642:             close($fh);
                   4643:         }
1.31      albertel 4644:     }
1.258     albertel 4645:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 4646: }
                   4647: 
1.56      matthew  4648: =pod
                   4649: 
1.112     bowersj2 4650: =item * upfile_record_sep()
1.41      ng       4651: 
                   4652: Separate uploaded file into records
                   4653: returns array of records,
1.258     albertel 4654: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       4655: 
                   4656: =cut
1.31      albertel 4657: 
                   4658: sub upfile_record_sep {
1.258     albertel 4659:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 4660:     } else {
1.248     albertel 4661: 	my @records;
1.258     albertel 4662: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 4663: 	    if ($line=~/^\s*$/) { next; }
                   4664: 	    push(@records,$line);
                   4665: 	}
                   4666: 	return @records;
1.31      albertel 4667:     }
                   4668: }
                   4669: 
1.56      matthew  4670: =pod
                   4671: 
1.112     bowersj2 4672: =item * record_sep($record)
1.41      ng       4673: 
1.258     albertel 4674: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       4675: 
                   4676: =cut
                   4677: 
1.263     www      4678: sub takeleft {
                   4679:     my $index=shift;
                   4680:     return substr('0000'.$index,-4,4);
                   4681: }
                   4682: 
1.31      albertel 4683: sub record_sep {
                   4684:     my $record=shift;
                   4685:     my %components=();
1.258     albertel 4686:     if ($env{'form.upfiletype'} eq 'xml') {
                   4687:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 4688:         my $i=0;
1.356     albertel 4689:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 4690:             $field=~s/^(\"|\')//;
                   4691:             $field=~s/(\"|\')$//;
1.263     www      4692:             $components{&takeleft($i)}=$field;
1.31      albertel 4693:             $i++;
                   4694:         }
1.258     albertel 4695:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 4696:         my $i=0;
1.356     albertel 4697:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 4698:             $field=~s/^(\"|\')//;
                   4699:             $field=~s/(\"|\')$//;
1.263     www      4700:             $components{&takeleft($i)}=$field;
1.31      albertel 4701:             $i++;
                   4702:         }
                   4703:     } else {
                   4704:         my @allfields=split(/\,/,$record);
                   4705:         my $i=0;
                   4706:         my $j;
                   4707:         for ($j=0;$j<=$#allfields;$j++) {
                   4708:             my $field=$allfields[$j];
                   4709:             if ($field=~/^\s*(\"|\')/) {
                   4710: 		my $delimiter=$1;
                   4711:                 while (($field!~/$delimiter$/) && ($j<$#allfields)) {
                   4712: 		    $j++;
                   4713: 		    $field.=','.$allfields[$j];
                   4714: 		}
                   4715:                 $field=~s/^\s*$delimiter//;
                   4716:                 $field=~s/$delimiter\s*$//;
                   4717:             }
1.263     www      4718:             $components{&takeleft($i)}=$field;
1.31      albertel 4719: 	    $i++;
                   4720:         }
                   4721:     }
                   4722:     return %components;
                   4723: }
                   4724: 
1.144     matthew  4725: ######################################################
                   4726: ######################################################
                   4727: 
1.56      matthew  4728: =pod
                   4729: 
1.112     bowersj2 4730: =item * upfile_select_html()
1.41      ng       4731: 
1.144     matthew  4732: Return HTML code to select a file from the users machine and specify 
                   4733: the file type.
1.41      ng       4734: 
                   4735: =cut
                   4736: 
1.144     matthew  4737: ######################################################
                   4738: ######################################################
1.31      albertel 4739: sub upfile_select_html {
1.144     matthew  4740:     my %Types = (
                   4741:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
                   4742:                  space => &mt('Space separated'),
                   4743:                  tab   => &mt('Tabulator separated'),
                   4744: #                 xml   => &mt('HTML/XML'),
                   4745:                  );
                   4746:     my $Str = '<input type="file" name="upfile" size="50" />'.
                   4747:         '<br />Type: <select name="upfiletype">';
                   4748:     foreach my $type (sort(keys(%Types))) {
                   4749:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   4750:     }
                   4751:     $Str .= "</select>\n";
                   4752:     return $Str;
1.31      albertel 4753: }
                   4754: 
1.301     albertel 4755: sub get_samples {
                   4756:     my ($records,$toget) = @_;
                   4757:     my @samples=({});
                   4758:     my $got=0;
                   4759:     foreach my $rec (@$records) {
                   4760: 	my %temp = &record_sep($rec);
                   4761: 	if (! grep(/\S/, values(%temp))) { next; }
                   4762: 	if (%temp) {
                   4763: 	    $samples[$got]=\%temp;
                   4764: 	    $got++;
                   4765: 	    if ($got == $toget) { last; }
                   4766: 	}
                   4767:     }
                   4768:     return \@samples;
                   4769: }
                   4770: 
1.144     matthew  4771: ######################################################
                   4772: ######################################################
                   4773: 
1.56      matthew  4774: =pod
                   4775: 
1.112     bowersj2 4776: =item * csv_print_samples($r,$records)
1.41      ng       4777: 
                   4778: Prints a table of sample values from each column uploaded $r is an
                   4779: Apache Request ref, $records is an arrayref from
                   4780: &Apache::loncommon::upfile_record_sep
                   4781: 
                   4782: =cut
                   4783: 
1.144     matthew  4784: ######################################################
                   4785: ######################################################
1.31      albertel 4786: sub csv_print_samples {
                   4787:     my ($r,$records) = @_;
1.301     albertel 4788:     my $samples = &get_samples($records,3);
                   4789: 
1.144     matthew  4790:     $r->print(&mt('Samples').'<br /><table border="2"><tr>');
1.356     albertel 4791:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   4792:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.31      albertel 4793:     $r->print('</tr>');
1.301     albertel 4794:     foreach my $hash (@$samples) {
1.31      albertel 4795: 	$r->print('<tr>');
1.356     albertel 4796: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 4797: 	    $r->print('<td>');
1.356     albertel 4798: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 4799: 	    $r->print('</td>');
                   4800: 	}
                   4801: 	$r->print('</tr>');
                   4802:     }
                   4803:     $r->print('</tr></table><br />'."\n");
                   4804: }
                   4805: 
1.144     matthew  4806: ######################################################
                   4807: ######################################################
                   4808: 
1.56      matthew  4809: =pod
                   4810: 
1.112     bowersj2 4811: =item * csv_print_select_table($r,$records,$d)
1.41      ng       4812: 
                   4813: Prints a table to create associations between values and table columns.
1.144     matthew  4814: 
1.41      ng       4815: $r is an Apache Request ref,
                   4816: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  4817: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       4818: 
                   4819: =cut
                   4820: 
1.144     matthew  4821: ######################################################
                   4822: ######################################################
1.31      albertel 4823: sub csv_print_select_table {
                   4824:     my ($r,$records,$d) = @_;
1.301     albertel 4825:     my $i=0;
                   4826:     my $samples = &get_samples($records,1);
1.144     matthew  4827:     $r->print(&mt('Associate columns with student attributes.')."\n".
                   4828: 	     '<table border="2"><tr>'.
                   4829:               '<th>'.&mt('Attribute').'</th>'.
                   4830:               '<th>'.&mt('Column').'</th></tr>'."\n");
1.356     albertel 4831:     foreach my $array_ref (@$d) {
                   4832: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.31      albertel 4833: 	$r->print('<tr><td>'.$display.'</td>');
                   4834: 
                   4835: 	$r->print('<td><select name=f'.$i.
1.32      matthew  4836: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 4837: 	$r->print('<option value="none"></option>');
1.356     albertel 4838: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   4839: 	    $r->print('<option value="'.$sample.'"'.
                   4840:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
                   4841:                       '>Column '.($sample+1).'</option>');
1.31      albertel 4842: 	}
                   4843: 	$r->print('</select></td></tr>'."\n");
                   4844: 	$i++;
                   4845:     }
                   4846:     $i--;
                   4847:     return $i;
                   4848: }
1.56      matthew  4849: 
1.144     matthew  4850: ######################################################
                   4851: ######################################################
                   4852: 
1.56      matthew  4853: =pod
1.31      albertel 4854: 
1.112     bowersj2 4855: =item * csv_samples_select_table($r,$records,$d)
1.41      ng       4856: 
                   4857: Prints a table of sample values from the upload and can make associate samples to internal names.
                   4858: 
                   4859: $r is an Apache Request ref,
                   4860: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   4861: $d is an array of 2 element arrays (internal name, displayed name)
                   4862: 
                   4863: =cut
                   4864: 
1.144     matthew  4865: ######################################################
                   4866: ######################################################
1.31      albertel 4867: sub csv_samples_select_table {
                   4868:     my ($r,$records,$d) = @_;
                   4869:     my $i=0;
1.144     matthew  4870:     #
1.301     albertel 4871:     my $samples = &get_samples($records,3);
1.144     matthew  4872:     $r->print('<table border=2><tr><th>'.
                   4873:               &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.301     albertel 4874: 
                   4875:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.144     matthew  4876: 	$r->print('<tr><td><select name="f'.$i.'"'.
1.32      matthew  4877: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 4878: 	foreach my $option (@$d) {
                   4879: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  4880: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 4881:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  4882:                       $display.'</option>');
1.31      albertel 4883: 	}
                   4884: 	$r->print('</select></td><td>');
1.301     albertel 4885: 	foreach my $line (0..2) {
                   4886: 	    if (defined($samples->[$line]{$key})) { 
                   4887: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   4888: 	    }
                   4889: 	}
1.31      albertel 4890: 	$r->print('</td></tr>');
                   4891: 	$i++;
                   4892:     }
                   4893:     $i--;
                   4894:     return($i);
1.115     matthew  4895: }
                   4896: 
1.144     matthew  4897: ######################################################
                   4898: ######################################################
                   4899: 
1.115     matthew  4900: =pod
                   4901: 
                   4902: =item clean_excel_name($name)
                   4903: 
                   4904: Returns a replacement for $name which does not contain any illegal characters.
                   4905: 
                   4906: =cut
                   4907: 
1.144     matthew  4908: ######################################################
                   4909: ######################################################
1.115     matthew  4910: sub clean_excel_name {
                   4911:     my ($name) = @_;
                   4912:     $name =~ s/[:\*\?\/\\]//g;
                   4913:     if (length($name) > 31) {
                   4914:         $name = substr($name,0,31);
                   4915:     }
                   4916:     return $name;
1.25      albertel 4917: }
1.84      albertel 4918: 
1.85      albertel 4919: =pod
                   4920: 
1.112     bowersj2 4921: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 4922: 
                   4923: Returns either 1 or undef
                   4924: 
                   4925: 1 if the part is to be hidden, undef if it is to be shown
                   4926: 
                   4927: Arguments are:
                   4928: 
                   4929: $id the id of the part to be checked
                   4930: $symb, optional the symb of the resource to check
                   4931: $udom, optional the domain of the user to check for
                   4932: $uname, optional the username of the user to check for
                   4933: 
                   4934: =cut
1.84      albertel 4935: 
                   4936: sub check_if_partid_hidden {
                   4937:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 4938:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 4939: 					 $symb,$udom,$uname);
1.141     albertel 4940:     my $truth=1;
                   4941:     #if the string starts with !, then the list is the list to show not hide
                   4942:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 4943:     my @hiddenlist=split(/,/,$hiddenparts);
                   4944:     foreach my $checkid (@hiddenlist) {
1.141     albertel 4945: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 4946:     }
1.141     albertel 4947:     return !$truth;
1.84      albertel 4948: }
1.127     matthew  4949: 
1.138     matthew  4950: 
                   4951: ############################################################
                   4952: ############################################################
                   4953: 
                   4954: =pod
                   4955: 
1.157     matthew  4956: =back 
                   4957: 
1.138     matthew  4958: =head1 cgi-bin script and graphing routines
                   4959: 
1.157     matthew  4960: =over 4
                   4961: 
1.138     matthew  4962: =item get_cgi_id
                   4963: 
                   4964: Inputs: none
                   4965: 
                   4966: Returns an id which can be used to pass environment variables
                   4967: to various cgi-bin scripts.  These environment variables will
                   4968: be removed from the users environment after a given time by
                   4969: the routine &Apache::lonnet::transfer_profile_to_env.
                   4970: 
                   4971: =cut
                   4972: 
                   4973: ############################################################
                   4974: ############################################################
1.152     albertel 4975: my $uniq=0;
1.136     matthew  4976: sub get_cgi_id {
1.154     albertel 4977:     $uniq=($uniq+1)%100000;
1.280     albertel 4978:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  4979: }
                   4980: 
1.127     matthew  4981: ############################################################
                   4982: ############################################################
                   4983: 
                   4984: =pod
                   4985: 
1.134     matthew  4986: =item DrawBarGraph
1.127     matthew  4987: 
1.138     matthew  4988: Facilitates the plotting of data in a (stacked) bar graph.
                   4989: Puts plot definition data into the users environment in order for 
                   4990: graph.png to plot it.  Returns an <img> tag for the plot.
                   4991: The bars on the plot are labeled '1','2',...,'n'.
                   4992: 
                   4993: Inputs:
                   4994: 
                   4995: =over 4
                   4996: 
                   4997: =item $Title: string, the title of the plot
                   4998: 
                   4999: =item $xlabel: string, text describing the X-axis of the plot
                   5000: 
                   5001: =item $ylabel: string, text describing the Y-axis of the plot
                   5002: 
                   5003: =item $Max: scalar, the maximum Y value to use in the plot
                   5004: If $Max is < any data point, the graph will not be rendered.
                   5005: 
1.140     matthew  5006: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  5007: they are plotted.  If undefined, default values will be used.
                   5008: 
1.178     matthew  5009: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   5010: 
1.138     matthew  5011: =item @Values: An array of array references.  Each array reference holds data
                   5012: to be plotted in a stacked bar chart.
                   5013: 
1.239     matthew  5014: =item If the final element of @Values is a hash reference the key/value
                   5015: pairs will be added to the graph definition.
                   5016: 
1.138     matthew  5017: =back
                   5018: 
                   5019: Returns:
                   5020: 
                   5021: An <img> tag which references graph.png and the appropriate identifying
                   5022: information for the plot.
                   5023: 
1.127     matthew  5024: =cut
                   5025: 
                   5026: ############################################################
                   5027: ############################################################
1.134     matthew  5028: sub DrawBarGraph {
1.178     matthew  5029:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  5030:     #
                   5031:     if (! defined($colors)) {
                   5032:         $colors = ['#33ff00', 
                   5033:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   5034:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   5035:                   ]; 
                   5036:     }
1.228     matthew  5037:     my $extra_settings = {};
                   5038:     if (ref($Values[-1]) eq 'HASH') {
                   5039:         $extra_settings = pop(@Values);
                   5040:     }
1.127     matthew  5041:     #
1.136     matthew  5042:     my $identifier = &get_cgi_id();
                   5043:     my $id = 'cgi.'.$identifier;        
1.129     matthew  5044:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  5045:         return '';
                   5046:     }
1.225     matthew  5047:     #
                   5048:     my @Labels;
                   5049:     if (defined($labels)) {
                   5050:         @Labels = @$labels;
                   5051:     } else {
                   5052:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   5053:             push (@Labels,$i+1);
                   5054:         }
                   5055:     }
                   5056:     #
1.129     matthew  5057:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  5058:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  5059:     my %ValuesHash;
                   5060:     my $NumSets=1;
                   5061:     foreach my $array (@Values) {
                   5062:         next if (! ref($array));
1.136     matthew  5063:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  5064:             join(',',@$array);
1.129     matthew  5065:     }
1.127     matthew  5066:     #
1.136     matthew  5067:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  5068:     if ($NumBars < 3) {
                   5069:         $width = 120+$NumBars*32;
1.220     matthew  5070:         $xskip = 1;
1.225     matthew  5071:         $bar_width = 30;
                   5072:     } elsif ($NumBars < 5) {
                   5073:         $width = 120+$NumBars*20;
                   5074:         $xskip = 1;
                   5075:         $bar_width = 20;
1.220     matthew  5076:     } elsif ($NumBars < 10) {
1.136     matthew  5077:         $width = 120+$NumBars*15;
                   5078:         $xskip = 1;
                   5079:         $bar_width = 15;
                   5080:     } elsif ($NumBars <= 25) {
                   5081:         $width = 120+$NumBars*11;
                   5082:         $xskip = 5;
                   5083:         $bar_width = 8;
                   5084:     } elsif ($NumBars <= 50) {
                   5085:         $width = 120+$NumBars*8;
                   5086:         $xskip = 5;
                   5087:         $bar_width = 4;
                   5088:     } else {
                   5089:         $width = 120+$NumBars*8;
                   5090:         $xskip = 5;
                   5091:         $bar_width = 4;
                   5092:     }
                   5093:     #
1.137     matthew  5094:     $Max = 1 if ($Max < 1);
                   5095:     if ( int($Max) < $Max ) {
                   5096:         $Max++;
                   5097:         $Max = int($Max);
                   5098:     }
1.127     matthew  5099:     $Title  = '' if (! defined($Title));
                   5100:     $xlabel = '' if (! defined($xlabel));
                   5101:     $ylabel = '' if (! defined($ylabel));
1.369     www      5102:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   5103:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   5104:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  5105:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  5106:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   5107:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   5108:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   5109:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   5110:     $ValuesHash{$id.'.height'}   = $height;
                   5111:     $ValuesHash{$id.'.width'}    = $width;
                   5112:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   5113:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   5114:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  5115:     #
1.228     matthew  5116:     # Deal with other parameters
                   5117:     while (my ($key,$value) = each(%$extra_settings)) {
                   5118:         $ValuesHash{$id.'.'.$key} = $value;
                   5119:     }
                   5120:     #
1.137     matthew  5121:     &Apache::lonnet::appenv(%ValuesHash);
                   5122:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   5123: }
                   5124: 
                   5125: ############################################################
                   5126: ############################################################
                   5127: 
                   5128: =pod
                   5129: 
                   5130: =item DrawXYGraph
                   5131: 
1.138     matthew  5132: Facilitates the plotting of data in an XY graph.
                   5133: Puts plot definition data into the users environment in order for 
                   5134: graph.png to plot it.  Returns an <img> tag for the plot.
                   5135: 
                   5136: Inputs:
                   5137: 
                   5138: =over 4
                   5139: 
                   5140: =item $Title: string, the title of the plot
                   5141: 
                   5142: =item $xlabel: string, text describing the X-axis of the plot
                   5143: 
                   5144: =item $ylabel: string, text describing the Y-axis of the plot
                   5145: 
                   5146: =item $Max: scalar, the maximum Y value to use in the plot
                   5147: If $Max is < any data point, the graph will not be rendered.
                   5148: 
                   5149: =item $colors: Array ref containing the hex color codes for the data to be 
                   5150: plotted in.  If undefined, default values will be used.
                   5151: 
                   5152: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   5153: 
                   5154: =item $Ydata: Array ref containing Array refs.  
1.185     www      5155: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  5156: 
                   5157: =item %Values: hash indicating or overriding any default values which are 
                   5158: passed to graph.png.  
                   5159: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   5160: 
                   5161: =back
                   5162: 
                   5163: Returns:
                   5164: 
                   5165: An <img> tag which references graph.png and the appropriate identifying
                   5166: information for the plot.
                   5167: 
1.137     matthew  5168: =cut
                   5169: 
                   5170: ############################################################
                   5171: ############################################################
                   5172: sub DrawXYGraph {
                   5173:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   5174:     #
                   5175:     # Create the identifier for the graph
                   5176:     my $identifier = &get_cgi_id();
                   5177:     my $id = 'cgi.'.$identifier;
                   5178:     #
                   5179:     $Title  = '' if (! defined($Title));
                   5180:     $xlabel = '' if (! defined($xlabel));
                   5181:     $ylabel = '' if (! defined($ylabel));
                   5182:     my %ValuesHash = 
                   5183:         (
1.369     www      5184:          $id.'.title'  => &escape($Title),
                   5185:          $id.'.xlabel' => &escape($xlabel),
                   5186:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  5187:          $id.'.y_max_value'=> $Max,
                   5188:          $id.'.labels'     => join(',',@$Xlabels),
                   5189:          $id.'.PlotType'   => 'XY',
                   5190:          );
                   5191:     #
                   5192:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   5193:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   5194:     }
                   5195:     #
                   5196:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   5197:         return '';
                   5198:     }
                   5199:     my $NumSets=1;
1.138     matthew  5200:     foreach my $array (@{$Ydata}){
1.137     matthew  5201:         next if (! ref($array));
                   5202:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   5203:     }
1.138     matthew  5204:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  5205:     #
                   5206:     # Deal with other parameters
                   5207:     while (my ($key,$value) = each(%Values)) {
                   5208:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  5209:     }
                   5210:     #
1.136     matthew  5211:     &Apache::lonnet::appenv(%ValuesHash);
                   5212:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   5213: }
                   5214: 
                   5215: ############################################################
                   5216: ############################################################
                   5217: 
                   5218: =pod
                   5219: 
1.138     matthew  5220: =item DrawXYYGraph
                   5221: 
                   5222: Facilitates the plotting of data in an XY graph with two Y axes.
                   5223: Puts plot definition data into the users environment in order for 
                   5224: graph.png to plot it.  Returns an <img> tag for the plot.
                   5225: 
                   5226: Inputs:
                   5227: 
                   5228: =over 4
                   5229: 
                   5230: =item $Title: string, the title of the plot
                   5231: 
                   5232: =item $xlabel: string, text describing the X-axis of the plot
                   5233: 
                   5234: =item $ylabel: string, text describing the Y-axis of the plot
                   5235: 
                   5236: =item $colors: Array ref containing the hex color codes for the data to be 
                   5237: plotted in.  If undefined, default values will be used.
                   5238: 
                   5239: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   5240: 
                   5241: =item $Ydata1: The first data set
                   5242: 
                   5243: =item $Min1: The minimum value of the left Y-axis
                   5244: 
                   5245: =item $Max1: The maximum value of the left Y-axis
                   5246: 
                   5247: =item $Ydata2: The second data set
                   5248: 
                   5249: =item $Min2: The minimum value of the right Y-axis
                   5250: 
                   5251: =item $Max2: The maximum value of the left Y-axis
                   5252: 
                   5253: =item %Values: hash indicating or overriding any default values which are 
                   5254: passed to graph.png.  
                   5255: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   5256: 
                   5257: =back
                   5258: 
                   5259: Returns:
                   5260: 
                   5261: An <img> tag which references graph.png and the appropriate identifying
                   5262: information for the plot.
1.136     matthew  5263: 
                   5264: =cut
                   5265: 
                   5266: ############################################################
                   5267: ############################################################
1.137     matthew  5268: sub DrawXYYGraph {
                   5269:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   5270:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  5271:     #
                   5272:     # Create the identifier for the graph
                   5273:     my $identifier = &get_cgi_id();
                   5274:     my $id = 'cgi.'.$identifier;
                   5275:     #
                   5276:     $Title  = '' if (! defined($Title));
                   5277:     $xlabel = '' if (! defined($xlabel));
                   5278:     $ylabel = '' if (! defined($ylabel));
                   5279:     my %ValuesHash = 
                   5280:         (
1.369     www      5281:          $id.'.title'  => &escape($Title),
                   5282:          $id.'.xlabel' => &escape($xlabel),
                   5283:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  5284:          $id.'.labels' => join(',',@$Xlabels),
                   5285:          $id.'.PlotType' => 'XY',
                   5286:          $id.'.NumSets' => 2,
1.137     matthew  5287:          $id.'.two_axes' => 1,
                   5288:          $id.'.y1_max_value' => $Max1,
                   5289:          $id.'.y1_min_value' => $Min1,
                   5290:          $id.'.y2_max_value' => $Max2,
                   5291:          $id.'.y2_min_value' => $Min2,
1.136     matthew  5292:          );
                   5293:     #
1.137     matthew  5294:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   5295:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   5296:     }
                   5297:     #
                   5298:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   5299:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  5300:         return '';
                   5301:     }
                   5302:     my $NumSets=1;
1.137     matthew  5303:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  5304:         next if (! ref($array));
                   5305:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  5306:     }
                   5307:     #
                   5308:     # Deal with other parameters
                   5309:     while (my ($key,$value) = each(%Values)) {
                   5310:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  5311:     }
                   5312:     #
                   5313:     &Apache::lonnet::appenv(%ValuesHash);
1.130     albertel 5314:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  5315: }
                   5316: 
                   5317: ############################################################
                   5318: ############################################################
                   5319: 
                   5320: =pod
                   5321: 
1.157     matthew  5322: =back 
                   5323: 
1.139     matthew  5324: =head1 Statistics helper routines?  
                   5325: 
                   5326: Bad place for them but what the hell.
                   5327: 
1.157     matthew  5328: =over 4
                   5329: 
1.139     matthew  5330: =item &chartlink
                   5331: 
                   5332: Returns a link to the chart for a specific student.  
                   5333: 
                   5334: Inputs:
                   5335: 
                   5336: =over 4
                   5337: 
                   5338: =item $linktext: The text of the link
                   5339: 
                   5340: =item $sname: The students username
                   5341: 
                   5342: =item $sdomain: The students domain
                   5343: 
                   5344: =back
                   5345: 
1.157     matthew  5346: =back
                   5347: 
1.139     matthew  5348: =cut
                   5349: 
                   5350: ############################################################
                   5351: ############################################################
                   5352: sub chartlink {
                   5353:     my ($linktext, $sname, $sdomain) = @_;
                   5354:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      5355:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 5356:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  5357:        '">'.$linktext.'</a>';
1.153     matthew  5358: }
                   5359: 
                   5360: #######################################################
                   5361: #######################################################
                   5362: 
                   5363: =pod
                   5364: 
                   5365: =head1 Course Environment Routines
1.157     matthew  5366: 
                   5367: =over 4
1.153     matthew  5368: 
                   5369: =item &restore_course_settings 
                   5370: 
                   5371: =item &store_course_settings
                   5372: 
                   5373: Restores/Store indicated form parameters from the course environment.
                   5374: Will not overwrite existing values of the form parameters.
                   5375: 
                   5376: Inputs: 
                   5377: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   5378: 
                   5379: a hash ref describing the data to be stored.  For example:
                   5380:    
                   5381: %Save_Parameters = ('Status' => 'scalar',
                   5382:     'chartoutputmode' => 'scalar',
                   5383:     'chartoutputdata' => 'scalar',
                   5384:     'Section' => 'array',
1.373     raeburn  5385:     'Group' => 'array',
1.153     matthew  5386:     'StudentData' => 'array',
                   5387:     'Maps' => 'array');
                   5388: 
                   5389: Returns: both routines return nothing
                   5390: 
                   5391: =cut
                   5392: 
                   5393: #######################################################
                   5394: #######################################################
                   5395: sub store_course_settings {
                   5396:     # save to the environment
                   5397:     # appenv the same items, just to be safe
1.258     albertel 5398:     my $courseid = $env{'request.course.id'};
1.300     albertel 5399:     my $udom  = $env{'user.domain'};
                   5400:     my $uname = $env{'user.name'};
1.153     matthew  5401:     my ($prefix,$Settings) = @_;
                   5402:     my %SaveHash;
                   5403:     my %AppHash;
                   5404:     while (my ($setting,$type) = each(%$Settings)) {
1.300     albertel 5405:         my $basename = join('.','internal',$courseid,$prefix,$setting);
                   5406:         my $envname = 'environment.'.$basename;
1.258     albertel 5407:         if (exists($env{'form.'.$setting})) {
1.153     matthew  5408:             # Save this value away
                   5409:             if ($type eq 'scalar' &&
1.258     albertel 5410:                 (! exists($env{$envname}) || 
                   5411:                  $env{$envname} ne $env{'form.'.$setting})) {
                   5412:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   5413:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  5414:             } elsif ($type eq 'array') {
                   5415:                 my $stored_form;
1.258     albertel 5416:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  5417:                     $stored_form = join(',',
                   5418:                                         map {
1.369     www      5419:                                             &escape($_);
1.258     albertel 5420:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  5421:                 } else {
                   5422:                     $stored_form = 
1.369     www      5423:                         &escape($env{'form.'.$setting});
1.153     matthew  5424:                 }
                   5425:                 # Determine if the array contents are the same.
1.258     albertel 5426:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  5427:                     $SaveHash{$basename} = $stored_form;
                   5428:                     $AppHash{$envname}   = $stored_form;
                   5429:                 }
                   5430:             }
                   5431:         }
                   5432:     }
                   5433:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 5434:                                           $udom,$uname);
1.153     matthew  5435:     if ($put_result !~ /^(ok|delayed)/) {
                   5436:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   5437:                                  'got error:'.$put_result);
                   5438:     }
                   5439:     # Make sure these settings stick around in this session, too
                   5440:     &Apache::lonnet::appenv(%AppHash);
                   5441:     return;
                   5442: }
                   5443: 
                   5444: sub restore_course_settings {
1.258     albertel 5445:     my $courseid = $env{'request.course.id'};
1.153     matthew  5446:     my ($prefix,$Settings) = @_;
                   5447:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 5448:         next if (exists($env{'form.'.$setting}));
1.300     albertel 5449:         my $envname = 'environment.internal.'.$courseid.'.'.$prefix.
1.153     matthew  5450:             '.'.$setting;
1.258     albertel 5451:         if (exists($env{$envname})) {
1.153     matthew  5452:             if ($type eq 'scalar') {
1.258     albertel 5453:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  5454:             } elsif ($type eq 'array') {
1.258     albertel 5455:                 $env{'form.'.$setting} = [ 
1.153     matthew  5456:                                            map { 
1.369     www      5457:                                                &unescape($_); 
1.258     albertel 5458:                                            } split(',',$env{$envname})
1.153     matthew  5459:                                            ];
                   5460:             }
                   5461:         }
                   5462:     }
1.127     matthew  5463: }
                   5464: 
                   5465: ############################################################
                   5466: ############################################################
1.154     albertel 5467: 
1.378     raeburn  5468: sub course_type {
                   5469:     my ($cid) = @_;
                   5470:     if (!defined($cid)) {
                   5471:         $cid = $env{'request.course.id'};
                   5472:     }
1.404     albertel 5473:     if (defined($env{'course.'.$cid.'.type'})) {
                   5474:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  5475:     } else {
                   5476:         return 'Course';
1.377     raeburn  5477:     }
                   5478: }
1.156     albertel 5479: 
1.406     raeburn  5480: sub group_term {
                   5481:     my $crstype = &course_type();
                   5482:     my %names = (
                   5483:                   'Course' => 'group',
                   5484:                   'Group' => 'team',
                   5485:                 );
                   5486:     return $names{$crstype};
                   5487: }
                   5488: 
1.156     albertel 5489: sub icon {
                   5490:     my ($file)=@_;
1.168     albertel 5491:     my $curfext = (split(/\./,$file))[-1];
                   5492:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 5493:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 5494:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   5495: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   5496: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   5497: 	            $curfext.".gif") {
                   5498: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   5499: 		$curfext.".gif";
                   5500: 	}
                   5501:     }
1.249     albertel 5502:     return &lonhttpdurl($iconname);
1.154     albertel 5503: } 
1.84      albertel 5504: 
1.215     albertel 5505: sub lonhttpdurl {
                   5506:     my ($url)=@_;
                   5507:     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   5508:     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
                   5509:     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
                   5510: }
                   5511: 
1.213     albertel 5512: sub connection_aborted {
                   5513:     my ($r)=@_;
                   5514:     $r->print(" ");$r->rflush();
                   5515:     my $c = $r->connection;
                   5516:     return $c->aborted();
                   5517: }
                   5518: 
1.221     foxr     5519: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     5520: #    strings as 'strings'.
                   5521: sub escape_single {
1.221     foxr     5522:     my ($input) = @_;
1.223     albertel 5523:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     5524:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   5525:     return $input;
                   5526: }
1.223     albertel 5527: 
1.222     foxr     5528: #  Same as escape_single, but escape's "'s  This 
                   5529: #  can be used for  "strings"
                   5530: sub escape_double {
                   5531:     my ($input) = @_;
                   5532:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   5533:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   5534:     return $input;
                   5535: }
1.223     albertel 5536:  
1.222     foxr     5537: #   Escapes the last element of a full URL.
                   5538: sub escape_url {
                   5539:     my ($url)   = @_;
1.238     raeburn  5540:     my @urlslices = split(/\//, $url,-1);
1.369     www      5541:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 5542:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     5543: }
1.41      ng       5544: =pod
                   5545: 
                   5546: =back
                   5547: 
1.112     bowersj2 5548: =cut
1.41      ng       5549: 
1.112     bowersj2 5550: 1;
                   5551: __END__;
1.41      ng       5552: 

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