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

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

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