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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.683   ! bisitz      4: # $Id: loncommon.pm,v 1.682 2008/09/08 19:39:26 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.139     matthew    64: use HTML::Entities;
1.334     albertel   65: use Apache::lonhtmlcommon();
                     66: use Apache::loncoursedata();
1.344     albertel   67: use Apache::lontexconvert();
1.444     albertel   68: use Apache::lonclonecourse();
1.479     albertel   69: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    70: use DateTime::TimeZone;
1.117     www        71: 
1.517     raeburn    72: # ---------------------------------------------- Designs
                     73: use vars qw(%defaultdesign);
                     74: 
1.22      www        75: my $readit;
                     76: 
1.517     raeburn    77: 
1.157     matthew    78: ##
                     79: ## Global Variables
                     80: ##
1.46      matthew    81: 
1.643     foxr       82: 
                     83: # ----------------------------------------------- SSI with retries:
                     84: #
                     85: 
                     86: =pod
                     87: 
1.648     raeburn    88: =head1 Server Side include with retries:
1.643     foxr       89: 
                     90: =over 4
                     91: 
1.648     raeburn    92: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       93: 
                     94: Performs an ssi with some number of retries.  Retries continue either
                     95: until the result is ok or until the retry count supplied by the
                     96: caller is exhausted.  
                     97: 
                     98: Inputs:
1.648     raeburn    99: 
                    100: =over 4
                    101: 
1.643     foxr      102: resource   - Identifies the resource to insert.
1.648     raeburn   103: 
1.643     foxr      104: retries    - Count of the number of retries allowed.
1.648     raeburn   105: 
1.643     foxr      106: form       - Hash that identifies the rendering options.
                    107: 
1.648     raeburn   108: =back
                    109: 
                    110: Returns:
                    111: 
                    112: =over 4
                    113: 
1.643     foxr      114: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   115: 
1.643     foxr      116: response   - The response from the last attempt (which may or may not have been successful.
                    117: 
1.648     raeburn   118: =back
                    119: 
                    120: =back
                    121: 
1.643     foxr      122: =cut
                    123: 
                    124: sub ssi_with_retries {
                    125:     my ($resource, $retries, %form) = @_;
                    126: 
                    127: 
                    128:     my $ok = 0;			# True if we got a good response.
                    129:     my $content;
                    130:     my $response;
                    131: 
                    132:     # Try to get the ssi done. within the retries count:
                    133: 
                    134:     do {
                    135: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    136: 	$ok      = $response->is_success;
1.650     www       137:         if (!$ok) {
                    138:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    139:         }
1.643     foxr      140: 	$retries--;
                    141:     } while (!$ok && ($retries > 0));
                    142: 
                    143:     if (!$ok) {
                    144: 	$content = '';		# On error return an empty content.
                    145:     }
                    146:     return ($content, $response);
                    147: 
                    148: }
                    149: 
                    150: 
                    151: 
1.20      www       152: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  153: my %language;
1.124     www       154: my %supported_language;
1.12      harris41  155: my %cprtag;
1.192     taceyjo1  156: my %scprtag;
1.351     www       157: my %fe; my %fd; my %fm;
1.41      ng        158: my %category_extensions;
1.12      harris41  159: 
1.46      matthew   160: # ---------------------------------------------- Thesaurus variables
1.144     matthew   161: #
                    162: # %Keywords:
                    163: #      A hash used by &keyword to determine if a word is considered a keyword.
                    164: # $thesaurus_db_file 
                    165: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   166: 
                    167: my %Keywords;
                    168: my $thesaurus_db_file;
                    169: 
1.144     matthew   170: #
                    171: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    172: # thesaurus.tab, and filecategories.tab.
                    173: #
1.18      www       174: BEGIN {
1.46      matthew   175:     # Variable initialization
                    176:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    177:     #
1.22      www       178:     unless ($readit) {
1.12      harris41  179: # ------------------------------------------------------------------- languages
                    180:     {
1.158     raeburn   181:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    182:                                    '/language.tab';
                    183:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  184:             while (my $line = <$fh>) {
                    185:                 next if ($line=~/^\#/);
                    186:                 chomp($line);
                    187:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   188:                 $language{$key}=$val.' - '.$enc;
                    189:                 if ($sup) {
                    190:                     $supported_language{$key}=$sup;
                    191:                 }
                    192:             }
                    193:             close($fh);
                    194:         }
1.12      harris41  195:     }
                    196: # ------------------------------------------------------------------ copyrights
                    197:     {
1.158     raeburn   198:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    199:                                   '/copyright.tab';
                    200:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  201:             while (my $line = <$fh>) {
                    202:                 next if ($line=~/^\#/);
                    203:                 chomp($line);
                    204:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   205:                 $cprtag{$key}=$val;
                    206:             }
                    207:             close($fh);
                    208:         }
1.12      harris41  209:     }
1.351     www       210: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  211:     {
                    212:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    213:                                   '/source_copyright.tab';
                    214:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  215:             while (my $line = <$fh>) {
                    216:                 next if ($line =~ /^\#/);
                    217:                 chomp($line);
                    218:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  219:                 $scprtag{$key}=$val;
                    220:             }
                    221:             close($fh);
                    222:         }
                    223:     }
1.63      www       224: 
1.517     raeburn   225: # -------------------------------------------------------------- default domain designs
1.63      www       226:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   227:     my $designfile = $designdir.'/default.tab';
                    228:     if ( open (my $fh,"<$designfile") ) {
                    229:         while (my $line = <$fh>) {
                    230:             next if ($line =~ /^\#/);
                    231:             chomp($line);
                    232:             my ($key,$val)=(split(/\=/,$line));
                    233:             if ($val) { $defaultdesign{$key}=$val; }
                    234:         }
                    235:         close($fh);
1.63      www       236:     }
                    237: 
1.15      harris41  238: # ------------------------------------------------------------- file categories
                    239:     {
1.158     raeburn   240:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    241:                                   '/filecategories.tab';
                    242:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  243: 	    while (my $line = <$fh>) {
                    244: 		next if ($line =~ /^\#/);
                    245: 		chomp($line);
                    246:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   247:                 push @{$category_extensions{lc($category)}},$extension;
                    248:             }
                    249:             close($fh);
                    250:         }
                    251: 
1.15      harris41  252:     }
1.12      harris41  253: # ------------------------------------------------------------------ file types
                    254:     {
1.158     raeburn   255:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    256:                '/filetypes.tab';
                    257:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  258:             while (my $line = <$fh>) {
                    259: 		next if ($line =~ /^\#/);
                    260: 		chomp($line);
                    261:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   262:                 if ($descr ne '') {
                    263:                     $fe{$ending}=lc($emb);
                    264:                     $fd{$ending}=$descr;
1.351     www       265:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   266:                 }
                    267:             }
                    268:             close($fh);
                    269:         }
1.12      harris41  270:     }
1.22      www       271:     &Apache::lonnet::logthis(
1.46      matthew   272:               "<font color=yellow>INFO: Read file types</font>");
1.22      www       273:     $readit=1;
1.46      matthew   274:     }  # end of unless($readit) 
1.32      matthew   275:     
                    276: }
1.112     bowersj2  277: 
1.42      matthew   278: ###############################################################
                    279: ##           HTML and Javascript Helper Functions            ##
                    280: ###############################################################
                    281: 
                    282: =pod 
                    283: 
1.112     bowersj2  284: =head1 HTML and Javascript Functions
1.42      matthew   285: 
1.112     bowersj2  286: =over 4
                    287: 
1.648     raeburn   288: =item * &browser_and_searcher_javascript()
1.112     bowersj2  289: 
                    290: X<browsing, javascript>X<searching, javascript>Returns a string
                    291: containing javascript with two functions, C<openbrowser> and
                    292: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    293: tags.
1.42      matthew   294: 
1.648     raeburn   295: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   296: 
                    297: inputs: formname, elementname, only, omit
                    298: 
                    299: formname and elementname indicate the name of the html form and name of
                    300: the element that the results of the browsing selection are to be placed in. 
                    301: 
                    302: Specifying 'only' will restrict the browser to displaying only files
1.185     www       303: with the given extension.  Can be a comma separated list.
1.42      matthew   304: 
                    305: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       306: with the given extension.  Can be a comma separated list.
1.42      matthew   307: 
1.648     raeburn   308: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   309: 
                    310: Inputs: formname, elementname
                    311: 
                    312: formname and elementname specify the name of the html form and the name
                    313: of the element the selection from the search results will be placed in.
1.542     raeburn   314: 
1.42      matthew   315: =cut
                    316: 
                    317: sub browser_and_searcher_javascript {
1.199     albertel  318:     my ($mode)=@_;
                    319:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  320:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   321:     return <<END;
1.219     albertel  322: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   323:     var editbrowser = null;
1.135     albertel  324:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       325:         var url = '$resurl/?';
1.42      matthew   326:         if (editbrowser == null) {
                    327:             url += 'launch=1&';
                    328:         }
                    329:         url += 'catalogmode=interactive&';
1.199     albertel  330:         url += 'mode=$mode&';
1.611     albertel  331:         url += 'inhibitmenu=yes&';
1.42      matthew   332:         url += 'form=' + formname + '&';
                    333:         if (only != null) {
                    334:             url += 'only=' + only + '&';
1.217     albertel  335:         } else {
                    336:             url += 'only=&';
                    337: 	}
1.42      matthew   338:         if (omit != null) {
                    339:             url += 'omit=' + omit + '&';
1.217     albertel  340:         } else {
                    341:             url += 'omit=&';
                    342: 	}
1.135     albertel  343:         if (titleelement != null) {
                    344:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  345:         } else {
                    346: 	    url += 'titleelement=&';
                    347: 	}
1.42      matthew   348:         url += 'element=' + elementname + '';
                    349:         var title = 'Browser';
1.435     albertel  350:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   351:         options += ',width=700,height=600';
                    352:         editbrowser = open(url,title,options,'1');
                    353:         editbrowser.focus();
                    354:     }
                    355:     var editsearcher;
1.135     albertel  356:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   357:         var url = '/adm/searchcat?';
                    358:         if (editsearcher == null) {
                    359:             url += 'launch=1&';
                    360:         }
                    361:         url += 'catalogmode=interactive&';
1.199     albertel  362:         url += 'mode=$mode&';
1.42      matthew   363:         url += 'form=' + formname + '&';
1.135     albertel  364:         if (titleelement != null) {
                    365:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  366:         } else {
                    367: 	    url += 'titleelement=&';
                    368: 	}
1.42      matthew   369:         url += 'element=' + elementname + '';
                    370:         var title = 'Search';
1.435     albertel  371:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   372:         options += ',width=700,height=600';
                    373:         editsearcher = open(url,title,options,'1');
                    374:         editsearcher.focus();
                    375:     }
1.219     albertel  376: // END LON-CAPA Internal -->
1.42      matthew   377: END
1.170     www       378: }
                    379: 
                    380: sub lastresurl {
1.258     albertel  381:     if ($env{'environment.lastresurl'}) {
                    382: 	return $env{'environment.lastresurl'}
1.170     www       383:     } else {
                    384: 	return '/res';
                    385:     }
                    386: }
                    387: 
                    388: sub storeresurl {
                    389:     my $resurl=&Apache::lonnet::clutter(shift);
                    390:     unless ($resurl=~/^\/res/) { return 0; }
                    391:     $resurl=~s/\/$//;
                    392:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   393:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       394:     return 1;
1.42      matthew   395: }
                    396: 
1.74      www       397: sub studentbrowser_javascript {
1.111     www       398:    unless (
1.258     albertel  399:             (($env{'request.course.id'}) && 
1.302     albertel  400:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    401: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    402: 					  '/'.$env{'request.course.sec'})
                    403: 	      ))
1.258     albertel  404:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       405:           ) { return ''; }  
1.74      www       406:    return (<<'ENDSTDBRW');
                    407: <script type="text/javascript" language="Javascript" >
                    408:     var stdeditbrowser;
1.558     albertel  409:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74      www       410:         var url = '/adm/pickstudent?';
                    411:         var filter;
1.558     albertel  412: 	if (!ignorefilter) {
                    413: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    414: 	}
1.74      www       415:         if (filter != null) {
                    416:            if (filter != '') {
                    417:                url += 'filter='+filter+'&';
                    418: 	   }
                    419:         }
                    420:         url += 'form=' + formname + '&unameelement='+uname+
                    421:                                     '&udomelement='+udom;
1.111     www       422: 	if (roleflag) { url+="&roles=1"; }
1.102     www       423:         var title = 'Student_Browser';
1.74      www       424:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    425:         options += ',width=700,height=600';
                    426:         stdeditbrowser = open(url,title,options,'1');
                    427:         stdeditbrowser.focus();
                    428:     }
                    429: </script>
                    430: ENDSTDBRW
                    431: }
1.42      matthew   432: 
1.74      www       433: sub selectstudent_link {
1.111     www       434:    my ($form,$unameele,$udomele)=@_;
1.258     albertel  435:    if ($env{'request.course.id'}) {  
1.302     albertel  436:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    437: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    438: 					'/'.$env{'request.course.sec'})) {
1.111     www       439: 	   return '';
                    440:        }
                    441:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607     albertel  442:         '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74      www       443:    }
1.258     albertel  444:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111     www       445:        return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119     www       446:         '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111     www       447:    }
                    448:    return '';
1.91      www       449: }
                    450: 
1.653     raeburn   451: sub authorbrowser_javascript {
                    452:     return <<"ENDAUTHORBRW";
                    453: <script type="text/javascript">
                    454: var stdeditbrowser;
                    455: 
                    456: function openauthorbrowser(formname,udom) {
                    457:     var url = '/adm/pickauthor?';
                    458:     url += 'form='+formname+'&roledom='+udom;
                    459:     var title = 'Author_Browser';
                    460:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    461:     options += ',width=700,height=600';
                    462:     stdeditbrowser = open(url,title,options,'1');
                    463:     stdeditbrowser.focus();
                    464: }
                    465: 
                    466: </script>
                    467: ENDAUTHORBRW
                    468: }
                    469: 
1.91      www       470: sub coursebrowser_javascript {
1.468     raeburn   471:     my ($domainfilter,$sec_element,$formname)=@_;
1.377     raeburn   472:     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   473:    my $output = '
1.538     albertel  474: <script type="text/javascript">
1.468     raeburn   475:     var stdeditbrowser;'."\n";
                    476:    $output .= <<"ENDSTDBRW";
1.377     raeburn   477:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       478:         var url = '/adm/pickcourse?';
1.468     raeburn   479:         var domainfilter = '';
                    480:         var formid = getFormIdByName(formname);
                    481:         if (formid > -1) {
                    482:             var domid = getIndexByName(formid,udom);
                    483:             if (domid > -1) {
                    484:                 if (document.forms[formid].elements[domid].type == 'select-one') {
                    485:                     domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    486:                 }
                    487:                 if (document.forms[formid].elements[domid].type == 'hidden') {
                    488:                     domainfilter=document.forms[formid].elements[domid].value;
                    489:                 }
                    490:             }
1.91      www       491:         }
1.128     albertel  492:         if (domainfilter != null) {
                    493:            if (domainfilter != '') {
                    494:                url += 'domainfilter='+domainfilter+'&';
                    495: 	   }
                    496:         }
1.91      www       497:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  498: 	                            '&cdomelement='+udom+
                    499:                                     '&cnameelement='+desc;
1.468     raeburn   500:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   501:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   502:                 url += '&roleelement='+extra_element;
                    503:                 if (domainfilter == null || domainfilter == '') {
                    504:                     url += '&domainfilter='+extra_element;
                    505:                 }
1.234     raeburn   506:             }
1.468     raeburn   507:             else {
                    508:                 if (formname == 'portform') {
                    509:                     url += '&setroles='+extra_element;
                    510:                 }
                    511:             }     
1.230     raeburn   512:         }
1.293     raeburn   513:         if (multflag !=null && multflag != '') {
                    514:             url += '&multiple='+multflag;
                    515:         }
1.377     raeburn   516:         if (crstype == 'Course/Group') {
                    517:             if (formname == 'cu') {
                    518:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    519:                 if (crstype == "") {
                    520:                     alert("$crs_or_grp_alert");
                    521:                     return;
                    522:                 }
                    523:             }
                    524:         }
                    525:         if (crstype !=null && crstype != '') {
                    526:             url += '&type='+crstype;
                    527:         }
1.102     www       528:         var title = 'Course_Browser';
1.91      www       529:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    530:         options += ',width=700,height=600';
                    531:         stdeditbrowser = open(url,title,options,'1');
                    532:         stdeditbrowser.focus();
                    533:     }
1.468     raeburn   534: 
                    535:     function getFormIdByName(formname) {
                    536:         for (var i=0;i<document.forms.length;i++) {
                    537:             if (document.forms[i].name == formname) {
                    538:                 return i;
                    539:             }
                    540:         }
                    541:         return -1; 
                    542:     }
                    543: 
                    544:     function getIndexByName(formid,item) {
                    545:         for (var i=0;i<document.forms[formid].elements.length;i++) {
                    546:             if (document.forms[formid].elements[i].name == item) {
                    547:                 return i;
                    548:             }
                    549:         }
                    550:         return -1;
                    551:     }
1.91      www       552: ENDSTDBRW
1.468     raeburn   553:     if ($sec_element ne '') {
                    554:         $output .= &setsec_javascript($sec_element,$formname);
                    555:     }
                    556:     $output .= '
                    557: </script>';
                    558:     return $output;
                    559: }
                    560: 
                    561: sub setsec_javascript {
                    562:     my ($sec_element,$formname) = @_;
                    563:     my $setsections = qq|
                    564: function setSect(sectionlist) {
1.629     raeburn   565:     var sectionsArray = new Array();
                    566:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    567:         sectionsArray = sectionlist.split(",");
                    568:     }
1.468     raeburn   569:     var numSections = sectionsArray.length;
                    570:     document.$formname.$sec_element.length = 0;
                    571:     if (numSections == 0) {
                    572:         document.$formname.$sec_element.multiple=false;
                    573:         document.$formname.$sec_element.size=1;
                    574:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    575:     } else {
                    576:         if (numSections == 1) {
                    577:             document.$formname.$sec_element.multiple=false;
                    578:             document.$formname.$sec_element.size=1;
                    579:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    580:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    581:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    582:         } else {
                    583:             for (var i=0; i<numSections; i++) {
                    584:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    585:             }
                    586:             document.$formname.$sec_element.multiple=true
                    587:             if (numSections < 3) {
                    588:                 document.$formname.$sec_element.size=numSections;
                    589:             } else {
                    590:                 document.$formname.$sec_element.size=3;
                    591:             }
                    592:             document.$formname.$sec_element.options[0].selected = false
                    593:         }
                    594:     }
1.91      www       595: }
1.468     raeburn   596: |;
                    597:     return $setsections;
                    598: }
                    599: 
1.91      www       600: 
                    601: sub selectcourse_link {
1.377     raeburn   602:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492     albertel  603:    return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
                    604:         '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74      www       605: }
1.42      matthew   606: 
1.653     raeburn   607: sub selectauthor_link {
                    608:    my ($form,$udom)=@_;
                    609:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    610:           &mt('Select Author').'</a>';
                    611: }
                    612: 
1.273     raeburn   613: sub check_uncheck_jscript {
                    614:     my $jscript = <<"ENDSCRT";
                    615: function checkAll(field) {
                    616:     if (field.length > 0) {
                    617:         for (i = 0; i < field.length; i++) {
                    618:             field[i].checked = true ;
                    619:         }
                    620:     } else {
                    621:         field.checked = true
                    622:     }
                    623: }
                    624:  
                    625: function uncheckAll(field) {
                    626:     if (field.length > 0) {
                    627:         for (i = 0; i < field.length; i++) {
                    628:             field[i].checked = false ;
1.543     albertel  629:         }
                    630:     } else {
1.273     raeburn   631:         field.checked = false ;
                    632:     }
                    633: }
                    634: ENDSCRT
                    635:     return $jscript;
                    636: }
                    637: 
1.656     www       638: sub select_timezone {
1.659     raeburn   639:    my ($name,$selected,$onchange,$includeempty)=@_;
                    640:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    641:    if ($includeempty) {
                    642:        $output .= '<option value=""';
                    643:        if (($selected eq '') || ($selected eq 'local')) {
                    644:            $output .= ' selected="selected" ';
                    645:        }
                    646:        $output .= '> </option>';
                    647:    }
1.657     raeburn   648:    my @timezones = DateTime::TimeZone->all_names;
                    649:    foreach my $tzone (@timezones) {
                    650:        $output.= '<option value="'.$tzone.'"';
                    651:        if ($tzone eq $selected) {
                    652:            $output.=' selected="selected"';
                    653:        }
                    654:        $output.=">$tzone</option>\n";
1.656     www       655:    }
                    656:    $output.="</select>";
                    657:    return $output;
                    658: }
1.273     raeburn   659: 
1.42      matthew   660: =pod
1.36      matthew   661: 
1.648     raeburn   662: =item * &linked_select_forms(...)
1.36      matthew   663: 
                    664: linked_select_forms returns a string containing a <script></script> block
                    665: and html for two <select> menus.  The select menus will be linked in that
                    666: changing the value of the first menu will result in new values being placed
                    667: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   668: order unless a defined order is provided.
1.36      matthew   669: 
                    670: linked_select_forms takes the following ordered inputs:
                    671: 
                    672: =over 4
                    673: 
1.112     bowersj2  674: =item * $formname, the name of the <form> tag
1.36      matthew   675: 
1.112     bowersj2  676: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   677: 
1.112     bowersj2  678: =item * $firstdefault, the default value for the first menu
1.36      matthew   679: 
1.112     bowersj2  680: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   681: 
1.112     bowersj2  682: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   683: 
1.112     bowersj2  684: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   685: 
1.609     raeburn   686: =item * $menuorder, the order of values in the first menu
                    687: 
1.41      ng        688: =back 
                    689: 
1.36      matthew   690: Below is an example of such a hash.  Only the 'text', 'default', and 
                    691: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    692: values for the first select menu.  The text that coincides with the 
1.41      ng        693: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   694: and text for the second menu are given in the hash pointed to by 
                    695: $menu{$choice1}->{'select2'}.  
                    696: 
1.112     bowersj2  697:  my %menu = ( A1 => { text =>"Choice A1" ,
                    698:                        default => "B3",
                    699:                        select2 => { 
                    700:                            B1 => "Choice B1",
                    701:                            B2 => "Choice B2",
                    702:                            B3 => "Choice B3",
                    703:                            B4 => "Choice B4"
1.609     raeburn   704:                            },
                    705:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  706:                    },
                    707:                A2 => { text =>"Choice A2" ,
                    708:                        default => "C2",
                    709:                        select2 => { 
                    710:                            C1 => "Choice C1",
                    711:                            C2 => "Choice C2",
                    712:                            C3 => "Choice C3"
1.609     raeburn   713:                            },
                    714:                        order => ['C2','C1','C3'],
1.112     bowersj2  715:                    },
                    716:                A3 => { text =>"Choice A3" ,
                    717:                        default => "D6",
                    718:                        select2 => { 
                    719:                            D1 => "Choice D1",
                    720:                            D2 => "Choice D2",
                    721:                            D3 => "Choice D3",
                    722:                            D4 => "Choice D4",
                    723:                            D5 => "Choice D5",
                    724:                            D6 => "Choice D6",
                    725:                            D7 => "Choice D7"
1.609     raeburn   726:                            },
                    727:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  728:                    }
                    729:                );
1.36      matthew   730: 
                    731: =cut
                    732: 
                    733: sub linked_select_forms {
                    734:     my ($formname,
                    735:         $middletext,
                    736:         $firstdefault,
                    737:         $firstselectname,
                    738:         $secondselectname, 
1.609     raeburn   739:         $hashref,
                    740:         $menuorder,
1.36      matthew   741:         ) = @_;
                    742:     my $second = "document.$formname.$secondselectname";
                    743:     my $first = "document.$formname.$firstselectname";
                    744:     # output the javascript to do the changing
                    745:     my $result = '';
1.219     albertel  746:     $result.="<script type=\"text/javascript\">\n";
1.36      matthew   747:     $result.="var select2data = new Object();\n";
                    748:     $" = '","';
                    749:     my $debug = '';
                    750:     foreach my $s1 (sort(keys(%$hashref))) {
                    751:         $result.="select2data.d_$s1 = new Object();\n";        
                    752:         $result.="select2data.d_$s1.def = new String('".
                    753:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   754:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   755:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   756:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    757:             @s2values = @{$hashref->{$s1}->{'order'}};
                    758:         }
1.36      matthew   759:         $result.="\"@s2values\");\n";
                    760:         $result.="select2data.d_$s1.texts = new Array(";        
                    761:         my @s2texts;
                    762:         foreach my $value (@s2values) {
                    763:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    764:         }
                    765:         $result.="\"@s2texts\");\n";
                    766:     }
                    767:     $"=' ';
                    768:     $result.= <<"END";
                    769: 
                    770: function select1_changed() {
                    771:     // Determine new choice
                    772:     var newvalue = "d_" + $first.value;
                    773:     // update select2
                    774:     var values     = select2data[newvalue].values;
                    775:     var texts      = select2data[newvalue].texts;
                    776:     var select2def = select2data[newvalue].def;
                    777:     var i;
                    778:     // out with the old
                    779:     for (i = 0; i < $second.options.length; i++) {
                    780:         $second.options[i] = null;
                    781:     }
                    782:     // in with the nuclear
                    783:     for (i=0;i<values.length; i++) {
                    784:         $second.options[i] = new Option(values[i]);
1.143     matthew   785:         $second.options[i].value = values[i];
1.36      matthew   786:         $second.options[i].text = texts[i];
                    787:         if (values[i] == select2def) {
                    788:             $second.options[i].selected = true;
                    789:         }
                    790:     }
                    791: }
                    792: </script>
                    793: END
                    794:     # output the initial values for the selection lists
                    795:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   796:     my @order = sort(keys(%{$hashref}));
                    797:     if (ref($menuorder) eq 'ARRAY') {
                    798:         @order = @{$menuorder};
                    799:     }
                    800:     foreach my $value (@order) {
1.36      matthew   801:         $result.="    <option value=\"$value\" ";
1.253     albertel  802:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       803:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   804:     }
                    805:     $result .= "</select>\n";
                    806:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    807:     $result .= $middletext;
                    808:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    809:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   810:     
                    811:     my @secondorder = sort(keys(%select2));
                    812:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    813:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                    814:     }
                    815:     foreach my $value (@secondorder) {
1.36      matthew   816:         $result.="    <option value=\"$value\" ";        
1.253     albertel  817:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www       818:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew   819:     }
                    820:     $result .= "</select>\n";
                    821:     #    return $debug;
                    822:     return $result;
                    823: }   #  end of sub linked_select_forms {
                    824: 
1.45      matthew   825: =pod
1.44      bowersj2  826: 
1.648     raeburn   827: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2  828: 
1.112     bowersj2  829: Returns a string corresponding to an HTML link to the given help
                    830: $topic, where $topic corresponds to the name of a .tex file in
                    831: /home/httpd/html/adm/help/tex, with underscores replaced by
                    832: spaces. 
                    833: 
                    834: $text will optionally be linked to the same topic, allowing you to
                    835: link text in addition to the graphic. If you do not want to link
                    836: text, but wish to specify one of the later parameters, pass an
                    837: empty string. 
                    838: 
                    839: $stayOnPage is a value that will be interpreted as a boolean. If true,
                    840: the link will not open a new window. If false, the link will open
                    841: a new window using Javascript. (Default is false.) 
                    842: 
                    843: $width and $height are optional numerical parameters that will
                    844: override the width and height of the popped up window, which may
                    845: be useful for certain help topics with big pictures included. 
1.44      bowersj2  846: 
                    847: =cut
                    848: 
                    849: sub help_open_topic {
1.48      bowersj2  850:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                    851:     $text = "" if (not defined $text);
1.44      bowersj2  852:     $stayOnPage = 0 if (not defined $stayOnPage);
1.552     banghart  853:     if ($env{'browser.interface'} eq 'textual') {
1.79      www       854: 	$stayOnPage=1;
                    855:     }
1.44      bowersj2  856:     $width = 350 if (not defined $width);
                    857:     $height = 400 if (not defined $height);
                    858:     my $filename = $topic;
                    859:     $filename =~ s/ /_/g;
                    860: 
1.48      bowersj2  861:     my $template = "";
                    862:     my $link;
1.572     banghart  863:     
1.159     www       864:     $topic=~s/\W/\_/g;
1.44      bowersj2  865: 
1.572     banghart  866:     if (!$stayOnPage) {
1.72      bowersj2  867: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart  868:     } else {
1.48      bowersj2  869: 	$link = "/adm/help/${filename}.hlp";
                    870:     }
                    871: 
                    872:     # Add the text
1.572     banghart  873:     if ($text ne "") {
1.77      www       874: 	$template .= 
1.572     banghart  875:             "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
                    876:             "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48      bowersj2  877:     }
                    878: 
                    879:     # Add the graphic
1.179     matthew   880:     my $title = &mt('Online Help');
1.667     raeburn   881:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48      bowersj2  882:     $template .= <<"ENDTEMPLATE";
1.436     albertel  883:  <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44      bowersj2  884: ENDTEMPLATE
1.78      www       885:     if ($text ne '') { $template.='</td></tr></table>' };
1.44      bowersj2  886:     return $template;
                    887: 
1.106     bowersj2  888: }
                    889: 
                    890: # This is a quicky function for Latex cheatsheet editing, since it 
                    891: # appears in at least four places
                    892: sub helpLatexCheatsheet {
                    893:     my $other = shift;
                    894:     my $addOther = '';
                    895:     if ($other) {
                    896: 	$addOther = Apache::loncommon::help_open_topic($other, shift,
                    897: 						       undef, undef, 600) .
                    898: 							   '</td><td>';
                    899:     }
                    900:     return '<table><tr><td>'.
                    901: 	$addOther .
1.636     raeburn   902: 	&Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1.106     bowersj2  903: 					    undef,undef,600)
                    904: 	.'</td><td>'.
1.636     raeburn   905: 	&Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1.106     bowersj2  906: 					    undef,undef,600)
1.673     felicia   907: 	.'</td><td>'.
                    908: 	&Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
                    909: 	                                    undef,undef,600)
1.106     bowersj2  910: 	.'</td></tr></table>';
1.172     www       911: }
                    912: 
1.430     albertel  913: sub general_help {
                    914:     my $helptopic='Student_Intro';
                    915:     if ($env{'request.role'}=~/^(ca|au)/) {
                    916: 	$helptopic='Authoring_Intro';
                    917:     } elsif ($env{'request.role'}=~/^cc/) {
                    918: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn   919:     } elsif ($env{'request.role'}=~/^dc/) {
                    920:         $helptopic='Domain_Coordination_Intro';
1.430     albertel  921:     }
                    922:     return $helptopic;
                    923: }
                    924: 
                    925: sub update_help_link {
                    926:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                    927:     my $origurl = $ENV{'REQUEST_URI'};
                    928:     $origurl=~s|^/~|/priv/|;
                    929:     my $timestamp = time;
                    930:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                    931:         $$datum = &escape($$datum);
                    932:     }
                    933: 
                    934:     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";
                    935:     my $output .= <<"ENDOUTPUT";
                    936: <script type="text/javascript">
                    937: banner_link = '$banner_link';
                    938: </script>
                    939: ENDOUTPUT
                    940:     return $output;
                    941: }
                    942: 
                    943: # now just updates the help link and generates a blue icon
1.193     raeburn   944: sub help_open_menu {
1.430     albertel  945:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart  946: 	= @_;    
1.430     albertel  947:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart  948:     # only use pop-up help (stayOnPage == 0)
1.552     banghart  949:     # if environment.remote is on (using remote control UI)
1.572     banghart  950:     if ($env{'browser.interface'} eq 'textual' ||
                    951:     	$env{'environment.remote'} eq 'off' ) {
1.552     banghart  952:         $stayOnPage=1;
1.430     albertel  953:     }
                    954:     my $output;
                    955:     if ($component_help) {
                    956: 	if (!$text) {
                    957: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                    958: 				       $width,$height);
                    959: 	} else {
                    960: 	    my $help_text;
                    961: 	    $help_text=&unescape($topic);
                    962: 	    $output='<table><tr><td>'.
                    963: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                    964: 				 $width,$height).'</td></tr></table>';
                    965: 	}
                    966:     }
                    967:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                    968:     return $output.$banner_link;
                    969: }
                    970: 
                    971: sub top_nav_help {
                    972:     my ($text) = @_;
1.436     albertel  973:     $text = &mt($text);
1.572     banghart  974:     my $stay_on_page = 
1.436     albertel  975: 	($env{'browser.interface'}  eq 'textual' ||
                    976: 	 $env{'environment.remote'} eq 'off' );
1.572     banghart  977:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel  978: 	                     : "javascript:helpMenu('open')";
1.572     banghart  979:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel  980: 
1.201     raeburn   981:     my $title = &mt('Get help');
1.436     albertel  982: 
                    983:     return <<"END";
                    984: $banner_link
                    985:  <a href="$link" title="$title">$text</a>
                    986: END
                    987: }
                    988: 
                    989: sub help_menu_js {
                    990:     my ($text) = @_;
                    991: 
                    992:     my $stayOnPage = 
                    993: 	($env{'browser.interface'}  eq 'textual' ||
                    994: 	 $env{'environment.remote'} eq 'off' );
                    995: 
                    996:     my $width = 620;
                    997:     my $height = 600;
1.430     albertel  998:     my $helptopic=&general_help();
                    999:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1000:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1001:     my $start_page =
                   1002:         &Apache::loncommon::start_page('Help Menu', undef,
                   1003: 				       {'frameset'    => 1,
                   1004: 					'js_ready'    => 1,
                   1005: 					'add_entries' => {
                   1006: 					    'border' => '0',
1.579     raeburn  1007: 					    'rows'   => "110,*",},});
1.331     albertel 1008:     my $end_page =
                   1009:         &Apache::loncommon::end_page({'frameset' => 1,
                   1010: 				      'js_ready' => 1,});
                   1011: 
1.436     albertel 1012:     my $template .= <<"ENDTEMPLATE";
                   1013: <script type="text/javascript">
1.253     albertel 1014: // <!-- BEGIN LON-CAPA Internal
                   1015: // <![CDATA[
1.430     albertel 1016: var banner_link = '';
1.243     raeburn  1017: function helpMenu(target) {
                   1018:     var caller = this;
                   1019:     if (target == 'open') {
                   1020:         var newWindow = null;
                   1021:         try {
1.262     albertel 1022:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1023:         }
                   1024:         catch(error) {
                   1025:             writeHelp(caller);
                   1026:             return;
                   1027:         }
                   1028:         if (newWindow) {
                   1029:             caller = newWindow;
                   1030:         }
1.193     raeburn  1031:     }
1.243     raeburn  1032:     writeHelp(caller);
                   1033:     return;
                   1034: }
                   1035: function writeHelp(caller) {
1.430     albertel 1036:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1037:     caller.document.close()
                   1038:     caller.focus()
1.193     raeburn  1039: }
1.253     albertel 1040: // ]]>
1.219     albertel 1041: // END LON-CAPA Internal -->
1.436     albertel 1042: </script>
1.193     raeburn  1043: ENDTEMPLATE
                   1044:     return $template;
                   1045: }
                   1046: 
1.172     www      1047: sub help_open_bug {
                   1048:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1049:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1050:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1051:     $text = "" if (not defined $text);
                   1052:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel 1053:     if ($env{'browser.interface'} eq 'textual' ||
                   1054: 	$env{'environment.remote'} eq 'off' ) {
1.172     www      1055: 	$stayOnPage=1;
                   1056:     }
1.184     albertel 1057:     $width = 600 if (not defined $width);
                   1058:     $height = 600 if (not defined $height);
1.172     www      1059: 
                   1060:     $topic=~s/\W+/\+/g;
                   1061:     my $link='';
                   1062:     my $template='';
1.379     albertel 1063:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1064: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1065:     if (!$stayOnPage)
                   1066:     {
                   1067: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1068:     }
                   1069:     else
                   1070:     {
                   1071: 	$link = $url;
                   1072:     }
                   1073:     # Add the text
                   1074:     if ($text ne "")
                   1075:     {
                   1076: 	$template .= 
                   1077:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436     albertel 1078:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172     www      1079:     }
                   1080: 
                   1081:     # Add the graphic
1.179     matthew  1082:     my $title = &mt('Report a Bug');
1.215     albertel 1083:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1084:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1085:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1086: ENDTEMPLATE
                   1087:     if ($text ne '') { $template.='</td></tr></table>' };
                   1088:     return $template;
                   1089: 
                   1090: }
                   1091: 
                   1092: sub help_open_faq {
                   1093:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1094:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1095:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1096:     $text = "" if (not defined $text);
                   1097:     $stayOnPage = 0 if (not defined $stayOnPage);
1.258     albertel 1098:     if ($env{'browser.interface'} eq 'textual' ||
                   1099: 	$env{'environment.remote'} eq 'off' ) {
1.172     www      1100: 	$stayOnPage=1;
                   1101:     }
                   1102:     $width = 350 if (not defined $width);
                   1103:     $height = 400 if (not defined $height);
                   1104: 
                   1105:     $topic=~s/\W+/\+/g;
                   1106:     my $link='';
                   1107:     my $template='';
                   1108:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1109:     if (!$stayOnPage)
                   1110:     {
                   1111: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1112:     }
                   1113:     else
                   1114:     {
                   1115: 	$link = $url;
                   1116:     }
                   1117: 
                   1118:     # Add the text
                   1119:     if ($text ne "")
                   1120:     {
                   1121: 	$template .= 
1.173     www      1122:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436     albertel 1123:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172     www      1124:     }
                   1125: 
                   1126:     # Add the graphic
1.179     matthew  1127:     my $title = &mt('View the FAQ');
1.215     albertel 1128:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1129:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1130:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1131: ENDTEMPLATE
                   1132:     if ($text ne '') { $template.='</td></tr></table>' };
                   1133:     return $template;
                   1134: 
1.44      bowersj2 1135: }
1.37      matthew  1136: 
1.180     matthew  1137: ###############################################################
                   1138: ###############################################################
                   1139: 
1.45      matthew  1140: =pod
                   1141: 
1.648     raeburn  1142: =item * &change_content_javascript():
1.256     matthew  1143: 
                   1144: This and the next function allow you to create small sections of an
                   1145: otherwise static HTML page that you can update on the fly with
                   1146: Javascript, even in Netscape 4.
                   1147: 
                   1148: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1149: must be written to the HTML page once. It will prove the Javascript
                   1150: function "change(name, content)". Calling the change function with the
                   1151: name of the section 
                   1152: you want to update, matching the name passed to C<changable_area>, and
                   1153: the new content you want to put in there, will put the content into
                   1154: that area.
                   1155: 
                   1156: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1157: to contain room for the original contents. You need to "make space"
                   1158: for whatever changes you wish to make, and be B<sure> to check your
                   1159: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1160: it's adequate for updating a one-line status display, but little more.
                   1161: This script will set the space to 100% width, so you only need to
                   1162: worry about height in Netscape 4.
                   1163: 
                   1164: Modern browsers are much less limiting, and if you can commit to the
                   1165: user not using Netscape 4, this feature may be used freely with
                   1166: pretty much any HTML.
                   1167: 
                   1168: =cut
                   1169: 
                   1170: sub change_content_javascript {
                   1171:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1172:     if ($env{'browser.type'} eq 'netscape' &&
                   1173: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1174: 	return (<<NETSCAPE4);
                   1175: 	function change(name, content) {
                   1176: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1177: 	    doc.open();
                   1178: 	    doc.write(content);
                   1179: 	    doc.close();
                   1180: 	}
                   1181: NETSCAPE4
                   1182:     } else {
                   1183: 	# Otherwise, we need to use semi-standards-compliant code
                   1184: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1185: 	# is really scary, and every useful browser supports it
                   1186: 	return (<<DOMBASED);
                   1187: 	function change(name, content) {
                   1188: 	    element = document.getElementById(name);
                   1189: 	    element.innerHTML = content;
                   1190: 	}
                   1191: DOMBASED
                   1192:     }
                   1193: }
                   1194: 
                   1195: =pod
                   1196: 
1.648     raeburn  1197: =item * &changable_area($name,$origContent):
1.256     matthew  1198: 
                   1199: This provides a "changable area" that can be modified on the fly via
                   1200: the Javascript code provided in C<change_content_javascript>. $name is
                   1201: the name you will use to reference the area later; do not repeat the
                   1202: same name on a given HTML page more then once. $origContent is what
                   1203: the area will originally contain, which can be left blank.
                   1204: 
                   1205: =cut
                   1206: 
                   1207: sub changable_area {
                   1208:     my ($name, $origContent) = @_;
                   1209: 
1.258     albertel 1210:     if ($env{'browser.type'} eq 'netscape' &&
                   1211: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1212: 	# If this is netscape 4, we need to use the Layer tag
                   1213: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1214:     } else {
                   1215: 	return "<span id='$name'>$origContent</span>";
                   1216:     }
                   1217: }
                   1218: 
                   1219: =pod
                   1220: 
1.648     raeburn  1221: =item * &viewport_geometry_js 
1.590     raeburn  1222: 
                   1223: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1224: 
                   1225: =cut
                   1226: 
                   1227: 
                   1228: sub viewport_geometry_js { 
                   1229:     return <<"GEOMETRY";
                   1230: var Geometry = {};
                   1231: function init_geometry() {
                   1232:     if (Geometry.init) { return };
                   1233:     Geometry.init=1;
                   1234:     if (window.innerHeight) {
                   1235:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1236:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1237:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1238:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1239:     }
                   1240:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1241:         Geometry.getViewportHeight =
                   1242:             function() { return document.documentElement.clientHeight; };
                   1243:         Geometry.getViewportWidth =
                   1244:             function() { return document.documentElement.clientWidth; };
                   1245: 
                   1246:         Geometry.getHorizontalScroll =
                   1247:             function() { return document.documentElement.scrollLeft; };
                   1248:         Geometry.getVerticalScroll =
                   1249:             function() { return document.documentElement.scrollTop; };
                   1250:     }
                   1251:     else if (document.body.clientHeight) {
                   1252:         Geometry.getViewportHeight =
                   1253:             function() { return document.body.clientHeight; };
                   1254:         Geometry.getViewportWidth =
                   1255:             function() { return document.body.clientWidth; };
                   1256:         Geometry.getHorizontalScroll =
                   1257:             function() { return document.body.scrollLeft; };
                   1258:         Geometry.getVerticalScroll =
                   1259:             function() { return document.body.scrollTop; };
                   1260:     }
                   1261: }
                   1262: 
                   1263: GEOMETRY
                   1264: }
                   1265: 
                   1266: =pod
                   1267: 
1.648     raeburn  1268: =item * &viewport_size_js()
1.590     raeburn  1269: 
                   1270: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1271: 
                   1272: =cut
                   1273: 
                   1274: sub viewport_size_js {
                   1275:     my $geometry = &viewport_geometry_js();
                   1276:     return <<"DIMS";
                   1277: 
                   1278: $geometry
                   1279: 
                   1280: function getViewportDims(width,height) {
                   1281:     init_geometry();
                   1282:     width.value = Geometry.getViewportWidth();
                   1283:     height.value = Geometry.getViewportHeight();
                   1284:     return;
                   1285: }
                   1286: 
                   1287: DIMS
                   1288: }
                   1289: 
                   1290: =pod
                   1291: 
1.648     raeburn  1292: =item * &resize_textarea_js()
1.565     albertel 1293: 
                   1294: emits the needed javascript to resize a textarea to be as big as possible
                   1295: 
                   1296: creates a function resize_textrea that takes two IDs first should be
                   1297: the id of the element to resize, second should be the id of a div that
                   1298: surrounds everything that comes after the textarea, this routine needs
                   1299: to be attached to the <body> for the onload and onresize events.
                   1300: 
1.648     raeburn  1301: =back
1.565     albertel 1302: 
                   1303: =cut
                   1304: 
                   1305: sub resize_textarea_js {
1.590     raeburn  1306:     my $geometry = &viewport_geometry_js();
1.565     albertel 1307:     return <<"RESIZE";
                   1308:     <script type="text/javascript">
1.590     raeburn  1309: $geometry
1.565     albertel 1310: 
1.588     albertel 1311: function getX(element) {
                   1312:     var x = 0;
                   1313:     while (element) {
                   1314: 	x += element.offsetLeft;
                   1315: 	element = element.offsetParent;
                   1316:     }
                   1317:     return x;
                   1318: }
                   1319: function getY(element) {
                   1320:     var y = 0;
                   1321:     while (element) {
                   1322: 	y += element.offsetTop;
                   1323: 	element = element.offsetParent;
                   1324:     }
                   1325:     return y;
                   1326: }
                   1327: 
                   1328: 
1.565     albertel 1329: function resize_textarea(textarea_id,bottom_id) {
                   1330:     init_geometry();
                   1331:     var textarea        = document.getElementById(textarea_id);
                   1332:     //alert(textarea);
                   1333: 
1.588     albertel 1334:     var textarea_top    = getY(textarea);
1.565     albertel 1335:     var textarea_height = textarea.offsetHeight;
                   1336:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1337:     var bottom_top      = getY(bottom);
1.565     albertel 1338:     var bottom_height   = bottom.offsetHeight;
                   1339:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1340:     var fudge           = 23;
1.565     albertel 1341:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1342:     if (new_height < 300) {
                   1343: 	new_height = 300;
                   1344:     }
                   1345:     textarea.style.height=new_height+'px';
                   1346: }
                   1347: </script>
                   1348: RESIZE
                   1349: 
                   1350: }
                   1351: 
                   1352: =pod
                   1353: 
1.256     matthew  1354: =head1 Excel and CSV file utility routines
                   1355: 
                   1356: =over 4
                   1357: 
                   1358: =cut
                   1359: 
                   1360: ###############################################################
                   1361: ###############################################################
                   1362: 
                   1363: =pod
                   1364: 
1.648     raeburn  1365: =item * &csv_translate($text) 
1.37      matthew  1366: 
1.185     www      1367: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1368: format.
                   1369: 
                   1370: =cut
                   1371: 
1.180     matthew  1372: ###############################################################
                   1373: ###############################################################
1.37      matthew  1374: sub csv_translate {
                   1375:     my $text = shift;
                   1376:     $text =~ s/\"/\"\"/g;
1.209     albertel 1377:     $text =~ s/\n/ /g;
1.37      matthew  1378:     return $text;
                   1379: }
1.180     matthew  1380: 
                   1381: ###############################################################
                   1382: ###############################################################
                   1383: 
                   1384: =pod
                   1385: 
1.648     raeburn  1386: =item * &define_excel_formats()
1.180     matthew  1387: 
                   1388: Define some commonly used Excel cell formats.
                   1389: 
                   1390: Currently supported formats:
                   1391: 
                   1392: =over 4
                   1393: 
                   1394: =item header
                   1395: 
                   1396: =item bold
                   1397: 
                   1398: =item h1
                   1399: 
                   1400: =item h2
                   1401: 
                   1402: =item h3
                   1403: 
1.256     matthew  1404: =item h4
                   1405: 
                   1406: =item i
                   1407: 
1.180     matthew  1408: =item date
                   1409: 
                   1410: =back
                   1411: 
                   1412: Inputs: $workbook
                   1413: 
                   1414: Returns: $format, a hash reference.
                   1415: 
                   1416: =cut
                   1417: 
                   1418: ###############################################################
                   1419: ###############################################################
                   1420: sub define_excel_formats {
                   1421:     my ($workbook) = @_;
                   1422:     my $format;
                   1423:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1424:                                                 bottom    => 1,
                   1425:                                                 align     => 'center');
                   1426:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1427:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1428:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1429:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1430:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1431:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1432:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1433:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1434:     return $format;
                   1435: }
                   1436: 
                   1437: ###############################################################
                   1438: ###############################################################
1.113     bowersj2 1439: 
                   1440: =pod
                   1441: 
1.648     raeburn  1442: =item * &create_workbook()
1.255     matthew  1443: 
                   1444: Create an Excel worksheet.  If it fails, output message on the
                   1445: request object and return undefs.
                   1446: 
                   1447: Inputs: Apache request object
                   1448: 
                   1449: Returns (undef) on failure, 
                   1450:     Excel worksheet object, scalar with filename, and formats 
                   1451:     from &Apache::loncommon::define_excel_formats on success
                   1452: 
                   1453: =cut
                   1454: 
                   1455: ###############################################################
                   1456: ###############################################################
                   1457: sub create_workbook {
                   1458:     my ($r) = @_;
                   1459:         #
                   1460:     # Create the excel spreadsheet
                   1461:     my $filename = '/prtspool/'.
1.258     albertel 1462:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1463:         time.'_'.rand(1000000000).'.xls';
                   1464:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1465:     if (! defined($workbook)) {
                   1466:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1467:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1468:                             "This error has been logged.  ".
                   1469:                             "Please alert your LON-CAPA administrator").
                   1470:                   '</p>');
                   1471:         return (undef);
                   1472:     }
                   1473:     #
                   1474:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1475:     #
                   1476:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1477:     return ($workbook,$filename,$format);
                   1478: }
                   1479: 
                   1480: ###############################################################
                   1481: ###############################################################
                   1482: 
                   1483: =pod
                   1484: 
1.648     raeburn  1485: =item * &create_text_file()
1.113     bowersj2 1486: 
1.542     raeburn  1487: Create a file to write to and eventually make available to the user.
1.256     matthew  1488: If file creation fails, outputs an error message on the request object and 
                   1489: return undefs.
1.113     bowersj2 1490: 
1.256     matthew  1491: Inputs: Apache request object, and file suffix
1.113     bowersj2 1492: 
1.256     matthew  1493: Returns (undef) on failure, 
                   1494:     Filehandle and filename on success.
1.113     bowersj2 1495: 
                   1496: =cut
                   1497: 
1.256     matthew  1498: ###############################################################
                   1499: ###############################################################
                   1500: sub create_text_file {
                   1501:     my ($r,$suffix) = @_;
                   1502:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1503:     my $fh;
                   1504:     my $filename = '/prtspool/'.
1.258     albertel 1505:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1506:         time.'_'.rand(1000000000).'.'.$suffix;
                   1507:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1508:     if (! defined($fh)) {
                   1509:         $r->log_error("Couldn't open $filename for output $!");
1.683   ! bisitz   1510:         $r->print(&mt('Problems occurred in creating the output file. '
        !          1511:                      .'This error has been logged. '
        !          1512:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1513:     }
1.256     matthew  1514:     return ($fh,$filename)
1.113     bowersj2 1515: }
                   1516: 
                   1517: 
1.256     matthew  1518: =pod 
1.113     bowersj2 1519: 
                   1520: =back
                   1521: 
                   1522: =cut
1.37      matthew  1523: 
                   1524: ###############################################################
1.33      matthew  1525: ##        Home server <option> list generating code          ##
                   1526: ###############################################################
1.35      matthew  1527: 
1.169     www      1528: # ------------------------------------------
                   1529: 
                   1530: sub domain_select {
                   1531:     my ($name,$value,$multiple)=@_;
                   1532:     my %domains=map { 
1.514     albertel 1533: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1534:     } &Apache::lonnet::all_domains();
1.169     www      1535:     if ($multiple) {
                   1536: 	$domains{''}=&mt('Any domain');
1.550     albertel 1537: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1538: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1539:     } else {
1.550     albertel 1540: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1541: 	return &select_form($name,$value,%domains);
                   1542:     }
                   1543: }
                   1544: 
1.282     albertel 1545: #-------------------------------------------
                   1546: 
                   1547: =pod
                   1548: 
1.519     raeburn  1549: =head1 Routines for form select boxes
                   1550: 
                   1551: =over 4
                   1552: 
1.648     raeburn  1553: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1554: 
                   1555: Returns a string containing a <select> element int multiple mode
                   1556: 
                   1557: 
                   1558: Args:
                   1559:   $name - name of the <select> element
1.506     raeburn  1560:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1561:   $size - number of rows long the select element is
1.283     albertel 1562:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1563:           (shown text should already have been &mt())
1.506     raeburn  1564:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1565: 
1.282     albertel 1566: =cut
                   1567: 
                   1568: #-------------------------------------------
1.169     www      1569: sub multiple_select_form {
1.284     albertel 1570:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1571:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1572:     my $output='';
1.191     matthew  1573:     if (! defined($size)) {
                   1574:         $size = 4;
1.283     albertel 1575:         if (scalar(keys(%$hash))<4) {
                   1576:             $size = scalar(keys(%$hash));
1.191     matthew  1577:         }
                   1578:     }
1.169     www      1579:     $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501     banghart 1580:     my @order;
1.506     raeburn  1581:     if (ref($order) eq 'ARRAY')  {
                   1582:         @order = @{$order};
                   1583:     } else {
                   1584:         @order = sort(keys(%$hash));
1.501     banghart 1585:     }
                   1586:     if (exists($$hash{'select_form_order'})) {
                   1587:         @order = @{$$hash{'select_form_order'}};
                   1588:     }
                   1589:         
1.284     albertel 1590:     foreach my $key (@order) {
1.356     albertel 1591:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1592:         $output.='selected="selected" ' if ($selected{$key});
                   1593:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1594:     }
                   1595:     $output.="</select>\n";
                   1596:     return $output;
                   1597: }
                   1598: 
1.88      www      1599: #-------------------------------------------
                   1600: 
                   1601: =pod
                   1602: 
1.648     raeburn  1603: =item * &select_form($defdom,$name,%hash)
1.88      www      1604: 
                   1605: Returns a string containing a <select name='$name' size='1'> form to 
                   1606: allow a user to select options from a hash option_name => displayed text.  
                   1607: See lonrights.pm for an example invocation and use.
                   1608: 
                   1609: =cut
                   1610: 
                   1611: #-------------------------------------------
                   1612: sub select_form {
                   1613:     my ($def,$name,%hash) = @_;
                   1614:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1615:     my @keys;
                   1616:     if (exists($hash{'select_form_order'})) {
                   1617: 	@keys=@{$hash{'select_form_order'}};
                   1618:     } else {
                   1619: 	@keys=sort(keys(%hash));
                   1620:     }
1.356     albertel 1621:     foreach my $key (@keys) {
                   1622:         $selectform.=
                   1623: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1624:             ($key eq $def ? 'selected="selected" ' : '').
                   1625:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1626:     }
                   1627:     $selectform.="</select>";
                   1628:     return $selectform;
                   1629: }
                   1630: 
1.475     www      1631: # For display filters
                   1632: 
                   1633: sub display_filter {
                   1634:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1635:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475     www      1636:     return '<nobr><label>'.&mt('Records [_1]',
                   1637: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1638: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.478     www      1639: 	   '</label></nobr> <nobr>'.
1.475     www      1640:            &mt('Filter [_1]',
1.477     www      1641: 	   &select_form($env{'form.displayfilter'},
                   1642: 			'displayfilter',
                   1643: 			('currentfolder' => 'Current folder/page',
                   1644: 			 'containing' => 'Containing phrase',
                   1645: 			 'none' => 'None'))).
1.478     www      1646: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475     www      1647: }
                   1648: 
1.167     www      1649: sub gradeleveldescription {
                   1650:     my $gradelevel=shift;
                   1651:     my %gradelevels=(0 => 'Not specified',
                   1652: 		     1 => 'Grade 1',
                   1653: 		     2 => 'Grade 2',
                   1654: 		     3 => 'Grade 3',
                   1655: 		     4 => 'Grade 4',
                   1656: 		     5 => 'Grade 5',
                   1657: 		     6 => 'Grade 6',
                   1658: 		     7 => 'Grade 7',
                   1659: 		     8 => 'Grade 8',
                   1660: 		     9 => 'Grade 9',
                   1661: 		     10 => 'Grade 10',
                   1662: 		     11 => 'Grade 11',
                   1663: 		     12 => 'Grade 12',
                   1664: 		     13 => 'Grade 13',
                   1665: 		     14 => '100 Level',
                   1666: 		     15 => '200 Level',
                   1667: 		     16 => '300 Level',
                   1668: 		     17 => '400 Level',
                   1669: 		     18 => 'Graduate Level');
                   1670:     return &mt($gradelevels{$gradelevel});
                   1671: }
                   1672: 
1.163     www      1673: sub select_level_form {
                   1674:     my ($deflevel,$name)=@_;
                   1675:     unless ($deflevel) { $deflevel=0; }
1.167     www      1676:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1677:     for (my $i=0; $i<=18; $i++) {
                   1678:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1679:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1680:                 ">".&gradeleveldescription($i)."</option>\n";
                   1681:     }
                   1682:     $selectform.="</select>";
                   1683:     return $selectform;
1.163     www      1684: }
1.167     www      1685: 
1.35      matthew  1686: #-------------------------------------------
                   1687: 
1.45      matthew  1688: =pod
                   1689: 
1.648     raeburn  1690: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35      matthew  1691: 
                   1692: Returns a string containing a <select name='$name' size='1'> form to 
                   1693: allow a user to select the domain to preform an operation in.  
                   1694: See loncreateuser.pm for an example invocation and use.
                   1695: 
1.90      www      1696: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1697: selected");
                   1698: 
1.563     raeburn  1699: If the $showdomdesc flag is set, the domain name is followed by the domain description. 
                   1700: 
1.35      matthew  1701: =cut
                   1702: 
                   1703: #-------------------------------------------
1.34      matthew  1704: sub select_dom_form {
1.563     raeburn  1705:     my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550     albertel 1706:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1707:     if ($includeempty) { @domains=('',@domains); }
1.34      matthew  1708:     my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356     albertel 1709:     foreach my $dom (@domains) {
                   1710:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1711:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1712:         if ($showdomdesc) {
                   1713:             if ($dom ne '') {
                   1714:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1715:                 if ($domdesc ne '') {
                   1716:                     $selectdomain .= ' ('.$domdesc.')';
                   1717:                 }
                   1718:             } 
                   1719:         }
                   1720:         $selectdomain .= "</option>\n";
1.34      matthew  1721:     }
                   1722:     $selectdomain.="</select>";
                   1723:     return $selectdomain;
                   1724: }
                   1725: 
1.35      matthew  1726: #-------------------------------------------
                   1727: 
1.45      matthew  1728: =pod
                   1729: 
1.648     raeburn  1730: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1731: 
1.586     raeburn  1732: input: 4 arguments (two required, two optional) - 
                   1733:     $domain - domain of new user
                   1734:     $name - name of form element
                   1735:     $default - Value of 'default' causes a default item to be first 
                   1736:                             option, and selected by default. 
                   1737:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1738:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1739: output: returns 2 items: 
1.586     raeburn  1740: (a) form element which contains either:
                   1741:    (i) <select name="$name">
                   1742:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1743:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1744:        </select>
                   1745:        form item if there are multiple library servers in $domain, or
                   1746:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1747:        if there is only one library server in $domain.
                   1748: 
                   1749: (b) number of library servers found.
                   1750: 
                   1751: See loncreateuser.pm for example of use.
1.35      matthew  1752: 
                   1753: =cut
                   1754: 
                   1755: #-------------------------------------------
1.586     raeburn  1756: sub home_server_form_item {
                   1757:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1758:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1759:     my $result;
                   1760:     my $numlib = keys(%servers);
                   1761:     if ($numlib > 1) {
                   1762:         $result .= '<select name="'.$name.'" />'."\n";
                   1763:         if ($default) {
                   1764:             $result .= '<option value="default" selected>'.&mt('default').
                   1765:                        '</option>'."\n";
                   1766:         }
                   1767:         foreach my $hostid (sort(keys(%servers))) {
                   1768:             $result.= '<option value="'.$hostid.'">'.
                   1769: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1770:         }
                   1771:         $result .= '</select>'."\n";
                   1772:     } elsif ($numlib == 1) {
                   1773:         my $hostid;
                   1774:         foreach my $item (keys(%servers)) {
                   1775:             $hostid = $item;
                   1776:         }
                   1777:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1778:                    $hostid.'" />';
                   1779:                    if (!$hide) {
                   1780:                        $result .= $hostid.' '.$servers{$hostid};
                   1781:                    }
                   1782:                    $result .= "\n";
                   1783:     } elsif ($default) {
                   1784:         $result .= '<input type="hidden" name="'.$name.
                   1785:                    '" value="default" />';
                   1786:                    if (!$hide) {
                   1787:                        $result .= &mt('default');
                   1788:                    }
                   1789:                    $result .= "\n";
1.33      matthew  1790:     }
1.586     raeburn  1791:     return ($result,$numlib);
1.33      matthew  1792: }
1.112     bowersj2 1793: 
                   1794: =pod
                   1795: 
1.534     albertel 1796: =back 
                   1797: 
1.112     bowersj2 1798: =cut
1.87      matthew  1799: 
                   1800: ###############################################################
1.112     bowersj2 1801: ##                  Decoding User Agent                      ##
1.87      matthew  1802: ###############################################################
                   1803: 
                   1804: =pod
                   1805: 
1.112     bowersj2 1806: =head1 Decoding the User Agent
                   1807: 
                   1808: =over 4
                   1809: 
                   1810: =item * &decode_user_agent()
1.87      matthew  1811: 
                   1812: Inputs: $r
                   1813: 
                   1814: Outputs:
                   1815: 
                   1816: =over 4
                   1817: 
1.112     bowersj2 1818: =item * $httpbrowser
1.87      matthew  1819: 
1.112     bowersj2 1820: =item * $clientbrowser
1.87      matthew  1821: 
1.112     bowersj2 1822: =item * $clientversion
1.87      matthew  1823: 
1.112     bowersj2 1824: =item * $clientmathml
1.87      matthew  1825: 
1.112     bowersj2 1826: =item * $clientunicode
1.87      matthew  1827: 
1.112     bowersj2 1828: =item * $clientos
1.87      matthew  1829: 
                   1830: =back
                   1831: 
1.157     matthew  1832: =back 
                   1833: 
1.87      matthew  1834: =cut
                   1835: 
                   1836: ###############################################################
                   1837: ###############################################################
                   1838: sub decode_user_agent {
1.247     albertel 1839:     my ($r)=@_;
1.87      matthew  1840:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   1841:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   1842:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 1843:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  1844:     my $clientbrowser='unknown';
                   1845:     my $clientversion='0';
                   1846:     my $clientmathml='';
                   1847:     my $clientunicode='0';
                   1848:     for (my $i=0;$i<=$#browsertype;$i++) {
                   1849:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   1850: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   1851: 	    $clientbrowser=$bname;
                   1852:             $httpbrowser=~/$vreg/i;
                   1853: 	    $clientversion=$1;
                   1854:             $clientmathml=($clientversion>=$minv);
                   1855:             $clientunicode=($clientversion>=$univ);
                   1856: 	}
                   1857:     }
                   1858:     my $clientos='unknown';
                   1859:     if (($httpbrowser=~/linux/i) ||
                   1860:         ($httpbrowser=~/unix/i) ||
                   1861:         ($httpbrowser=~/ux/i) ||
                   1862:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   1863:     if (($httpbrowser=~/vax/i) ||
                   1864:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   1865:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   1866:     if (($httpbrowser=~/mac/i) ||
                   1867:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   1868:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   1869:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   1870:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   1871:             $clientunicode,$clientos,);
                   1872: }
                   1873: 
1.32      matthew  1874: ###############################################################
                   1875: ##    Authentication changing form generation subroutines    ##
                   1876: ###############################################################
                   1877: ##
                   1878: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   1879: ## hash, and have reasonable default values.
                   1880: ##
                   1881: ##    formname = the name given in the <form> tag.
1.35      matthew  1882: #-------------------------------------------
                   1883: 
1.45      matthew  1884: =pod
                   1885: 
1.112     bowersj2 1886: =head1 Authentication Routines
                   1887: 
                   1888: =over 4
                   1889: 
1.648     raeburn  1890: =item * &authform_xxxxxx()
1.35      matthew  1891: 
                   1892: The authform_xxxxxx subroutines provide javascript and html forms which 
                   1893: handle some of the conveniences required for authentication forms.  
                   1894: This is not an optimal method, but it works.  
                   1895: 
                   1896: =over 4
                   1897: 
1.112     bowersj2 1898: =item * authform_header
1.35      matthew  1899: 
1.112     bowersj2 1900: =item * authform_authorwarning
1.35      matthew  1901: 
1.112     bowersj2 1902: =item * authform_nochange
1.35      matthew  1903: 
1.112     bowersj2 1904: =item * authform_kerberos
1.35      matthew  1905: 
1.112     bowersj2 1906: =item * authform_internal
1.35      matthew  1907: 
1.112     bowersj2 1908: =item * authform_filesystem
1.35      matthew  1909: 
                   1910: =back
                   1911: 
1.648     raeburn  1912: See loncreateuser.pm for invocation and use examples.
1.157     matthew  1913: 
1.35      matthew  1914: =cut
                   1915: 
                   1916: #-------------------------------------------
1.32      matthew  1917: sub authform_header{  
                   1918:     my %in = (
                   1919:         formname => 'cu',
1.80      albertel 1920:         kerb_def_dom => '',
1.32      matthew  1921:         @_,
                   1922:     );
                   1923:     $in{'formname'} = 'document.' . $in{'formname'};
                   1924:     my $result='';
1.80      albertel 1925: 
                   1926: #---------------------------------------------- Code for upper case translation
                   1927:     my $Javascript_toUpperCase;
                   1928:     unless ($in{kerb_def_dom}) {
                   1929:         $Javascript_toUpperCase =<<"END";
                   1930:         switch (choice) {
                   1931:            case 'krb': currentform.elements[choicearg].value =
                   1932:                currentform.elements[choicearg].value.toUpperCase();
                   1933:                break;
                   1934:            default:
                   1935:         }
                   1936: END
                   1937:     } else {
                   1938:         $Javascript_toUpperCase = "";
                   1939:     }
                   1940: 
1.165     raeburn  1941:     my $radioval = "'nochange'";
1.591     raeburn  1942:     if (defined($in{'curr_authtype'})) {
                   1943:         if ($in{'curr_authtype'} ne '') {
                   1944:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   1945:         }
1.174     matthew  1946:     }
1.165     raeburn  1947:     my $argfield = 'null';
1.591     raeburn  1948:     if (defined($in{'mode'})) {
1.165     raeburn  1949:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  1950:             if (defined($in{'curr_autharg'})) {
                   1951:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  1952:                     $argfield = "'$in{'curr_autharg'}'";
                   1953:                 }
                   1954:             }
                   1955:         }
                   1956:     }
                   1957: 
1.32      matthew  1958:     $result.=<<"END";
                   1959: var current = new Object();
1.165     raeburn  1960: current.radiovalue = $radioval;
                   1961: current.argfield = $argfield;
1.32      matthew  1962: 
                   1963: function changed_radio(choice,currentform) {
                   1964:     var choicearg = choice + 'arg';
                   1965:     // If a radio button in changed, we need to change the argfield
                   1966:     if (current.radiovalue != choice) {
                   1967:         current.radiovalue = choice;
                   1968:         if (current.argfield != null) {
                   1969:             currentform.elements[current.argfield].value = '';
                   1970:         }
                   1971:         if (choice == 'nochange') {
                   1972:             current.argfield = null;
                   1973:         } else {
                   1974:             current.argfield = choicearg;
                   1975:             switch(choice) {
                   1976:                 case 'krb': 
                   1977:                     currentform.elements[current.argfield].value = 
                   1978:                         "$in{'kerb_def_dom'}";
                   1979:                 break;
                   1980:               default:
                   1981:                 break;
                   1982:             }
                   1983:         }
                   1984:     }
                   1985:     return;
                   1986: }
1.22      www      1987: 
1.32      matthew  1988: function changed_text(choice,currentform) {
                   1989:     var choicearg = choice + 'arg';
                   1990:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 1991:         $Javascript_toUpperCase
1.32      matthew  1992:         // clear old field
                   1993:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   1994:             currentform.elements[current.argfield].value = '';
                   1995:         }
                   1996:         current.argfield = choicearg;
                   1997:     }
                   1998:     set_auth_radio_buttons(choice,currentform);
                   1999:     return;
1.20      www      2000: }
1.32      matthew  2001: 
                   2002: function set_auth_radio_buttons(newvalue,currentform) {
                   2003:     var i=0;
                   2004:     while (i < currentform.login.length) {
                   2005:         if (currentform.login[i].value == newvalue) { break; }
                   2006:         i++;
                   2007:     }
                   2008:     if (i == currentform.login.length) {
                   2009:         return;
                   2010:     }
                   2011:     current.radiovalue = newvalue;
                   2012:     currentform.login[i].checked = true;
                   2013:     return;
                   2014: }
                   2015: END
                   2016:     return $result;
                   2017: }
                   2018: 
                   2019: sub authform_authorwarning{
                   2020:     my $result='';
1.144     matthew  2021:     $result='<i>'.
                   2022:         &mt('As a general rule, only authors or co-authors should be '.
                   2023:             'filesystem authenticated '.
                   2024:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2025:     return $result;
                   2026: }
                   2027: 
                   2028: sub authform_nochange{  
                   2029:     my %in = (
                   2030:               formname => 'document.cu',
                   2031:               kerb_def_dom => 'MSU.EDU',
                   2032:               @_,
                   2033:           );
1.586     raeburn  2034:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2035:     my $result;
                   2036:     if (keys(%can_assign) == 0) {
                   2037:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2038:     } else {
                   2039:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2040:                   '<input type="radio" name="login" value="nochange" '.
                   2041:                   'checked="checked" onclick="'.
1.281     albertel 2042:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2043: 	    '</label>';
1.586     raeburn  2044:     }
1.32      matthew  2045:     return $result;
                   2046: }
                   2047: 
1.591     raeburn  2048: sub authform_kerberos {
1.32      matthew  2049:     my %in = (
                   2050:               formname => 'document.cu',
                   2051:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2052:               kerb_def_auth => 'krb4',
1.32      matthew  2053:               @_,
                   2054:               );
1.586     raeburn  2055:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2056:         $autharg,$jscall);
                   2057:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2058:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.586     raeburn  2059:        $check5 = ' checked="on"';
1.80      albertel 2060:     } else {
1.586     raeburn  2061:        $check4 = ' checked="on"';
1.80      albertel 2062:     }
1.165     raeburn  2063:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2064:     if (defined($in{'curr_authtype'})) {
                   2065:         if ($in{'curr_authtype'} eq 'krb') {
1.586     raeburn  2066:             $krbcheck = ' checked="on"';
1.623     raeburn  2067:             if (defined($in{'mode'})) {
                   2068:                 if ($in{'mode'} eq 'modifyuser') {
                   2069:                     $krbcheck = '';
                   2070:                 }
                   2071:             }
1.591     raeburn  2072:             if (defined($in{'curr_kerb_ver'})) {
                   2073:                 if ($in{'curr_krb_ver'} eq '5') {
                   2074:                     $check5 = ' checked="on"';
                   2075:                     $check4 = '';
                   2076:                 } else {
                   2077:                     $check4 = ' checked="on"';
                   2078:                     $check5 = '';
                   2079:                 }
1.586     raeburn  2080:             }
1.591     raeburn  2081:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2082:                 $krbarg = $in{'curr_autharg'};
                   2083:             }
1.586     raeburn  2084:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2085:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2086:                     $result = 
                   2087:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2088:         $in{'curr_autharg'},$krbver);
                   2089:                 } else {
                   2090:                     $result =
                   2091:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2092:                 }
                   2093:                 return $result; 
                   2094:             }
                   2095:         }
                   2096:     } else {
                   2097:         if ($authnum == 1) {
                   2098:             $authtype = '<input type="hidden" name="login" value="krb">';
1.165     raeburn  2099:         }
                   2100:     }
1.586     raeburn  2101:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2102:         return;
1.587     raeburn  2103:     } elsif ($authtype eq '') {
1.591     raeburn  2104:         if (defined($in{'mode'})) {
1.587     raeburn  2105:             if ($in{'mode'} eq 'modifycourse') {
                   2106:                 if ($authnum == 1) {
                   2107:                     $authtype = '<input type="hidden" name="login" value="krb">';
                   2108:                 }
                   2109:             }
                   2110:         }
1.586     raeburn  2111:     }
                   2112:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2113:     if ($authtype eq '') {
                   2114:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2115:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2116:                     $krbcheck.' />';
                   2117:     }
                   2118:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2119:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2120:          $in{'curr_authtype'} eq 'krb5') ||
                   2121:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2122:          $in{'curr_authtype'} eq 'krb4')) {
                   2123:         $result .= &mt
1.144     matthew  2124:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2125:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2126:          '<label>'.$authtype,
1.281     albertel 2127:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2128:              'value="'.$krbarg.'" '.
1.144     matthew  2129:              'onchange="'.$jscall.'" />',
1.281     albertel 2130:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2131:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2132: 	 '</label>');
1.586     raeburn  2133:     } elsif ($can_assign{'krb4'}) {
                   2134:         $result .= &mt
                   2135:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2136:          '[_3] Version 4 [_4]',
                   2137:          '<label>'.$authtype,
                   2138:          '</label><input type="text" size="10" name="krbarg" '.
                   2139:              'value="'.$krbarg.'" '.
                   2140:              'onchange="'.$jscall.'" />',
                   2141:          '<label><input type="hidden" name="krbver" value="4" />',
                   2142:          '</label>');
                   2143:     } elsif ($can_assign{'krb5'}) {
                   2144:         $result .= &mt
                   2145:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2146:          '[_3] Version 5 [_4]',
                   2147:          '<label>'.$authtype,
                   2148:          '</label><input type="text" size="10" name="krbarg" '.
                   2149:              'value="'.$krbarg.'" '.
                   2150:              'onchange="'.$jscall.'" />',
                   2151:          '<label><input type="hidden" name="krbver" value="5" />',
                   2152:          '</label>');
                   2153:     }
1.32      matthew  2154:     return $result;
                   2155: }
                   2156: 
                   2157: sub authform_internal{  
1.586     raeburn  2158:     my %in = (
1.32      matthew  2159:                 formname => 'document.cu',
                   2160:                 kerb_def_dom => 'MSU.EDU',
                   2161:                 @_,
                   2162:                 );
1.586     raeburn  2163:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2164:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2165:     if (defined($in{'curr_authtype'})) {
                   2166:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2167:             if ($can_assign{'int'}) {
                   2168:                 $intcheck = 'checked="on" ';
1.623     raeburn  2169:                 if (defined($in{'mode'})) {
                   2170:                     if ($in{'mode'} eq 'modifyuser') {
                   2171:                         $intcheck = '';
                   2172:                     }
                   2173:                 }
1.591     raeburn  2174:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2175:                     $intarg = $in{'curr_autharg'};
                   2176:                 }
                   2177:             } else {
                   2178:                 $result = &mt('Currently internally authenticated.');
                   2179:                 return $result;
1.165     raeburn  2180:             }
                   2181:         }
1.586     raeburn  2182:     } else {
                   2183:         if ($authnum == 1) {
                   2184:             $authtype = '<input type="hidden" name="login" value="int">';
                   2185:         }
                   2186:     }
                   2187:     if (!$can_assign{'int'}) {
                   2188:         return;
1.587     raeburn  2189:     } elsif ($authtype eq '') {
1.591     raeburn  2190:         if (defined($in{'mode'})) {
1.587     raeburn  2191:             if ($in{'mode'} eq 'modifycourse') {
                   2192:                 if ($authnum == 1) {
                   2193:                     $authtype = '<input type="hidden" name="login" value="int">';
                   2194:                 }
                   2195:             }
                   2196:         }
1.165     raeburn  2197:     }
1.586     raeburn  2198:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2199:     if ($authtype eq '') {
                   2200:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2201:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2202:     }
1.605     bisitz   2203:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2204:                $intarg.'" onchange="'.$jscall.'" />';
                   2205:     $result = &mt
1.144     matthew  2206:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2207:          '<label>'.$authtype,'</label>'.$autharg);
1.620     www      2208:     $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2209:     return $result;
                   2210: }
                   2211: 
                   2212: sub authform_local{  
                   2213:     my %in = (
                   2214:               formname => 'document.cu',
                   2215:               kerb_def_dom => 'MSU.EDU',
                   2216:               @_,
                   2217:               );
1.586     raeburn  2218:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2219:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2220:     if (defined($in{'curr_authtype'})) {
                   2221:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2222:             if ($can_assign{'loc'}) {
                   2223:                 $loccheck = 'checked="on" ';
1.623     raeburn  2224:                 if (defined($in{'mode'})) {
                   2225:                     if ($in{'mode'} eq 'modifyuser') {
                   2226:                         $loccheck = '';
                   2227:                     }
                   2228:                 }
1.591     raeburn  2229:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2230:                     $locarg = $in{'curr_autharg'};
                   2231:                 }
                   2232:             } else {
                   2233:                 $result = &mt('Currently using local (institutional) authentication.');
                   2234:                 return $result;
1.165     raeburn  2235:             }
                   2236:         }
1.586     raeburn  2237:     } else {
                   2238:         if ($authnum == 1) {
                   2239:             $authtype = '<input type="hidden" name="login" value="loc">';
                   2240:         }
                   2241:     }
                   2242:     if (!$can_assign{'loc'}) {
                   2243:         return;
1.587     raeburn  2244:     } elsif ($authtype eq '') {
1.591     raeburn  2245:         if (defined($in{'mode'})) {
1.587     raeburn  2246:             if ($in{'mode'} eq 'modifycourse') {
                   2247:                 if ($authnum == 1) {
                   2248:                     $authtype = '<input type="hidden" name="login" value="loc">';
                   2249:                 }
                   2250:             }
                   2251:         }
1.165     raeburn  2252:     }
1.586     raeburn  2253:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2254:     if ($authtype eq '') {
                   2255:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2256:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2257:                     $jscall.'" />';
                   2258:     }
                   2259:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2260:                $locarg.'" onchange="'.$jscall.'" />';
                   2261:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2262:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2263:     return $result;
                   2264: }
                   2265: 
                   2266: sub authform_filesystem{  
                   2267:     my %in = (
                   2268:               formname => 'document.cu',
                   2269:               kerb_def_dom => 'MSU.EDU',
                   2270:               @_,
                   2271:               );
1.586     raeburn  2272:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2273:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2274:     if (defined($in{'curr_authtype'})) {
                   2275:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2276:             if ($can_assign{'fsys'}) {
                   2277:                 $fsyscheck = 'checked="on" ';
1.623     raeburn  2278:                 if (defined($in{'mode'})) {
                   2279:                     if ($in{'mode'} eq 'modifyuser') {
                   2280:                         $fsyscheck = '';
                   2281:                     }
                   2282:                 }
1.586     raeburn  2283:             } else {
                   2284:                 $result = &mt('Currently Filesystem Authenticated.');
                   2285:                 return $result;
                   2286:             }           
                   2287:         }
                   2288:     } else {
                   2289:         if ($authnum == 1) {
                   2290:             $authtype = '<input type="hidden" name="login" value="fsys">';
                   2291:         }
                   2292:     }
                   2293:     if (!$can_assign{'fsys'}) {
                   2294:         return;
1.587     raeburn  2295:     } elsif ($authtype eq '') {
1.591     raeburn  2296:         if (defined($in{'mode'})) {
1.587     raeburn  2297:             if ($in{'mode'} eq 'modifycourse') {
                   2298:                 if ($authnum == 1) {
                   2299:                     $authtype = '<input type="hidden" name="login" value="fsys">';
                   2300:                 }
                   2301:             }
                   2302:         }
1.586     raeburn  2303:     }
                   2304:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2305:     if ($authtype eq '') {
                   2306:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2307:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2308:                     $jscall.'" />';
                   2309:     }
                   2310:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2311:                ' onchange="'.$jscall.'" />';
                   2312:     $result = &mt
1.144     matthew  2313:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2314:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2315:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2316:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2317:                   'onchange="'.$jscall.'" />');
1.32      matthew  2318:     return $result;
                   2319: }
                   2320: 
1.586     raeburn  2321: sub get_assignable_auth {
                   2322:     my ($dom) = @_;
                   2323:     if ($dom eq '') {
                   2324:         $dom = $env{'request.role.domain'};
                   2325:     }
                   2326:     my %can_assign = (
                   2327:                           krb4 => 1,
                   2328:                           krb5 => 1,
                   2329:                           int  => 1,
                   2330:                           loc  => 1,
                   2331:                      );
                   2332:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2333:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2334:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2335:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2336:             my $context;
                   2337:             if ($env{'request.role'} =~ /^au/) {
                   2338:                 $context = 'author';
                   2339:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2340:                 $context = 'domain';
                   2341:             } elsif ($env{'request.course.id'}) {
                   2342:                 $context = 'course';
                   2343:             }
                   2344:             if ($context) {
                   2345:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2346:                    %can_assign = %{$authhash->{$context}}; 
                   2347:                 }
                   2348:             }
                   2349:         }
                   2350:     }
                   2351:     my $authnum = 0;
                   2352:     foreach my $key (keys(%can_assign)) {
                   2353:         if ($can_assign{$key}) {
                   2354:             $authnum ++;
                   2355:         }
                   2356:     }
                   2357:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2358:         $authnum --;
                   2359:     }
                   2360:     return ($authnum,%can_assign);
                   2361: }
                   2362: 
1.80      albertel 2363: ###############################################################
                   2364: ##    Get Kerberos Defaults for Domain                 ##
                   2365: ###############################################################
                   2366: ##
                   2367: ## Returns default kerberos version and an associated argument
                   2368: ## as listed in file domain.tab. If not listed, provides
                   2369: ## appropriate default domain and kerberos version.
                   2370: ##
                   2371: #-------------------------------------------
                   2372: 
                   2373: =pod
                   2374: 
1.648     raeburn  2375: =item * &get_kerberos_defaults()
1.80      albertel 2376: 
                   2377: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2378: version and domain. If not found, it defaults to version 4 and the 
                   2379: domain of the server.
1.80      albertel 2380: 
1.648     raeburn  2381: =over 4
                   2382: 
1.80      albertel 2383: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2384: 
1.648     raeburn  2385: =back
                   2386: 
                   2387: =back
                   2388: 
1.80      albertel 2389: =cut
                   2390: 
                   2391: #-------------------------------------------
                   2392: sub get_kerberos_defaults {
                   2393:     my $domain=shift;
1.641     raeburn  2394:     my ($krbdef,$krbdefdom);
                   2395:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2396:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2397:         $krbdef = $domdefaults{'auth_def'};
                   2398:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2399:     } else {
1.80      albertel 2400:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2401:         my $krbdefdom=$1;
                   2402:         $krbdefdom=~tr/a-z/A-Z/;
                   2403:         $krbdef = "krb4";
                   2404:     }
                   2405:     return ($krbdef,$krbdefdom);
                   2406: }
1.112     bowersj2 2407: 
1.32      matthew  2408: 
1.46      matthew  2409: ###############################################################
                   2410: ##                Thesaurus Functions                        ##
                   2411: ###############################################################
1.20      www      2412: 
1.46      matthew  2413: =pod
1.20      www      2414: 
1.112     bowersj2 2415: =head1 Thesaurus Functions
                   2416: 
                   2417: =over 4
                   2418: 
1.648     raeburn  2419: =item * &initialize_keywords()
1.46      matthew  2420: 
                   2421: Initializes the package variable %Keywords if it is empty.  Uses the
                   2422: package variable $thesaurus_db_file.
                   2423: 
                   2424: =cut
                   2425: 
                   2426: ###################################################
                   2427: 
                   2428: sub initialize_keywords {
                   2429:     return 1 if (scalar keys(%Keywords));
                   2430:     # If we are here, %Keywords is empty, so fill it up
                   2431:     #   Make sure the file we need exists...
                   2432:     if (! -e $thesaurus_db_file) {
                   2433:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2434:                                  " failed because it does not exist");
                   2435:         return 0;
                   2436:     }
                   2437:     #   Set up the hash as a database
                   2438:     my %thesaurus_db;
                   2439:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2440:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2441:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2442:                                  $thesaurus_db_file);
                   2443:         return 0;
                   2444:     } 
                   2445:     #  Get the average number of appearances of a word.
                   2446:     my $avecount = $thesaurus_db{'average.count'};
                   2447:     #  Put keywords (those that appear > average) into %Keywords
                   2448:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2449:         my ($count,undef) = split /:/,$data;
                   2450:         $Keywords{$word}++ if ($count > $avecount);
                   2451:     }
                   2452:     untie %thesaurus_db;
                   2453:     # Remove special values from %Keywords.
1.356     albertel 2454:     foreach my $value ('total.count','average.count') {
                   2455:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2456:   }
1.46      matthew  2457:     return 1;
                   2458: }
                   2459: 
                   2460: ###################################################
                   2461: 
                   2462: =pod
                   2463: 
1.648     raeburn  2464: =item * &keyword($word)
1.46      matthew  2465: 
                   2466: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2467: than the average number of times in the thesaurus database.  Calls 
                   2468: &initialize_keywords
                   2469: 
                   2470: =cut
                   2471: 
                   2472: ###################################################
1.20      www      2473: 
                   2474: sub keyword {
1.46      matthew  2475:     return if (!&initialize_keywords());
                   2476:     my $word=lc(shift());
                   2477:     $word=~s/\W//g;
                   2478:     return exists($Keywords{$word});
1.20      www      2479: }
1.46      matthew  2480: 
                   2481: ###############################################################
                   2482: 
                   2483: =pod 
1.20      www      2484: 
1.648     raeburn  2485: =item * &get_related_words()
1.46      matthew  2486: 
1.160     matthew  2487: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2488: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2489: will be returned.  The order of the words returned is determined by the
                   2490: database which holds them.
                   2491: 
                   2492: Uses global $thesaurus_db_file.
                   2493: 
                   2494: =cut
                   2495: 
                   2496: ###############################################################
                   2497: sub get_related_words {
                   2498:     my $keyword = shift;
                   2499:     my %thesaurus_db;
                   2500:     if (! -e $thesaurus_db_file) {
                   2501:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2502:                                  "failed because the file does not exist");
                   2503:         return ();
                   2504:     }
                   2505:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2506:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2507:         return ();
                   2508:     } 
                   2509:     my @Words=();
1.429     www      2510:     my $count=0;
1.46      matthew  2511:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2512: 	# The first element is the number of times
                   2513: 	# the word appears.  We do not need it now.
1.429     www      2514: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2515: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2516: 	my $threshold=$mostfrequentcount/10;
                   2517:         foreach my $possibleword (@RelatedWords) {
                   2518:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2519:             if ($wordcount>$threshold) {
                   2520: 		push(@Words,$word);
                   2521:                 $count++;
                   2522:                 if ($count>10) { last; }
                   2523: 	    }
1.20      www      2524:         }
                   2525:     }
1.46      matthew  2526:     untie %thesaurus_db;
                   2527:     return @Words;
1.14      harris41 2528: }
1.46      matthew  2529: 
1.112     bowersj2 2530: =pod
                   2531: 
                   2532: =back
                   2533: 
                   2534: =cut
1.61      www      2535: 
                   2536: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2537: =pod
                   2538: 
1.112     bowersj2 2539: =head1 User Name Functions
                   2540: 
                   2541: =over 4
                   2542: 
1.648     raeburn  2543: =item * &plainname($uname,$udom,$first)
1.81      albertel 2544: 
1.112     bowersj2 2545: Takes a users logon name and returns it as a string in
1.226     albertel 2546: "first middle last generation" form 
                   2547: if $first is set to 'lastname' then it returns it as
                   2548: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2549: 
                   2550: =cut
1.61      www      2551: 
1.295     www      2552: 
1.81      albertel 2553: ###############################################################
1.61      www      2554: sub plainname {
1.226     albertel 2555:     my ($uname,$udom,$first)=@_;
1.537     albertel 2556:     return if (!defined($uname) || !defined($udom));
1.295     www      2557:     my %names=&getnames($uname,$udom);
1.226     albertel 2558:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2559: 					  $names{'middlename'},
                   2560: 					  $names{'lastname'},
                   2561: 					  $names{'generation'},$first);
                   2562:     $name=~s/^\s+//;
1.62      www      2563:     $name=~s/\s+$//;
                   2564:     $name=~s/\s+/ /g;
1.353     albertel 2565:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2566:     return $name;
1.61      www      2567: }
1.66      www      2568: 
                   2569: # -------------------------------------------------------------------- Nickname
1.81      albertel 2570: =pod
                   2571: 
1.648     raeburn  2572: =item * &nickname($uname,$udom)
1.81      albertel 2573: 
                   2574: Gets a users name and returns it as a string as
                   2575: 
                   2576: "&quot;nickname&quot;"
1.66      www      2577: 
1.81      albertel 2578: if the user has a nickname or
                   2579: 
                   2580: "first middle last generation"
                   2581: 
                   2582: if the user does not
                   2583: 
                   2584: =cut
1.66      www      2585: 
                   2586: sub nickname {
                   2587:     my ($uname,$udom)=@_;
1.537     albertel 2588:     return if (!defined($uname) || !defined($udom));
1.295     www      2589:     my %names=&getnames($uname,$udom);
1.68      albertel 2590:     my $name=$names{'nickname'};
1.66      www      2591:     if ($name) {
                   2592:        $name='&quot;'.$name.'&quot;'; 
                   2593:     } else {
                   2594:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2595: 	     $names{'lastname'}.' '.$names{'generation'};
                   2596:        $name=~s/\s+$//;
                   2597:        $name=~s/\s+/ /g;
                   2598:     }
                   2599:     return $name;
                   2600: }
                   2601: 
1.295     www      2602: sub getnames {
                   2603:     my ($uname,$udom)=@_;
1.537     albertel 2604:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2605:     if ($udom eq 'public' && $uname eq 'public') {
                   2606: 	return ('lastname' => &mt('Public'));
                   2607:     }
1.295     www      2608:     my $id=$uname.':'.$udom;
                   2609:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2610:     if ($cached) {
                   2611: 	return %{$names};
                   2612:     } else {
                   2613: 	my %loadnames=&Apache::lonnet::get('environment',
                   2614:                     ['firstname','middlename','lastname','generation','nickname'],
                   2615: 					 $udom,$uname);
                   2616: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2617: 	return %loadnames;
                   2618:     }
                   2619: }
1.61      www      2620: 
1.542     raeburn  2621: # -------------------------------------------------------------------- getemails
1.648     raeburn  2622: 
1.542     raeburn  2623: =pod
                   2624: 
1.648     raeburn  2625: =item * &getemails($uname,$udom)
1.542     raeburn  2626: 
                   2627: Gets a user's email information and returns it as a hash with keys:
                   2628: notification, critnotification, permanentemail
                   2629: 
                   2630: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2631: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2632:  
1.648     raeburn  2633: 
1.542     raeburn  2634: =cut
                   2635: 
1.648     raeburn  2636: 
1.466     albertel 2637: sub getemails {
                   2638:     my ($uname,$udom)=@_;
                   2639:     if ($udom eq 'public' && $uname eq 'public') {
                   2640: 	return;
                   2641:     }
1.467     www      2642:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2643:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2644:     my $id=$uname.':'.$udom;
                   2645:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2646:     if ($cached) {
                   2647: 	return %{$names};
                   2648:     } else {
                   2649: 	my %loadnames=&Apache::lonnet::get('environment',
                   2650:                     			   ['notification','critnotification',
                   2651: 					    'permanentemail'],
                   2652: 					   $udom,$uname);
                   2653: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2654: 	return %loadnames;
                   2655:     }
                   2656: }
                   2657: 
1.551     albertel 2658: sub flush_email_cache {
                   2659:     my ($uname,$udom)=@_;
                   2660:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2661:     if (!$uname) { $uname=$env{'user.name'};   }
                   2662:     return if ($udom eq 'public' && $uname eq 'public');
                   2663:     my $id=$uname.':'.$udom;
                   2664:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2665: }
                   2666: 
1.61      www      2667: # ------------------------------------------------------------------ Screenname
1.81      albertel 2668: 
                   2669: =pod
                   2670: 
1.648     raeburn  2671: =item * &screenname($uname,$udom)
1.81      albertel 2672: 
                   2673: Gets a users screenname and returns it as a string
                   2674: 
                   2675: =cut
1.61      www      2676: 
                   2677: sub screenname {
                   2678:     my ($uname,$udom)=@_;
1.258     albertel 2679:     if ($uname eq $env{'user.name'} &&
                   2680: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2681:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2682:     return $names{'screenname'};
1.62      www      2683: }
                   2684: 
1.212     albertel 2685: 
1.62      www      2686: # ------------------------------------------------------------- Message Wrapper
                   2687: 
                   2688: sub messagewrapper {
1.369     www      2689:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2690:     return 
1.441     albertel 2691:         '<a href="/adm/email?compose=individual&amp;'.
                   2692:         'recname='.$username.'&amp;recdom='.$domain.
                   2693: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2694:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2695: }
                   2696: # --------------------------------------------------------------- Notes Wrapper
                   2697: 
                   2698: sub noteswrapper {
                   2699:     my ($link,$un,$do)=@_;
                   2700:     return 
                   2701: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2702: }
                   2703: # ------------------------------------------------------------- Aboutme Wrapper
                   2704: 
                   2705: sub aboutmewrapper {
1.166     www      2706:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2707:     if (!defined($username)  && !defined($domain)) {
                   2708:         return;
                   2709:     }
1.205     www      2710:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454     banghart 2711: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62      www      2712: }
                   2713: 
                   2714: # ------------------------------------------------------------ Syllabus Wrapper
                   2715: 
                   2716: 
                   2717: sub syllabuswrapper {
1.109     matthew  2718:     my ($linktext,$coursedir,$domain,$fontcolor)=@_;
                   2719:     if ($fontcolor) { 
                   2720:         $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>'; 
                   2721:     }
1.208     matthew  2722:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2723: }
1.14      harris41 2724: 
1.208     matthew  2725: sub track_student_link {
1.268     albertel 2726:     my ($linktext,$sname,$sdom,$target,$start) = @_;
                   2727:     my $link ="/adm/trackstudent?";
1.208     matthew  2728:     my $title = 'View recent activity';
                   2729:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2730:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2731:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2732:         $title .= ' of this student';
1.268     albertel 2733:     } 
1.208     matthew  2734:     if (defined($target) && $target !~ /^\s*$/) {
                   2735:         $target = qq{target="$target"};
                   2736:     } else {
                   2737:         $target = '';
                   2738:     }
1.268     albertel 2739:     if ($start) { $link.='&amp;start='.$start; }
1.554     albertel 2740:     $title = &mt($title);
                   2741:     $linktext = &mt($linktext);
1.448     albertel 2742:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2743: 	&help_open_topic('View_recent_activity');
1.208     matthew  2744: }
                   2745: 
1.508     www      2746: # ===================================================== Display a student photo
                   2747: 
                   2748: 
1.509     albertel 2749: sub student_image_tag {
1.508     www      2750:     my ($domain,$user)=@_;
                   2751:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   2752:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   2753: 	return '<img src="'.$imgsrc.'" align="right" />';
                   2754:     } else {
                   2755: 	return '';
                   2756:     }
                   2757: }
                   2758: 
1.112     bowersj2 2759: =pod
                   2760: 
                   2761: =back
                   2762: 
                   2763: =head1 Access .tab File Data
                   2764: 
                   2765: =over 4
                   2766: 
1.648     raeburn  2767: =item * &languageids() 
1.112     bowersj2 2768: 
                   2769: returns list of all language ids
                   2770: 
                   2771: =cut
                   2772: 
1.14      harris41 2773: sub languageids {
1.16      harris41 2774:     return sort(keys(%language));
1.14      harris41 2775: }
                   2776: 
1.112     bowersj2 2777: =pod
                   2778: 
1.648     raeburn  2779: =item * &languagedescription() 
1.112     bowersj2 2780: 
                   2781: returns description of a specified language id
                   2782: 
                   2783: =cut
                   2784: 
1.14      harris41 2785: sub languagedescription {
1.125     www      2786:     my $code=shift;
                   2787:     return  ($supported_language{$code}?'* ':'').
                   2788:             $language{$code}.
1.126     www      2789: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      2790: }
                   2791: 
                   2792: sub plainlanguagedescription {
                   2793:     my $code=shift;
                   2794:     return $language{$code};
                   2795: }
                   2796: 
                   2797: sub supportedlanguagecode {
                   2798:     my $code=shift;
                   2799:     return $supported_language{$code};
1.97      www      2800: }
                   2801: 
1.112     bowersj2 2802: =pod
                   2803: 
1.648     raeburn  2804: =item * &copyrightids() 
1.112     bowersj2 2805: 
                   2806: returns list of all copyrights
                   2807: 
                   2808: =cut
                   2809: 
                   2810: sub copyrightids {
                   2811:     return sort(keys(%cprtag));
                   2812: }
                   2813: 
                   2814: =pod
                   2815: 
1.648     raeburn  2816: =item * &copyrightdescription() 
1.112     bowersj2 2817: 
                   2818: returns description of a specified copyright id
                   2819: 
                   2820: =cut
                   2821: 
                   2822: sub copyrightdescription {
1.166     www      2823:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 2824: }
1.197     matthew  2825: 
                   2826: =pod
                   2827: 
1.648     raeburn  2828: =item * &source_copyrightids() 
1.192     taceyjo1 2829: 
                   2830: returns list of all source copyrights
                   2831: 
                   2832: =cut
                   2833: 
                   2834: sub source_copyrightids {
                   2835:     return sort(keys(%scprtag));
                   2836: }
                   2837: 
                   2838: =pod
                   2839: 
1.648     raeburn  2840: =item * &source_copyrightdescription() 
1.192     taceyjo1 2841: 
                   2842: returns description of a specified source copyright id
                   2843: 
                   2844: =cut
                   2845: 
                   2846: sub source_copyrightdescription {
                   2847:     return &mt($scprtag{shift(@_)});
                   2848: }
1.112     bowersj2 2849: 
                   2850: =pod
                   2851: 
1.648     raeburn  2852: =item * &filecategories() 
1.112     bowersj2 2853: 
                   2854: returns list of all file categories
                   2855: 
                   2856: =cut
                   2857: 
                   2858: sub filecategories {
                   2859:     return sort(keys(%category_extensions));
                   2860: }
                   2861: 
                   2862: =pod
                   2863: 
1.648     raeburn  2864: =item * &filecategorytypes() 
1.112     bowersj2 2865: 
                   2866: returns list of file types belonging to a given file
                   2867: category
                   2868: 
                   2869: =cut
                   2870: 
                   2871: sub filecategorytypes {
1.356     albertel 2872:     my ($cat) = @_;
                   2873:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 2874: }
                   2875: 
                   2876: =pod
                   2877: 
1.648     raeburn  2878: =item * &fileembstyle() 
1.112     bowersj2 2879: 
                   2880: returns embedding style for a specified file type
                   2881: 
                   2882: =cut
                   2883: 
                   2884: sub fileembstyle {
                   2885:     return $fe{lc(shift(@_))};
1.169     www      2886: }
                   2887: 
1.351     www      2888: sub filemimetype {
                   2889:     return $fm{lc(shift(@_))};
                   2890: }
                   2891: 
1.169     www      2892: 
                   2893: sub filecategoryselect {
                   2894:     my ($name,$value)=@_;
1.189     matthew  2895:     return &select_form($value,$name,
1.169     www      2896: 			'' => &mt('Any category'),
                   2897: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 2898: }
                   2899: 
                   2900: =pod
                   2901: 
1.648     raeburn  2902: =item * &filedescription() 
1.112     bowersj2 2903: 
                   2904: returns description for a specified file type
                   2905: 
                   2906: =cut
                   2907: 
                   2908: sub filedescription {
1.188     matthew  2909:     my $file_description = $fd{lc(shift())};
                   2910:     $file_description =~ s:([\[\]]):~$1:g;
                   2911:     return &mt($file_description);
1.112     bowersj2 2912: }
                   2913: 
                   2914: =pod
                   2915: 
1.648     raeburn  2916: =item * &filedescriptionex() 
1.112     bowersj2 2917: 
                   2918: returns description for a specified file type with
                   2919: extra formatting
                   2920: 
                   2921: =cut
                   2922: 
                   2923: sub filedescriptionex {
                   2924:     my $ex=shift;
1.188     matthew  2925:     my $file_description = $fd{lc($ex)};
                   2926:     $file_description =~ s:([\[\]]):~$1:g;
                   2927:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 2928: }
                   2929: 
                   2930: # End of .tab access
                   2931: =pod
                   2932: 
                   2933: =back
                   2934: 
                   2935: =cut
                   2936: 
                   2937: # ------------------------------------------------------------------ File Types
                   2938: sub fileextensions {
                   2939:     return sort(keys(%fe));
                   2940: }
                   2941: 
1.97      www      2942: # ----------------------------------------------------------- Display Languages
                   2943: # returns a hash with all desired display languages
                   2944: #
                   2945: 
                   2946: sub display_languages {
                   2947:     my %languages=();
1.356     albertel 2948:     foreach my $lang (&preferred_languages()) {
                   2949: 	$languages{$lang}=1;
1.97      www      2950:     }
                   2951:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 2952:     if ($env{'form.displaylanguage'}) {
1.356     albertel 2953: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   2954: 	    $languages{$lang}=1;
1.97      www      2955:         }
                   2956:     }
                   2957:     return %languages;
1.14      harris41 2958: }
                   2959: 
1.117     www      2960: sub preferred_languages {
                   2961:     my @languages=();
1.654     www      2962:     if (($env{'request.role.adv'}) && ($env{'form.languages'})) {
                   2963:         @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$env{'form.languages'}));
                   2964:     }
1.258     albertel 2965:     if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117     www      2966: 	@languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258     albertel 2967: 	         $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177     www      2968:     }
1.654     www      2969: 
1.258     albertel 2970:     if ($env{'environment.languages'}) {
1.459     albertel 2971: 	@languages=(@languages,
                   2972: 		    split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
1.118     www      2973:     }
1.583     albertel 2974:     my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
1.162     www      2975:     if ($browser) {
1.583     albertel 2976: 	my @browser = 
                   2977: 	    map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
                   2978: 	push(@languages,@browser);
1.162     www      2979:     }
1.641     raeburn  2980: 
                   2981:     foreach my $domtype ($env{'user.domain'},$env{'request.role.domain'},
                   2982:                          $Apache::lonnet::perlvar{'lonDefDomain'}) {
                   2983:         if ($domtype ne '') {
                   2984:             my %domdefs = &Apache::lonnet::get_domain_defaults($domtype);
                   2985:             if ($domdefs{'lang_def'} ne '') {
                   2986:                 push(@languages,$domdefs{'lang_def'});
                   2987:             }
                   2988:         }
1.118     www      2989:     }
                   2990: # turn "en-ca" into "en-ca,en"
                   2991:     my @genlanguages;
1.356     albertel 2992:     foreach my $lang (@languages) {
                   2993: 	unless ($lang=~/\w/) { next; }
1.583     albertel 2994: 	push(@genlanguages,$lang);
1.356     albertel 2995: 	if ($lang=~/(\-|\_)/) {
                   2996: 	    push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118     www      2997: 	}
                   2998:     }
1.583     albertel 2999:     #uniqueify the languages list
                   3000:     my %count;
                   3001:     @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
1.118     www      3002:     return @genlanguages;
1.117     www      3003: }
                   3004: 
1.582     albertel 3005: sub languages {
                   3006:     my ($possible_langs) = @_;
                   3007:     my @preferred_langs = &preferred_languages();
                   3008:     if (!ref($possible_langs)) {
                   3009: 	if( wantarray ) {
                   3010: 	    return @preferred_langs;
                   3011: 	} else {
                   3012: 	    return $preferred_langs[0];
                   3013: 	}
                   3014:     }
                   3015:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3016:     my @preferred_possibilities;
                   3017:     foreach my $preferred_lang (@preferred_langs) {
                   3018: 	if (exists($possibilities{$preferred_lang})) {
                   3019: 	    push(@preferred_possibilities, $preferred_lang);
                   3020: 	}
                   3021:     }
                   3022:     if( wantarray ) {
                   3023: 	return @preferred_possibilities;
                   3024:     }
                   3025:     return $preferred_possibilities[0];
                   3026: }
                   3027: 
1.112     bowersj2 3028: ###############################################################
                   3029: ##               Student Answer Attempts                     ##
                   3030: ###############################################################
                   3031: 
                   3032: =pod
                   3033: 
                   3034: =head1 Alternate Problem Views
                   3035: 
                   3036: =over 4
                   3037: 
1.648     raeburn  3038: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3039:     $getattempt, $regexp, $gradesub)
                   3040: 
                   3041: Return string with previous attempt on problem. Arguments:
                   3042: 
                   3043: =over 4
                   3044: 
                   3045: =item * $symb: Problem, including path
                   3046: 
                   3047: =item * $username: username of the desired student
                   3048: 
                   3049: =item * $domain: domain of the desired student
1.14      harris41 3050: 
1.112     bowersj2 3051: =item * $course: Course ID
1.14      harris41 3052: 
1.112     bowersj2 3053: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3054:     something
1.14      harris41 3055: 
1.112     bowersj2 3056: =item * $regexp: if string matches this regexp, the string will be
                   3057:     sent to $gradesub
1.14      harris41 3058: 
1.112     bowersj2 3059: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3060: 
1.112     bowersj2 3061: =back
1.14      harris41 3062: 
1.112     bowersj2 3063: The output string is a table containing all desired attempts, if any.
1.16      harris41 3064: 
1.112     bowersj2 3065: =cut
1.1       albertel 3066: 
                   3067: sub get_previous_attempt {
1.43      ng       3068:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3069:   my $prevattempts='';
1.43      ng       3070:   no strict 'refs';
1.1       albertel 3071:   if ($symb) {
1.3       albertel 3072:     my (%returnhash)=
                   3073:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3074:     if ($returnhash{'version'}) {
                   3075:       my %lasthash=();
                   3076:       my $version;
                   3077:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3078:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3079: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3080:         }
1.1       albertel 3081:       }
1.596     albertel 3082:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3083:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3084:       foreach my $key (sort(keys(%lasthash))) {
                   3085: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3086: 	if ($#parts > 0) {
1.31      albertel 3087: 	  my $data=$parts[-1];
                   3088: 	  pop(@parts);
1.596     albertel 3089: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3090: 	} else {
1.41      ng       3091: 	  if ($#parts == 0) {
                   3092: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3093: 	  } else {
                   3094: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3095: 	  }
1.31      albertel 3096: 	}
1.16      harris41 3097:       }
1.596     albertel 3098:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3099:       if ($getattempt eq '') {
                   3100: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3101: 	  $prevattempts.=&start_data_table_row().
                   3102: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3103: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3104: 		my $value = &format_previous_attempt_value($key,
                   3105: 							   $returnhash{$version.':'.$key});
                   3106: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3107: 	    }
1.596     albertel 3108: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3109: 	 }
1.1       albertel 3110:       }
1.596     albertel 3111:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3112:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3113: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3114: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3115: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3116:       }
1.596     albertel 3117:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3118:     } else {
1.596     albertel 3119:       $prevattempts=
                   3120: 	  &start_data_table().&start_data_table_row().
                   3121: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3122: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3123:     }
                   3124:   } else {
1.596     albertel 3125:     $prevattempts=
                   3126: 	  &start_data_table().&start_data_table_row().
                   3127: 	  '<td>'.&mt('No data.').'</td>'.
                   3128: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3129:   }
1.10      albertel 3130: }
                   3131: 
1.581     albertel 3132: sub format_previous_attempt_value {
                   3133:     my ($key,$value) = @_;
                   3134:     if ($key =~ /timestamp/) {
                   3135: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3136:     } elsif (ref($value) eq 'ARRAY') {
                   3137: 	$value = '('.join(', ', @{ $value }).')';
                   3138:     } else {
                   3139: 	$value = &unescape($value);
                   3140:     }
                   3141:     return $value;
                   3142: }
                   3143: 
                   3144: 
1.107     albertel 3145: sub relative_to_absolute {
                   3146:     my ($url,$output)=@_;
                   3147:     my $parser=HTML::TokeParser->new(\$output);
                   3148:     my $token;
                   3149:     my $thisdir=$url;
                   3150:     my @rlinks=();
                   3151:     while ($token=$parser->get_token) {
                   3152: 	if ($token->[0] eq 'S') {
                   3153: 	    if ($token->[1] eq 'a') {
                   3154: 		if ($token->[2]->{'href'}) {
                   3155: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3156: 		}
                   3157: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3158: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3159: 	    } elsif ($token->[1] eq 'base') {
                   3160: 		$thisdir=$token->[2]->{'href'};
                   3161: 	    }
                   3162: 	}
                   3163:     }
                   3164:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3165:     foreach my $link (@rlinks) {
                   3166: 	unless (($link=~/^http:\/\//i) ||
                   3167: 		($link=~/^\//) ||
                   3168: 		($link=~/^javascript:/i) ||
                   3169: 		($link=~/^mailto:/i) ||
                   3170: 		($link=~/^\#/)) {
                   3171: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3172: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3173: 	}
                   3174:     }
                   3175: # -------------------------------------------------- Deal with Applet codebases
                   3176:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3177:     return $output;
                   3178: }
                   3179: 
1.112     bowersj2 3180: =pod
                   3181: 
1.648     raeburn  3182: =item * &get_student_view()
1.112     bowersj2 3183: 
                   3184: show a snapshot of what student was looking at
                   3185: 
                   3186: =cut
                   3187: 
1.10      albertel 3188: sub get_student_view {
1.186     albertel 3189:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3190:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3191:   my (%form);
1.10      albertel 3192:   my @elements=('symb','courseid','domain','username');
                   3193:   foreach my $element (@elements) {
1.186     albertel 3194:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3195:   }
1.186     albertel 3196:   if (defined($moreenv)) {
                   3197:       %form=(%form,%{$moreenv});
                   3198:   }
1.236     albertel 3199:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3200:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3201:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3202:   $userview=~s/\<body[^\>]*\>//gi;
                   3203:   $userview=~s/\<\/body\>//gi;
                   3204:   $userview=~s/\<html\>//gi;
                   3205:   $userview=~s/\<\/html\>//gi;
                   3206:   $userview=~s/\<head\>//gi;
                   3207:   $userview=~s/\<\/head\>//gi;
                   3208:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3209:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3210:   if (wantarray) {
                   3211:      return ($userview,$response);
                   3212:   } else {
                   3213:      return $userview;
                   3214:   }
                   3215: }
                   3216: 
                   3217: sub get_student_view_with_retries {
                   3218:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3219: 
                   3220:     my $ok = 0;                 # True if we got a good response.
                   3221:     my $content;
                   3222:     my $response;
                   3223: 
                   3224:     # Try to get the student_view done. within the retries count:
                   3225:     
                   3226:     do {
                   3227:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3228:          $ok      = $response->is_success;
                   3229:          if (!$ok) {
                   3230:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3231:          }
                   3232:          $retries--;
                   3233:     } while (!$ok && ($retries > 0));
                   3234:     
                   3235:     if (!$ok) {
                   3236:        $content = '';          # On error return an empty content.
                   3237:     }
1.651     www      3238:     if (wantarray) {
                   3239:        return ($content, $response);
                   3240:     } else {
                   3241:        return $content;
                   3242:     }
1.11      albertel 3243: }
                   3244: 
1.112     bowersj2 3245: =pod
                   3246: 
1.648     raeburn  3247: =item * &get_student_answers() 
1.112     bowersj2 3248: 
                   3249: show a snapshot of how student was answering problem
                   3250: 
                   3251: =cut
                   3252: 
1.11      albertel 3253: sub get_student_answers {
1.100     sakharuk 3254:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3255:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3256:   my (%moreenv);
1.11      albertel 3257:   my @elements=('symb','courseid','domain','username');
                   3258:   foreach my $element (@elements) {
1.186     albertel 3259:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3260:   }
1.186     albertel 3261:   $moreenv{'grade_target'}='answer';
                   3262:   %moreenv=(%form,%moreenv);
1.497     raeburn  3263:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3264:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3265:   return $userview;
1.1       albertel 3266: }
1.116     albertel 3267: 
                   3268: =pod
                   3269: 
                   3270: =item * &submlink()
                   3271: 
1.242     albertel 3272: Inputs: $text $uname $udom $symb $target
1.116     albertel 3273: 
                   3274: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3275: 
                   3276: =cut
                   3277: 
                   3278: ###############################################
                   3279: sub submlink {
1.242     albertel 3280:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3281:     if (!($uname && $udom)) {
                   3282: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3283: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3284: 	if (!$symb) { $symb=$cursymb; }
                   3285:     }
1.254     matthew  3286:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3287:     $symb=&escape($symb);
1.242     albertel 3288:     if ($target) { $target="target=\"$target\""; }
                   3289:     return '<a href="/adm/grades?&command=submission&'.
                   3290: 	'symb='.$symb.'&student='.$uname.
                   3291: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3292: }
                   3293: ##############################################
                   3294: 
                   3295: =pod
                   3296: 
                   3297: =item * &pgrdlink()
                   3298: 
                   3299: Inputs: $text $uname $udom $symb $target
                   3300: 
                   3301: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3302: 
                   3303: =cut
                   3304: 
                   3305: ###############################################
                   3306: sub pgrdlink {
                   3307:     my $link=&submlink(@_);
                   3308:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3309:     return $link;
                   3310: }
                   3311: ##############################################
                   3312: 
                   3313: =pod
                   3314: 
                   3315: =item * &pprmlink()
                   3316: 
                   3317: Inputs: $text $uname $udom $symb $target
                   3318: 
                   3319: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3320: student and a specific resource
1.242     albertel 3321: 
                   3322: =cut
                   3323: 
                   3324: ###############################################
                   3325: sub pprmlink {
                   3326:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3327:     if (!($uname && $udom)) {
                   3328: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3329: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3330: 	if (!$symb) { $symb=$cursymb; }
                   3331:     }
1.254     matthew  3332:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3333:     $symb=&escape($symb);
1.242     albertel 3334:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3335:     return '<a href="/adm/parmset?command=set&amp;'.
                   3336: 	'symb='.$symb.'&amp;uname='.$uname.
                   3337: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3338: }
                   3339: ##############################################
1.37      matthew  3340: 
1.112     bowersj2 3341: =pod
                   3342: 
                   3343: =back
                   3344: 
                   3345: =cut
                   3346: 
1.37      matthew  3347: ###############################################
1.51      www      3348: 
                   3349: 
                   3350: sub timehash {
                   3351:     my @ltime=localtime(shift);
                   3352:     return ( 'seconds' => $ltime[0],
                   3353:              'minutes' => $ltime[1],
                   3354:              'hours'   => $ltime[2],
                   3355:              'day'     => $ltime[3],
                   3356:              'month'   => $ltime[4]+1,
                   3357:              'year'    => $ltime[5]+1900,
                   3358:              'weekday' => $ltime[6],
                   3359:              'dayyear' => $ltime[7]+1,
                   3360:              'dlsav'   => $ltime[8] );
                   3361: }
                   3362: 
1.370     www      3363: sub utc_string {
                   3364:     my ($date)=@_;
1.371     www      3365:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3366: }
                   3367: 
1.51      www      3368: sub maketime {
                   3369:     my %th=@_;
                   3370:     return POSIX::mktime(
                   3371:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3372:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3373: }
                   3374: 
                   3375: #########################################
1.51      www      3376: 
                   3377: sub findallcourses {
1.482     raeburn  3378:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3379:     my %roles;
                   3380:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3381:     my %courses;
1.51      www      3382:     my $now=time;
1.482     raeburn  3383:     if (!defined($uname)) {
                   3384:         $uname = $env{'user.name'};
                   3385:     }
                   3386:     if (!defined($udom)) {
                   3387:         $udom = $env{'user.domain'};
                   3388:     }
                   3389:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3390:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3391:         if (!%roles) {
                   3392:             %roles = (
                   3393:                        cc => 1,
                   3394:                        in => 1,
                   3395:                        ep => 1,
                   3396:                        ta => 1,
                   3397:                        cr => 1,
                   3398:                        st => 1,
                   3399:              );
                   3400:         }
                   3401:         foreach my $entry (keys(%roleshash)) {
                   3402:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3403:             if ($trole =~ /^cr/) { 
                   3404:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3405:             } else {
                   3406:                 next if (!exists($roles{$trole}));
                   3407:             }
                   3408:             if ($tend) {
                   3409:                 next if ($tend < $now);
                   3410:             }
                   3411:             if ($tstart) {
                   3412:                 next if ($tstart > $now);
                   3413:             }
                   3414:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3415:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3416:             if ($secpart eq '') {
                   3417:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3418:                 $sec = 'none';
                   3419:                 $realsec = '';
                   3420:             } else {
                   3421:                 $cnum = $cnumpart;
                   3422:                 ($sec,$role) = split(/_/,$secpart);
                   3423:                 $realsec = $sec;
1.490     raeburn  3424:             }
1.482     raeburn  3425:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3426:         }
                   3427:     } else {
                   3428:         foreach my $key (keys(%env)) {
1.483     albertel 3429: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3430:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3431: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3432: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3433: 	        next if (%roles && !exists($roles{$role}));
                   3434: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3435:                 my $active=1;
                   3436:                 if ($starttime) {
                   3437: 		    if ($now<$starttime) { $active=0; }
                   3438:                 }
                   3439:                 if ($endtime) {
                   3440:                     if ($now>$endtime) { $active=0; }
                   3441:                 }
                   3442:                 if ($active) {
                   3443:                     if ($sec eq '') {
                   3444:                         $sec = 'none';
                   3445:                     }
                   3446:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3447:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3448:                 }
                   3449:             }
1.51      www      3450:         }
                   3451:     }
1.474     raeburn  3452:     return %courses;
1.51      www      3453: }
1.37      matthew  3454: 
1.54      www      3455: ###############################################
1.474     raeburn  3456: 
                   3457: sub blockcheck {
1.482     raeburn  3458:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3459: 
                   3460:     if (!defined($udom)) {
                   3461:         $udom = $env{'user.domain'};
                   3462:     }
                   3463:     if (!defined($uname)) {
                   3464:         $uname = $env{'user.name'};
                   3465:     }
                   3466: 
                   3467:     # If uname and udom are for a course, check for blocks in the course.
                   3468: 
                   3469:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3470:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3471:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3472:         return ($startblock,$endblock);
                   3473:     }
1.474     raeburn  3474: 
1.502     raeburn  3475:     my $startblock = 0;
                   3476:     my $endblock = 0;
1.482     raeburn  3477:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3478: 
1.490     raeburn  3479:     # If uname is for a user, and activity is course-specific, i.e.,
                   3480:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3481: 
1.490     raeburn  3482:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3483:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3484:         foreach my $key (keys(%live_courses)) {
                   3485:             if ($key ne $env{'request.course.id'}) {
                   3486:                 delete($live_courses{$key});
                   3487:             }
                   3488:         }
                   3489:     }
                   3490: 
                   3491:     my $otheruser = 0;
                   3492:     my %own_courses;
                   3493:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3494:         # Resource belongs to user other than current user.
                   3495:         $otheruser = 1;
                   3496:         # Gather courses for current user
                   3497:         %own_courses = 
                   3498:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3499:     }
                   3500: 
                   3501:     # Gather active course roles - course coordinator, instructor, 
                   3502:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3503: 
                   3504:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3505:         my ($cdom,$cnum);
                   3506:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3507:             $cdom = $env{'course.'.$course.'.domain'};
                   3508:             $cnum = $env{'course.'.$course.'.num'};
                   3509:         } else {
1.490     raeburn  3510:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3511:         }
                   3512:         my $no_ownblock = 0;
                   3513:         my $no_userblock = 0;
1.533     raeburn  3514:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3515:             # Check if current user has 'evb' priv for this
                   3516:             if (defined($own_courses{$course})) {
                   3517:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3518:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3519:                     if ($sec ne 'none') {
                   3520:                         $checkrole .= '/'.$sec;
                   3521:                     }
                   3522:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3523:                         $no_ownblock = 1;
                   3524:                         last;
                   3525:                     }
                   3526:                 }
                   3527:             }
                   3528:             # if they have 'evb' priv and are currently not playing student
                   3529:             next if (($no_ownblock) &&
                   3530:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3531:         }
1.474     raeburn  3532:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3533:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3534:             if ($sec ne 'none') {
1.482     raeburn  3535:                 $checkrole .= '/'.$sec;
1.474     raeburn  3536:             }
1.490     raeburn  3537:             if ($otheruser) {
                   3538:                 # Resource belongs to user other than current user.
                   3539:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3540:                 my ($trole,$tdom,$tnum,$tsec);
                   3541:                 my $entry = $live_courses{$course}{$sec};
                   3542:                 if ($entry =~ /^cr/) {
                   3543:                     ($trole,$tdom,$tnum,$tsec) = 
                   3544:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3545:                 } else {
                   3546:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3547:                 }
                   3548:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3549:                 $area = '/'.$tdom.'/'.$tnum;
                   3550:                 $trest = $tnum;
                   3551:                 if ($tsec ne '') {
                   3552:                     $area .= '/'.$tsec;
                   3553:                     $trest .= '/'.$tsec;
                   3554:                 }
                   3555:                 $spec = $trole.'.'.$area;
                   3556:                 if ($trole =~ /^cr/) {
                   3557:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3558:                                                       $tdom,$spec,$trest,$area);
                   3559:                 } else {
                   3560:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3561:                                                        $tdom,$spec,$trest,$area);
                   3562:                 }
                   3563:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3564:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3565:                     if ($1) {
                   3566:                         $no_userblock = 1;
                   3567:                         last;
                   3568:                     }
                   3569:                 }
1.490     raeburn  3570:             } else {
                   3571:                 # Resource belongs to current user
                   3572:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3573:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3574:                     $no_ownblock = 1;
                   3575:                     last;
                   3576:                 }
1.474     raeburn  3577:             }
                   3578:         }
                   3579:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3580:         next if (($no_ownblock) &&
1.491     albertel 3581:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3582:         next if ($no_userblock);
1.474     raeburn  3583: 
1.490     raeburn  3584:         # Retrieve blocking times and identity of blocker for course
                   3585:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3586:         
                   3587:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3588:         if (($start != 0) && 
                   3589:             (($startblock == 0) || ($startblock > $start))) {
                   3590:             $startblock = $start;
                   3591:         }
                   3592:         if (($end != 0)  &&
                   3593:             (($endblock == 0) || ($endblock < $end))) {
                   3594:             $endblock = $end;
                   3595:         }
1.490     raeburn  3596:     }
                   3597:     return ($startblock,$endblock);
                   3598: }
                   3599: 
                   3600: sub get_blocks {
                   3601:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3602:     my $startblock = 0;
                   3603:     my $endblock = 0;
                   3604:     my $course = $cdom.'_'.$cnum;
                   3605:     $setters->{$course} = {};
                   3606:     $setters->{$course}{'staff'} = [];
                   3607:     $setters->{$course}{'times'} = [];
                   3608:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3609:     foreach my $record (keys(%records)) {
                   3610:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3611:         if ($start <= time && $end >= time) {
                   3612:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3613:                 &parse_block_record($records{$record});
                   3614:             if ($blocks->{$activity} eq 'on') {
                   3615:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3616:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3617:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3618:                     $startblock = $start;
1.490     raeburn  3619:                 }
1.491     albertel 3620:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3621:                     $endblock = $end;
1.474     raeburn  3622:                 }
                   3623:             }
                   3624:         }
                   3625:     }
                   3626:     return ($startblock,$endblock);
                   3627: }
                   3628: 
                   3629: sub parse_block_record {
                   3630:     my ($record) = @_;
                   3631:     my ($setuname,$setudom,$title,$blocks);
                   3632:     if (ref($record) eq 'HASH') {
                   3633:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3634:         $title = &unescape($record->{'event'});
                   3635:         $blocks = $record->{'blocks'};
                   3636:     } else {
                   3637:         my @data = split(/:/,$record,3);
                   3638:         if (scalar(@data) eq 2) {
                   3639:             $title = $data[1];
                   3640:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3641:         } else {
                   3642:             ($setuname,$setudom,$title) = @data;
                   3643:         }
                   3644:         $blocks = { 'com' => 'on' };
                   3645:     }
                   3646:     return ($setuname,$setudom,$title,$blocks);
                   3647: }
                   3648: 
                   3649: sub build_block_table {
                   3650:     my ($startblock,$endblock,$setters) = @_;
                   3651:     my %lt = &Apache::lonlocal::texthash(
                   3652:         'cacb' => 'Currently active communication blocks',
                   3653:         'cour' => 'Course',
                   3654:         'dura' => 'Duration',
                   3655:         'blse' => 'Block set by'
                   3656:     );
                   3657:     my $output;
1.476     raeburn  3658:     $output = '<br />'.$lt{'cacb'}.':<br />';
1.474     raeburn  3659:     $output .= &start_data_table();
                   3660:     $output .= '
                   3661: <tr>
                   3662:  <th>'.$lt{'cour'}.'</th>
                   3663:  <th>'.$lt{'dura'}.'</th>
                   3664:  <th>'.$lt{'blse'}.'</th>
                   3665: </tr>
                   3666: ';
                   3667:     foreach my $course (keys(%{$setters})) {
                   3668:         my %courseinfo=&Apache::lonnet::coursedescription($course);
                   3669:         for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
                   3670:             my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490     raeburn  3671:             my $fullname = &plainname($uname,$udom);
                   3672:             if (defined($env{'user.name'}) && defined($env{'user.domain'})
                   3673:                 && $env{'user.name'} ne 'public' 
                   3674:                 && $env{'user.domain'} ne 'public') {
                   3675:                 $fullname = &aboutmewrapper($fullname,$uname,$udom);
                   3676:             }
1.474     raeburn  3677:             my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
                   3678:             $openblock = &Apache::lonlocal::locallocaltime($openblock);
                   3679:             $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
                   3680:             $output .= &Apache::loncommon::start_data_table_row().
                   3681:                        '<td>'.$courseinfo{'description'}.'</td>'.
                   3682:                        '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490     raeburn  3683:                        '<td>'.$fullname.'</td>'.
1.474     raeburn  3684:                         &Apache::loncommon::end_data_table_row();
                   3685:         }
                   3686:     }
                   3687:     $output .= &end_data_table();
                   3688: }
                   3689: 
1.490     raeburn  3690: sub blocking_status {
                   3691:     my ($activity,$uname,$udom) = @_;
                   3692:     my %setters;
                   3693:     my ($blocked,$output,$ownitem,$is_course);
                   3694:     my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3695:     if ($startblock && $endblock) {
                   3696:         $blocked = 1;
                   3697:         if (wantarray) {
                   3698:             my $category;
                   3699:             if ($activity eq 'boards') {
                   3700:                 $category = 'Discussion posts in this course';
                   3701:             } elsif ($activity eq 'blogs') {
                   3702:                 $category = 'Blogs';
                   3703:             } elsif ($activity eq 'port') {
                   3704:                 if (defined($uname) && defined($udom)) {
                   3705:                     if ($uname eq $env{'user.name'} &&
                   3706:                         $udom eq $env{'user.domain'}) {
                   3707:                         $ownitem = 1;
                   3708:                     }
                   3709:                 }
                   3710:                 $is_course = &Apache::lonnet::is_course($udom,$uname);
                   3711:                 if ($ownitem) { 
                   3712:                     $category = 'Your portfolio files';  
                   3713:                 } elsif ($is_course) {
                   3714:                     my $coursedesc;
                   3715:                     foreach my $course (keys(%setters)) {
                   3716:                         my %courseinfo =
                   3717:                              &Apache::lonnet::coursedescription($course);
                   3718:                         $coursedesc = $courseinfo{'description'};
                   3719:                     }
                   3720:                     $category = "Group files in the course '$coursedesc'";
                   3721:                 } else {
                   3722:                     $category = 'Portfolio files belonging to ';
                   3723:                     if ($env{'user.name'} eq 'public' && 
                   3724:                         $env{'user.domain'} eq 'public') {
                   3725:                         $category .= &plainname($uname,$udom);
                   3726:                     } else {
                   3727:                         $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);  
                   3728:                     }
                   3729:                 }
                   3730:             } elsif ($activity eq 'groups') {
                   3731:                 $category = 'Groups in this course';
                   3732:             }
                   3733:             my $showstart = &Apache::lonlocal::locallocaltime($startblock);
                   3734:             my $showend = &Apache::lonlocal::locallocaltime($endblock);
                   3735:             $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
                   3736:             if (!($activity eq 'port' && !($ownitem) && !($is_course))) { 
                   3737:                 $output .= &build_block_table($startblock,$endblock,\%setters);
                   3738:             }
                   3739:         }
                   3740:     }
                   3741:     if (wantarray) {
                   3742:         return ($blocked,$output);
                   3743:     } else {
                   3744:         return $blocked;
                   3745:     }
                   3746: }
                   3747: 
1.60      matthew  3748: ###############################################
                   3749: 
1.682     raeburn  3750: sub check_ip_acc {
                   3751:     my ($acc)=@_;
                   3752:     &Apache::lonxml::debug("acc is $acc");
                   3753:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3754:         return 1;
                   3755:     }
                   3756:     my $allowed=0;
                   3757:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3758: 
                   3759:     my $name;
                   3760:     foreach my $pattern (split(',',$acc)) {
                   3761:         $pattern =~ s/^\s*//;
                   3762:         $pattern =~ s/\s*$//;
                   3763:         if ($pattern =~ /\*$/) {
                   3764:             #35.8.*
                   3765:             $pattern=~s/\*//;
                   3766:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3767:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3768:             #35.8.3.[34-56]
                   3769:             my $low=$2;
                   3770:             my $high=$3;
                   3771:             $pattern=$1;
                   3772:             if ($ip =~ /^\Q$pattern\E/) {
                   3773:                 my $last=(split(/\./,$ip))[3];
                   3774:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3775:             }
                   3776:         } elsif ($pattern =~ /^\*/) {
                   3777:             #*.msu.edu
                   3778:             $pattern=~s/\*//;
                   3779:             if (!defined($name)) {
                   3780:                 use Socket;
                   3781:                 my $netaddr=inet_aton($ip);
                   3782:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3783:             }
                   3784:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3785:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   3786:             #127.0.0.1
                   3787:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3788:         } else {
                   3789:             #some.name.com
                   3790:             if (!defined($name)) {
                   3791:                 use Socket;
                   3792:                 my $netaddr=inet_aton($ip);
                   3793:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   3794:             }
                   3795:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   3796:         }
                   3797:         if ($allowed) { last; }
                   3798:     }
                   3799:     return $allowed;
                   3800: }
                   3801: 
                   3802: ###############################################
                   3803: 
1.60      matthew  3804: =pod
                   3805: 
1.112     bowersj2 3806: =head1 Domain Template Functions
                   3807: 
                   3808: =over 4
                   3809: 
                   3810: =item * &determinedomain()
1.60      matthew  3811: 
                   3812: Inputs: $domain (usually will be undef)
                   3813: 
1.63      www      3814: Returns: Determines which domain should be used for designs
1.60      matthew  3815: 
                   3816: =cut
1.54      www      3817: 
1.60      matthew  3818: ###############################################
1.63      www      3819: sub determinedomain {
                   3820:     my $domain=shift;
1.531     albertel 3821:     if (! $domain) {
1.60      matthew  3822:         # Determine domain if we have not been given one
                   3823:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 3824:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   3825:         if ($env{'request.role.domain'}) { 
                   3826:             $domain=$env{'request.role.domain'}; 
1.60      matthew  3827:         }
                   3828:     }
1.63      www      3829:     return $domain;
                   3830: }
                   3831: ###############################################
1.517     raeburn  3832: 
1.518     albertel 3833: sub devalidate_domconfig_cache {
                   3834:     my ($udom)=@_;
                   3835:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   3836: }
                   3837: 
                   3838: # ---------------------- Get domain configuration for a domain
                   3839: sub get_domainconf {
                   3840:     my ($udom) = @_;
                   3841:     my $cachetime=1800;
                   3842:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   3843:     if (defined($cached)) { return %{$result}; }
                   3844: 
                   3845:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   3846: 					     ['login','rolecolors'],$udom);
1.632     raeburn  3847:     my (%designhash,%legacy);
1.518     albertel 3848:     if (keys(%domconfig) > 0) {
                   3849:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  3850:             if (keys(%{$domconfig{'login'}})) {
                   3851:                 foreach my $key (keys(%{$domconfig{'login'}})) {
                   3852:                     $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   3853:                 }
                   3854:             } else {
                   3855:                 $legacy{'login'} = 1;
1.518     albertel 3856:             }
1.632     raeburn  3857:         } else {
                   3858:             $legacy{'login'} = 1;
1.518     albertel 3859:         }
                   3860:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  3861:             if (keys(%{$domconfig{'rolecolors'}})) {
                   3862:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   3863:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   3864:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   3865:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   3866:                         }
1.518     albertel 3867:                     }
                   3868:                 }
1.632     raeburn  3869:             } else {
                   3870:                 $legacy{'rolecolors'} = 1;
1.518     albertel 3871:             }
1.632     raeburn  3872:         } else {
                   3873:             $legacy{'rolecolors'} = 1;
1.518     albertel 3874:         }
1.632     raeburn  3875:         if (keys(%legacy) > 0) {
                   3876:             my %legacyhash = &get_legacy_domconf($udom);
                   3877:             foreach my $item (keys(%legacyhash)) {
                   3878:                 if ($item =~ /^\Q$udom\E\.login/) {
                   3879:                     if ($legacy{'login'}) { 
                   3880:                         $designhash{$item} = $legacyhash{$item};
                   3881:                     }
                   3882:                 } else {
                   3883:                     if ($legacy{'rolecolors'}) {
                   3884:                         $designhash{$item} = $legacyhash{$item};
                   3885:                     }
1.518     albertel 3886:                 }
                   3887:             }
                   3888:         }
1.632     raeburn  3889:     } else {
                   3890:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 3891:     }
                   3892:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   3893: 				  $cachetime);
                   3894:     return %designhash;
                   3895: }
                   3896: 
1.632     raeburn  3897: sub get_legacy_domconf {
                   3898:     my ($udom) = @_;
                   3899:     my %legacyhash;
                   3900:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   3901:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   3902:     if (-e $designfile) {
                   3903:         if ( open (my $fh,"<$designfile") ) {
                   3904:             while (my $line = <$fh>) {
                   3905:                 next if ($line =~ /^\#/);
                   3906:                 chomp($line);
                   3907:                 my ($key,$val)=(split(/\=/,$line));
                   3908:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   3909:             }
                   3910:             close($fh);
                   3911:         }
                   3912:     }
                   3913:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   3914:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   3915:     }
                   3916:     return %legacyhash;
                   3917: }
                   3918: 
1.63      www      3919: =pod
                   3920: 
1.112     bowersj2 3921: =item * &domainlogo()
1.63      www      3922: 
                   3923: Inputs: $domain (usually will be undef)
                   3924: 
                   3925: Returns: A link to a domain logo, if the domain logo exists.
                   3926: If the domain logo does not exist, a description of the domain.
                   3927: 
                   3928: =cut
1.112     bowersj2 3929: 
1.63      www      3930: ###############################################
                   3931: sub domainlogo {
1.517     raeburn  3932:     my $domain = &determinedomain(shift);
1.518     albertel 3933:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  3934:     # See if there is a logo
                   3935:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  3936:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 3937:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   3938: 	    if ($imgsrc =~ m{^/res/}) {
                   3939: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   3940: 		&Apache::lonnet::repcopy($local_name);
                   3941: 	    }
                   3942: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  3943:         } 
                   3944:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 3945:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   3946:         return &Apache::lonnet::domain($domain,'description');
1.59      www      3947:     } else {
1.60      matthew  3948:         return '';
1.59      www      3949:     }
                   3950: }
1.63      www      3951: ##############################################
                   3952: 
                   3953: =pod
                   3954: 
1.112     bowersj2 3955: =item * &designparm()
1.63      www      3956: 
                   3957: Inputs: $which parameter; $domain (usually will be undef)
                   3958: 
                   3959: Returns: value of designparamter $which
                   3960: 
                   3961: =cut
1.112     bowersj2 3962: 
1.397     albertel 3963: 
1.400     albertel 3964: ##############################################
1.397     albertel 3965: sub designparm {
                   3966:     my ($which,$domain)=@_;
1.258     albertel 3967:     if ($env{'browser.blackwhite'} eq 'on') {
1.635     raeburn  3968: 	if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110     www      3969: 	    return '#000000';
                   3970: 	}
1.635     raeburn  3971: 	if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110     www      3972: 	    return '#FFFFFF';
                   3973: 	}
                   3974: 	if ($which=~/\.tabbg$/) {
                   3975: 	    return '#CCCCCC';
                   3976: 	}
                   3977:     }
1.397     albertel 3978:     if (exists($env{'environment.color.'.$which})) {
1.258     albertel 3979: 	return $env{'environment.color.'.$which};
1.96      www      3980:     }
1.63      www      3981:     $domain=&determinedomain($domain);
1.518     albertel 3982:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  3983:     my $output;
1.517     raeburn  3984:     if ($domdesign{$domain.'.'.$which} ne '') {
1.520     raeburn  3985: 	$output = $domdesign{$domain.'.'.$which};
1.63      www      3986:     } else {
1.520     raeburn  3987:         $output = $defaultdesign{$which};
                   3988:     }
                   3989:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  3990:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 3991:         if ($output =~ m{^/(adm|res)/}) {
                   3992: 	    if ($output =~ m{^/res/}) {
                   3993: 		my $local_name = &Apache::lonnet::filelocation('',$output);
                   3994: 		&Apache::lonnet::repcopy($local_name);
                   3995: 	    }
1.520     raeburn  3996:             $output = &lonhttpdurl($output);
                   3997:         }
1.63      www      3998:     }
1.520     raeburn  3999:     return $output;
1.63      www      4000: }
1.59      www      4001: 
1.60      matthew  4002: ###############################################
                   4003: ###############################################
                   4004: 
                   4005: =pod
                   4006: 
1.112     bowersj2 4007: =back
                   4008: 
1.549     albertel 4009: =head1 HTML Helpers
1.112     bowersj2 4010: 
                   4011: =over 4
                   4012: 
                   4013: =item * &bodytag()
1.60      matthew  4014: 
                   4015: Returns a uniform header for LON-CAPA web pages.
                   4016: 
                   4017: Inputs: 
                   4018: 
1.112     bowersj2 4019: =over 4
                   4020: 
                   4021: =item * $title, A title to be displayed on the page.
                   4022: 
                   4023: =item * $function, the current role (can be undef).
                   4024: 
                   4025: =item * $addentries, extra parameters for the <body> tag.
                   4026: 
                   4027: =item * $bodyonly, if defined, only return the <body> tag.
                   4028: 
                   4029: =item * $domain, if defined, force a given domain.
                   4030: 
                   4031: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4032:             text interface only)
1.60      matthew  4033: 
1.326     albertel 4034: =item * $customtitle, alternate text to use instead of $title
                   4035:                       in the title box that appears, this text
                   4036:                       is not auto translated like the $title is
1.309     albertel 4037: 
                   4038: =item * $notopbar, if true, keep the 'what is this' info but remove the
                   4039:                    navigational links
1.317     albertel 4040: 
1.338     albertel 4041: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4042: 
                   4043: =item * $notitle, if true keep the nav controls, but remove the title bar
                   4044: 
1.361     albertel 4045: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4046:          'Switch To Inline Menu' link
                   4047: 
1.460     albertel 4048: =item * $args, optional argument valid values are
                   4049:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4050:             inherit_jsmath -> when creating popup window in a page,
                   4051:                               should it have jsmath forced on by the
                   4052:                               current page
1.460     albertel 4053: 
1.112     bowersj2 4054: =back
                   4055: 
1.60      matthew  4056: Returns: A uniform header for LON-CAPA web pages.  
                   4057: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4058: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4059: other decorations will be returned.
                   4060: 
                   4061: =cut
                   4062: 
1.54      www      4063: sub bodytag {
1.309     albertel 4064:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460     albertel 4065: 	$notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339     albertel 4066: 
1.460     albertel 4067:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4068: 
1.183     matthew  4069:     $function = &get_users_function() if (!$function);
1.339     albertel 4070:     my $img =    &designparm($function.'.img',$domain);
                   4071:     my $font =   &designparm($function.'.font',$domain);
                   4072:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4073: 
                   4074:     my %design = ( 'style'   => 'margin-top: 0px',
1.535     albertel 4075: 		   'bgcolor' => $pgbg,
1.339     albertel 4076: 		   'text'    => $font,
                   4077:                    'alink'   => &designparm($function.'.alink',$domain),
                   4078: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4079: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4080:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4081: 
1.63      www      4082:  # role and realm
1.378     raeburn  4083:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4084:     if ($role  eq 'ca') {
1.479     albertel 4085:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4086:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4087:     } 
1.55      www      4088: # realm
1.258     albertel 4089:     if ($env{'request.course.id'}) {
1.378     raeburn  4090:         if ($env{'request.role'} !~ /^cr/) {
                   4091:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4092:         }
1.359     albertel 4093: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4094:     } else {
                   4095:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4096:     }
1.433     albertel 4097: 
1.359     albertel 4098:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4099: # Set messages
1.60      matthew  4100:     my $messages=&domainlogo($domain);
1.330     albertel 4101: 
1.438     albertel 4102:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4103: 
1.101     www      4104: # construct main body tag
1.359     albertel 4105:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4106: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4107: 
1.530     albertel 4108:     if ($bodyonly) {
1.60      matthew  4109:         return $bodytag;
1.258     albertel 4110:     } elsif ($env{'browser.interface'} eq 'textual') {
1.95      www      4111: # Accessibility
1.224     raeburn  4112:           
1.337     albertel 4113: 	$bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338     albertel 4114: 	if (!$notitle) {
1.337     albertel 4115: 	    $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
                   4116: 	}
                   4117: 	return $bodytag;
1.359     albertel 4118:     }
                   4119: 
1.410     albertel 4120:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4121:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4122: 	undef($role);
1.434     albertel 4123:     } else {
                   4124: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4125:     }
1.359     albertel 4126:     
                   4127:     my $roleinfo=(<<ENDROLE);
                   4128: <td class="LC_title_bar_who">
                   4129: <div class="LC_title_bar_name">
1.410     albertel 4130:     $name
1.361     albertel 4131:     &nbsp;
1.359     albertel 4132: </div>
                   4133: <div class="LC_title_bar_role">
1.361     albertel 4134: $role&nbsp;
1.359     albertel 4135: </div>
                   4136: <div class="LC_title_bar_realm">
1.361     albertel 4137: $realm&nbsp;
1.359     albertel 4138: </div>
1.206     albertel 4139: </td>
                   4140: ENDROLE
1.235     raeburn  4141: 
1.359     albertel 4142:     my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
                   4143:     if ($customtitle) {
                   4144:         $titleinfo = $customtitle;
                   4145:     }
                   4146:     #
                   4147:     # Extra info if you are the DC
                   4148:     my $dc_info = '';
                   4149:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4150:                         $env{'course.'.$env{'request.course.id'}.
                   4151:                                  '.domain'}.'/'})) {
                   4152:         my $cid = $env{'request.course.id'};
                   4153:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4154:         $dc_info =~ s/\s+$//;
1.359     albertel 4155:         $dc_info = '('.$dc_info.')';
                   4156:     }
                   4157: 
1.644     www      4158:     if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359     albertel 4159:         # No Remote
1.258     albertel 4160: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4161: 	    $forcereg=1;
                   4162: 	}
                   4163: 
                   4164: 	if (!$customtitle && $env{'request.state'} eq 'construct') {
                   4165: 	    # this is for resources; directories have customtitle, and crumbs
                   4166:             # and select recent are created in lonpubdir.pm  
1.229     albertel 4167: 	    my ($uname,$thisdisfn)=
1.258     albertel 4168: 		($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229     albertel 4169: 	    my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4170: 	    $formaction=~s/\/+/\//g;
                   4171: 
1.359     albertel 4172: 	    my $parentpath = '';
                   4173: 	    my $lastitem = '';
                   4174: 	    if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4175: 		$parentpath = $1;
                   4176: 		$lastitem = $2;
                   4177: 	    } else {
                   4178: 		$lastitem = $thisdisfn;
                   4179: 	    }
                   4180: 	    $titleinfo = 
1.640     bisitz   4181: 		&Apache::loncommon::help_open_menu('','',3,'Authoring')
                   4182: 		.'<b>'.&mt('Construction Space').'</b>:&nbsp;'
                   4183: 		.'<form name="dirs" method="post" action="'.$formaction
1.359     albertel 4184: 		.'" target="_top"><tt><b>'
                   4185: 		.&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
                   4186: 		.&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4187: 		.'</form>'
                   4188: 		.&Apache::lonmenu::constspaceform();
1.235     raeburn  4189:         }
1.359     albertel 4190: 
1.337     albertel 4191:         my $titletable;
1.338     albertel 4192: 	if (!$notitle) {
1.337     albertel 4193: 	    $titletable =
1.359     albertel 4194: 		'<table id="LC_title_bar">'.
                   4195:                          "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
                   4196: 			 '</tr></table>';
1.337     albertel 4197: 	}
1.359     albertel 4198: 	if ($notopbar) {
                   4199: 	    $bodytag .= $titletable;
                   4200: 	} else {
                   4201: 	    if ($env{'request.state'} eq 'construct') {
1.337     albertel 4202:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
                   4203: 							  $titletable);
1.272     raeburn  4204:             } else {
1.336     albertel 4205:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359     albertel 4206: 		    $titletable;
1.272     raeburn  4207:             }
1.235     raeburn  4208:         }
                   4209:         return $bodytag;
1.94      www      4210:     }
1.95      www      4211: 
1.93      www      4212: #
1.95      www      4213: # Top frame rendering, Remote is up
1.93      www      4214: #
1.359     albertel 4215: 
1.517     raeburn  4216:     my $imgsrc = $img;
                   4217:     if ($img =~ /^\/adm/) {
1.575     albertel 4218:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4219:     }
                   4220:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4221: 
1.305     www      4222:     # Explicit link to get inline menu
1.361     albertel 4223:     my $menu= ($no_inline_link?''
                   4224: 	       :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245     matthew  4225:     #
1.338     albertel 4226:     if ($notitle) {
1.337     albertel 4227: 	return $bodytag;
                   4228:     }
1.94      www      4229:     return(<<ENDBODY);
1.60      matthew  4230: $bodytag
1.359     albertel 4231: <table id="LC_title_bar" class="LC_with_remote">
1.368     albertel 4232: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359     albertel 4233:     <td class="LC_title_bar_domain_logo">$messages&nbsp;</td>
1.54      www      4234: </tr>
1.359     albertel 4235: <tr><td>$titleinfo $dc_info $menu</td>
                   4236: $roleinfo
1.368     albertel 4237: </tr>
1.356     albertel 4238: </table>
1.54      www      4239: ENDBODY
1.182     matthew  4240: }
                   4241: 
1.330     albertel 4242: sub make_attr_string {
                   4243:     my ($register,$attr_ref) = @_;
                   4244: 
                   4245:     if ($attr_ref && !ref($attr_ref)) {
                   4246: 	die("addentries Must be a hash ref ".
                   4247: 	    join(':',caller(1))." ".
                   4248: 	    join(':',caller(0))." ");
                   4249:     }
                   4250: 
                   4251:     if ($register) {
1.339     albertel 4252: 	my ($on_load,$on_unload);
                   4253: 	foreach my $key (keys(%{$attr_ref})) {
                   4254: 	    if      (lc($key) eq 'onload') {
                   4255: 		$on_load.=$attr_ref->{$key}.';';
                   4256: 		delete($attr_ref->{$key});
                   4257: 
                   4258: 	    } elsif (lc($key) eq 'onunload') {
                   4259: 		$on_unload.=$attr_ref->{$key}.';';
                   4260: 		delete($attr_ref->{$key});
                   4261: 	    }
                   4262: 	}
                   4263: 	$attr_ref->{'onload'}  =
                   4264: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4265: 	$attr_ref->{'onunload'}=
                   4266: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4267:     }
                   4268: 
                   4269: # Accessibility font enhance
                   4270:     if ($env{'browser.fontenhance'} eq 'on') {
                   4271: 	my $style;
                   4272: 	foreach my $key (keys(%{$attr_ref})) {
                   4273: 	    if (lc($key) eq 'style') {
                   4274: 		$style.=$attr_ref->{$key}.';';
                   4275: 		delete($attr_ref->{$key});
                   4276: 	    }
                   4277: 	}
                   4278: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4279:     }
1.339     albertel 4280: 
                   4281:     if ($env{'browser.blackwhite'} eq 'on') {
                   4282: 	delete($attr_ref->{'font'});
                   4283: 	delete($attr_ref->{'link'});
                   4284: 	delete($attr_ref->{'alink'});
                   4285: 	delete($attr_ref->{'vlink'});
                   4286: 	delete($attr_ref->{'bgcolor'});
                   4287: 	delete($attr_ref->{'background'});
                   4288:     }
                   4289: 
1.330     albertel 4290:     my $attr_string;
                   4291:     foreach my $attr (keys(%$attr_ref)) {
                   4292: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4293:     }
                   4294:     return $attr_string;
                   4295: }
                   4296: 
                   4297: 
1.182     matthew  4298: ###############################################
1.251     albertel 4299: ###############################################
                   4300: 
                   4301: =pod
                   4302: 
                   4303: =item * &endbodytag()
                   4304: 
                   4305: Returns a uniform footer for LON-CAPA web pages.
                   4306: 
1.635     raeburn  4307: Inputs: 1 - optional reference to an args hash
                   4308: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4309: a 'Continue' link is not displayed if the page contains an
                   4310: internal redirect in the <head></head> section,
                   4311: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4312: 
                   4313: =cut
                   4314: 
                   4315: sub endbodytag {
1.635     raeburn  4316:     my ($args) = @_;
1.251     albertel 4317:     my $endbodytag='</body>';
1.269     albertel 4318:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4319:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4320:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4321: 	    $endbodytag=
                   4322: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4323: 	        &mt('Continue').'</a>'.
                   4324: 	        $endbodytag;
                   4325:         }
1.315     albertel 4326:     }
1.251     albertel 4327:     return $endbodytag;
                   4328: }
                   4329: 
1.352     albertel 4330: =pod
                   4331: 
                   4332: =item * &standard_css()
                   4333: 
                   4334: Returns a style sheet
                   4335: 
                   4336: Inputs: (all optional)
                   4337:             domain         -> force to color decorate a page for a specific
                   4338:                                domain
                   4339:             function       -> force usage of a specific rolish color scheme
                   4340:             bgcolor        -> override the default page bgcolor
                   4341: 
                   4342: =cut
                   4343: 
1.343     albertel 4344: sub standard_css {
1.345     albertel 4345:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4346:     $function  = &get_users_function() if (!$function);
                   4347:     my $img    = &designparm($function.'.img',   $domain);
                   4348:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4349:     my $font   = &designparm($function.'.font',  $domain);
1.345     albertel 4350:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4351:     my $pgbg_or_bgcolor =
                   4352: 	         $bgcolor ||
1.352     albertel 4353: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4354:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4355:     my $alink  = &designparm($function.'.alink', $domain);
                   4356:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4357:     my $link   = &designparm($function.'.link',  $domain);
                   4358: 
1.602     albertel 4359:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4360:     my $mono                 = 'monospace';
1.352     albertel 4361:     my $data_table_head      = $tabbg;
                   4362:     my $data_table_light     = '#EEEEEE';
1.470     banghart 4363:     my $data_table_dark      = '#DDDDDD';
                   4364:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4365:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4366:     my $mail_new             = '#FFBB77';
                   4367:     my $mail_new_hover       = '#DD9955';
                   4368:     my $mail_read            = '#BBBB77';
                   4369:     my $mail_read_hover      = '#999944';
                   4370:     my $mail_replied         = '#AAAA88';
                   4371:     my $mail_replied_hover   = '#888855';
                   4372:     my $mail_other           = '#99BBBB';
                   4373:     my $mail_other_hover     = '#669999';
1.391     albertel 4374:     my $table_header         = '#DDDDDD';
1.489     raeburn  4375:     my $feedback_link_bg     = '#BBBBBB';
1.392     albertel 4376: 
1.608     albertel 4377:     my $border = ($env{'browser.type'} eq 'explorer' ||
                   4378: 		  $env{'browser.type'} eq 'safari'     ) ? '0px 2px 0px 2px'
                   4379: 	                                                 : '0px 3px 0px 4px';
1.448     albertel 4380: 
1.523     albertel 4381: 
1.343     albertel 4382:     return <<END;
1.345     albertel 4383: h1, h2, h3, th { font-family: $sans }
1.343     albertel 4384: a:focus { color: red; background: yellow } 
1.510     albertel 4385: table.thinborder,
1.523     albertel 4386: 
1.510     albertel 4387: table.thinborder tr th {
                   4388:   border-style: solid;
                   4389:   border-width: 1px;
                   4390:   background: $tabbg;
                   4391: }
1.523     albertel 4392: table.thinborder tr td {
1.510     albertel 4393:   border-style: solid;
                   4394:   border-width: 1px
                   4395: }
1.426     albertel 4396: 
1.343     albertel 4397: form, .inline { display: inline; }
                   4398: .center { text-align: center; }
1.593     albertel 4399: .LC_filename {font-family: $mono; white-space:pre;}
1.350     albertel 4400: .LC_error {
                   4401:   color: red;
                   4402:   font-size: larger;
                   4403: }
1.457     albertel 4404: .LC_warning,
                   4405: .LC_diff_removed {
1.394     albertel 4406:   color: red;
                   4407: }
1.532     albertel 4408: 
                   4409: .LC_info,
1.457     albertel 4410: .LC_success,
                   4411: .LC_diff_added {
1.350     albertel 4412:   color: green;
                   4413: }
1.543     albertel 4414: .LC_unknown {
                   4415:   color: yellow;
                   4416: }
                   4417: 
1.440     albertel 4418: .LC_icon {
                   4419:   border: 0px;
                   4420: }
1.539     albertel 4421: .LC_indexer_icon {
                   4422:   border: 0px;
                   4423:   height: 22px;
                   4424: }
1.543     albertel 4425: .LC_docs_spacer {
                   4426:   width: 25px;
                   4427:   height: 1px;
                   4428:   border: 0px;
                   4429: }
1.346     albertel 4430: 
1.532     albertel 4431: .LC_internal_info {
                   4432:   color: #999;
                   4433: }
                   4434: 
1.458     albertel 4435: table.LC_pastsubmission {
                   4436:   border: 1px solid black;
                   4437:   margin: 2px;
                   4438: }
                   4439: 
1.606     albertel 4440: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345     albertel 4441:   width: 100%;
                   4442:   background: $pgbg;
1.392     albertel 4443:   border: 2px;
1.402     albertel 4444:   border-collapse: separate;
1.403     albertel 4445:   padding: 0px;
1.345     albertel 4446: }
1.392     albertel 4447: 
1.606     albertel 4448: table#LC_title_bar, table.LC_breadcrumbs, 
1.393     albertel 4449: table#LC_title_bar.LC_with_remote {
1.359     albertel 4450:   width: 100%;
1.392     albertel 4451:   border-color: $pgbg;
                   4452:   border-style: solid;
                   4453:   border-width: $border;
                   4454: 
1.379     albertel 4455:   background: $pgbg;
                   4456:   font-family: $sans;
1.392     albertel 4457:   border-collapse: collapse;
1.403     albertel 4458:   padding: 0px;
1.359     albertel 4459: }
1.392     albertel 4460: 
1.409     albertel 4461: table.LC_docs_path {
                   4462:   width: 100%;
                   4463:   border: 0;
                   4464:   background: $pgbg;
                   4465:   font-family: $sans;
                   4466:   border-collapse: collapse;
                   4467:   padding: 0px;
                   4468: }
                   4469: 
1.359     albertel 4470: table#LC_title_bar td {
                   4471:   background: $tabbg;
                   4472: }
                   4473: table#LC_title_bar td.LC_title_bar_who {
                   4474:   background: $tabbg;
                   4475:   color: $font;
1.427     albertel 4476:   font: small $sans;
1.359     albertel 4477:   text-align: right;
                   4478: }
1.469     banghart 4479: span.LC_metadata {
                   4480:     font-family: $sans;
                   4481: }
1.359     albertel 4482: span.LC_title_bar_title {
1.416     albertel 4483:   font: bold x-large $sans;
1.359     albertel 4484: }
                   4485: table#LC_title_bar td.LC_title_bar_domain_logo {
                   4486:   background: $sidebg;
                   4487:   text-align: right;
1.368     albertel 4488:   padding: 0px;
                   4489: }
                   4490: table#LC_title_bar td.LC_title_bar_role_logo {
                   4491:   background: $sidebg;
                   4492:   padding: 0px;
1.359     albertel 4493: }
                   4494: 
1.346     albertel 4495: table#LC_menubuttons_mainmenu {
1.526     www      4496:   width: 100%;
1.346     albertel 4497:   border: 0px;
                   4498:   border-spacing: 1px;
1.372     albertel 4499:   padding: 0px 1px;
1.346     albertel 4500:   margin: 0px;
                   4501:   border-collapse: separate;
                   4502: }
                   4503: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
                   4504:   border: 0px;
                   4505: }
1.345     albertel 4506: table#LC_top_nav td {
                   4507:   background: $tabbg;
1.392     albertel 4508:   border: 0px;
1.407     albertel 4509:   font-size: small;
1.345     albertel 4510: }
                   4511: table#LC_top_nav td a, div#LC_top_nav a {
                   4512:   color: $font;
                   4513:   font-family: $sans;
                   4514: }
1.364     albertel 4515: table#LC_top_nav td.LC_top_nav_logo {
                   4516:   background: $tabbg;
1.432     albertel 4517:   text-align: left;
1.408     albertel 4518:   white-space: nowrap;
1.432     albertel 4519:   width: 31px;
1.408     albertel 4520: }
                   4521: table#LC_top_nav td.LC_top_nav_logo img {
1.432     albertel 4522:   border: 0px;
1.408     albertel 4523:   vertical-align: bottom;
1.364     albertel 4524: }
1.432     albertel 4525: table#LC_top_nav td.LC_top_nav_exit,
                   4526: table#LC_top_nav td.LC_top_nav_help {
                   4527:   width: 2.0em;
                   4528: }
1.442     albertel 4529: table#LC_top_nav td.LC_top_nav_login {
                   4530:   width: 4.0em;
                   4531:   text-align: center;
                   4532: }
1.409     albertel 4533: table.LC_breadcrumbs td, table.LC_docs_path td  {
1.357     albertel 4534:   background: $tabbg;
                   4535:   color: $font;
                   4536:   font-family: $sans;
1.358     albertel 4537:   font-size: smaller;
1.357     albertel 4538: }
1.411     albertel 4539: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409     albertel 4540: table.LC_docs_path td.LC_docs_path_component {
1.357     albertel 4541:   background: $tabbg;
                   4542:   color: $font;
                   4543:   font-family: $sans;
                   4544:   font-size: larger;
                   4545:   text-align: right;
                   4546: }
1.383     albertel 4547: td.LC_table_cell_checkbox {
                   4548:   text-align: center;
                   4549: }
1.522     albertel 4550: table#LC_mainmenu td.LC_mainmenu_column {
                   4551:     vertical-align: top;
                   4552: }
                   4553: 
1.346     albertel 4554: .LC_menubuttons_inline_text {
                   4555:   color: $font;
                   4556:   font-family: $sans;
                   4557:   font-size: smaller;
                   4558: }
                   4559: 
1.526     www      4560: .LC_menubuttons_link {
                   4561:   text-decoration: none;
                   4562: }
1.680     riegler  4563: #2008--9-5: new menu style sheet.Changed category
1.522     albertel 4564: .LC_menubuttons_category {
1.521     www      4565:   color: $font;
1.526     www      4566:   background: $pgbg;
1.521     www      4567:   font-family: $sans;
                   4568:   font-size: larger;
                   4569:   font-weight: bold;
                   4570: }
                   4571: 
1.346     albertel 4572: td.LC_menubuttons_text {
1.526     www      4573:   width: 90%;
1.346     albertel 4574:   color: $font;
                   4575:   font-family: $sans;
                   4576: }
1.526     www      4577: 
1.346     albertel 4578: td.LC_menubuttons_img {
                   4579: }
1.526     www      4580: 
1.346     albertel 4581: .LC_current_location {
                   4582:   font-family: $sans;
                   4583:   background: $tabbg;
                   4584: }
                   4585: .LC_new_mail {
                   4586:   font-family: $sans;
1.634     www      4587:   background: $tabbg;
1.346     albertel 4588:   font-weight: bold;
                   4589: }
1.347     albertel 4590: 
1.526     www      4591: .LC_rolesmenu_is {
                   4592:   font-family: $sans;
                   4593: }
                   4594: 
                   4595: .LC_rolesmenu_selected {
                   4596:   font-family: $sans;
                   4597: }
                   4598: 
                   4599: .LC_rolesmenu_future {
                   4600:   font-family: $sans;
                   4601: }
                   4602: 
                   4603: 
                   4604: .LC_rolesmenu_will {
                   4605:   font-family: $sans;
                   4606: }
                   4607: 
                   4608: .LC_rolesmenu_will_not {
                   4609:   font-family: $sans;
                   4610: }
                   4611: 
                   4612: .LC_rolesmenu_expired {
                   4613:   font-family: $sans;
                   4614: }
                   4615: 
                   4616: .LC_rolesinfo {
                   4617:   font-family: $sans;
                   4618: }
                   4619: 
1.527     www      4620: .LC_dropadd_labeltext {
                   4621:   font-family: $sans;
                   4622:   text-align: right;
                   4623: }
                   4624: 
                   4625: .LC_preferences_labeltext {
                   4626:   font-family: $sans;
                   4627:   text-align: right;
                   4628: }
                   4629: 
1.666     raeburn  4630: .LC_roleslog_note {
                   4631:   font-size: smaller;
                   4632: }
                   4633: 
1.440     albertel 4634: table.LC_aboutme_port {
                   4635:   border: 0px;
                   4636:   border-collapse: collapse;
                   4637:   border-spacing: 0px;
                   4638: }
1.349     albertel 4639: table.LC_data_table, table.LC_mail_list {
1.347     albertel 4640:   border: 1px solid #000000;
1.402     albertel 4641:   border-collapse: separate;
1.426     albertel 4642:   border-spacing: 1px;
1.610     albertel 4643:   background: $pgbg;
1.347     albertel 4644: }
1.422     albertel 4645: .LC_data_table_dense {
                   4646:   font-size: small;
                   4647: }
1.507     raeburn  4648: table.LC_nested_outer {
                   4649:   border: 1px solid #000000;
1.589     raeburn  4650:   border-collapse: collapse;
1.507     raeburn  4651:   border-spacing: 0px;
                   4652:   width: 100%;
                   4653: }
                   4654: table.LC_nested {
                   4655:   border: 0px;
1.589     raeburn  4656:   border-collapse: collapse;
1.507     raeburn  4657:   border-spacing: 0px;
                   4658:   width: 100%;
                   4659: }
1.523     albertel 4660: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
                   4661: table.LC_prior_tries tr th {
1.349     albertel 4662:   font-weight: bold;
                   4663:   background-color: $data_table_head;
1.421     albertel 4664:   font-size: smaller;
1.347     albertel 4665: }
1.610     albertel 4666: table.LC_data_table tr.LC_odd_row > td, 
1.440     albertel 4667: table.LC_aboutme_port tr td {
1.349     albertel 4668:   background-color: $data_table_light;
1.425     albertel 4669:   padding: 2px;
1.347     albertel 4670: }
1.610     albertel 4671: table.LC_data_table tr.LC_even_row > td,
1.440     albertel 4672: table.LC_aboutme_port tr.LC_even_row td {
1.349     albertel 4673:   background-color: $data_table_dark;
1.347     albertel 4674: }
1.425     albertel 4675: table.LC_data_table tr.LC_data_table_highlight td {
                   4676:   background-color: $data_table_darker;
                   4677: }
1.639     raeburn  4678: table.LC_data_table tr td.LC_leftcol_header {
                   4679:   background-color: $data_table_head;
                   4680:   font-weight: bold;
                   4681: }
1.451     albertel 4682: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4683: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4684:   background-color: #FFFFFF;
1.421     albertel 4685:   font-weight: bold;
                   4686:   font-style: italic;
                   4687:   text-align: center;
                   4688:   padding: 8px;
1.347     albertel 4689: }
1.507     raeburn  4690: table.LC_nested tr.LC_empty_row td {
1.465     albertel 4691:   padding: 4ex
                   4692: }
1.507     raeburn  4693: table.LC_nested_outer tr th {
                   4694:   font-weight: bold;
                   4695:   background-color: $data_table_head;
                   4696:   font-size: smaller;
                   4697:   border-bottom: 1px solid #000000;
                   4698: }
                   4699: table.LC_nested_outer tr td.LC_subheader {
                   4700:   background-color: $data_table_head;
                   4701:   font-weight: bold;
                   4702:   font-size: small;
                   4703:   border-bottom: 1px solid #000000;
                   4704:   text-align: right;
1.451     albertel 4705: }
1.507     raeburn  4706: table.LC_nested tr.LC_info_row td {
1.451     albertel 4707:   background-color: #CCC;
                   4708:   font-weight: bold;
                   4709:   font-size: small;
1.507     raeburn  4710:   text-align: center;
                   4711: }
1.589     raeburn  4712: table.LC_nested tr.LC_info_row td.LC_left_item,
                   4713: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  4714:   text-align: left;
1.451     albertel 4715: }
1.507     raeburn  4716: table.LC_nested td {
1.451     albertel 4717:   background-color: #FFF;
                   4718:   font-size: small;
1.507     raeburn  4719: }
                   4720: table.LC_nested_outer tr th.LC_right_item,
                   4721: table.LC_nested tr.LC_info_row td.LC_right_item,
                   4722: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   4723: table.LC_nested tr td.LC_right_item {
1.451     albertel 4724:   text-align: right;
                   4725: }
                   4726: 
1.507     raeburn  4727: table.LC_nested tr.LC_odd_row td {
1.451     albertel 4728:   background-color: #EEE;
                   4729: }
                   4730: 
1.473     raeburn  4731: table.LC_createuser {
                   4732: }
                   4733: 
                   4734: table.LC_createuser tr.LC_section_row td {
                   4735:   font-size: smaller;
                   4736: }
                   4737: 
                   4738: table.LC_createuser tr.LC_info_row td  {
                   4739:   background-color: #CCC;
                   4740:   font-weight: bold;
                   4741:   text-align: center;
                   4742: }
                   4743: 
1.349     albertel 4744: table.LC_calendar {
                   4745:   border: 1px solid #000000;
                   4746:   border-collapse: collapse;
                   4747: }
                   4748: table.LC_calendar_pickdate {
                   4749:   font-size: xx-small;
                   4750: }
                   4751: table.LC_calendar tr td {
                   4752:   border: 1px solid #000000;
                   4753:   vertical-align: top;
                   4754: }
                   4755: table.LC_calendar tr td.LC_calendar_day_empty {
                   4756:   background-color: $data_table_dark;
                   4757: }
                   4758: table.LC_calendar tr td.LC_calendar_day_current {
                   4759:   background-color: $data_table_highlight;
                   4760: }
                   4761: 
                   4762: table.LC_mail_list tr.LC_mail_new {
                   4763:   background-color: $mail_new;
                   4764: }
                   4765: table.LC_mail_list tr.LC_mail_new:hover {
                   4766:   background-color: $mail_new_hover;
                   4767: }
                   4768: table.LC_mail_list tr.LC_mail_read {
                   4769:   background-color: $mail_read;
                   4770: }
                   4771: table.LC_mail_list tr.LC_mail_read:hover {
                   4772:   background-color: $mail_read_hover;
                   4773: }
                   4774: table.LC_mail_list tr.LC_mail_replied {
                   4775:   background-color: $mail_replied;
                   4776: }
                   4777: table.LC_mail_list tr.LC_mail_replied:hover {
                   4778:   background-color: $mail_replied_hover;
                   4779: }
                   4780: table.LC_mail_list tr.LC_mail_other {
                   4781:   background-color: $mail_other;
                   4782: }
                   4783: table.LC_mail_list tr.LC_mail_other:hover {
                   4784:   background-color: $mail_other_hover;
                   4785: }
1.494     raeburn  4786: table.LC_mail_list tr.LC_mail_even {
                   4787: }
                   4788: table.LC_mail_list tr.LC_mail_odd {
                   4789: }
                   4790: 
1.385     albertel 4791: 
1.386     albertel 4792: table#LC_portfolio_actions {
                   4793:   width: auto;
                   4794:   background: $pgbg;
                   4795:   border: 0px;
                   4796:   border-spacing: 2px 2px;
                   4797:   padding: 0px;
                   4798:   margin: 0px;
                   4799:   border-collapse: separate;
                   4800: }
                   4801: table#LC_portfolio_actions td.LC_label {
                   4802:   background: $tabbg;
                   4803:   text-align: right;
                   4804: }
                   4805: table#LC_portfolio_actions td.LC_value {
                   4806:   background: $tabbg;
                   4807: }
1.385     albertel 4808: 
1.391     albertel 4809: table#LC_cstr_controls {
                   4810:   width: 100%;
                   4811:   border-collapse: collapse;
                   4812: }
                   4813: table#LC_cstr_controls tr td {
                   4814:   border: 4px solid $pgbg;
                   4815:   padding: 4px;
                   4816:   text-align: center;
                   4817:   background: $tabbg;
                   4818: }
                   4819: table#LC_cstr_controls tr th {
                   4820:   border: 4px solid $pgbg;
                   4821:   background: $table_header;
                   4822:   text-align: center;
                   4823:   font-family: $sans;
                   4824:   font-size: smaller;
                   4825: }
                   4826: 
1.389     albertel 4827: table#LC_browser {
                   4828:  
                   4829: }
                   4830: table#LC_browser tr th {
1.391     albertel 4831:   background: $table_header;
1.389     albertel 4832: }
1.390     albertel 4833: table#LC_browser tr td {
                   4834:   padding: 2px;
                   4835: }
1.389     albertel 4836: table#LC_browser tr.LC_browser_file,
                   4837: table#LC_browser tr.LC_browser_file_published {
                   4838:   background: #CCFF88;
                   4839: }
                   4840: table#LC_browser tr.LC_browser_file_locked,
                   4841: table#LC_browser tr.LC_browser_file_unpublished {
                   4842:   background: #FFAA99;
1.387     albertel 4843: }
1.389     albertel 4844: table#LC_browser tr.LC_browser_file_obsolete {
                   4845:   background: #AAAAAA;
1.387     albertel 4846: }
1.455     albertel 4847: table#LC_browser tr.LC_browser_file_modified,
                   4848: table#LC_browser tr.LC_browser_file_metamodified {
1.389     albertel 4849:   background: #FFFF77;
1.387     albertel 4850: }
1.389     albertel 4851: table#LC_browser tr.LC_browser_folder {
                   4852:   background: #CCCCFF;
1.387     albertel 4853: }
1.388     albertel 4854: span.LC_current_location {
                   4855:   font-size: x-large;
                   4856:   background: $pgbg;
                   4857: }
1.387     albertel 4858: 
1.395     albertel 4859: span.LC_parm_menu_item {
                   4860:   font-size: larger;
                   4861:   font-family: $sans;
                   4862: }
                   4863: span.LC_parm_scope_all {
                   4864:   color: red;
                   4865: }
                   4866: span.LC_parm_scope_folder {
                   4867:   color: green;
                   4868: }
                   4869: span.LC_parm_scope_resource {
                   4870:   color: orange;
                   4871: }
                   4872: span.LC_parm_part {
                   4873:   color: blue;
                   4874: }
                   4875: span.LC_parm_folder, span.LC_parm_symb {
                   4876:   font-size: x-small;
                   4877:   font-family: $mono;
                   4878:   color: #AAAAAA;
                   4879: }
                   4880: 
1.396     albertel 4881: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
                   4882: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
                   4883:   border: 1px solid black;
                   4884:   border-collapse: collapse;
                   4885: }
                   4886: table.LC_parm_overview_restrictions td {
                   4887:   border-width: 1px 4px 1px 4px;
                   4888:   border-style: solid;
                   4889:   border-color: $pgbg;
                   4890:   text-align: center;
                   4891: }
                   4892: table.LC_parm_overview_restrictions th {
                   4893:   background: $tabbg;
                   4894:   border-width: 1px 4px 1px 4px;
                   4895:   border-style: solid;
                   4896:   border-color: $pgbg;
                   4897: }
1.398     albertel 4898: table#LC_helpmenu {
                   4899:   border: 0px;
                   4900:   height: 55px;
                   4901:   border-spacing: 0px;
                   4902: }
                   4903: 
                   4904: table#LC_helpmenu fieldset legend {
                   4905:   font-size: larger;
                   4906:   font-weight: bold;
                   4907: }
1.397     albertel 4908: table#LC_helpmenu_links {
                   4909:   width: 100%;
                   4910:   border: 1px solid black;
                   4911:   background: $pgbg;
                   4912:   padding: 0px;
                   4913:   border-spacing: 1px;
                   4914: }
                   4915: table#LC_helpmenu_links tr td {
                   4916:   padding: 1px;
                   4917:   background: $tabbg;
1.399     albertel 4918:   text-align: center;
                   4919:   font-weight: bold;
1.397     albertel 4920: }
1.396     albertel 4921: 
1.397     albertel 4922: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
                   4923: table#LC_helpmenu_links a:active {
                   4924:   text-decoration: none;
                   4925:   color: $font;
                   4926: }
                   4927: table#LC_helpmenu_links a:hover {
                   4928:   text-decoration: underline;
                   4929:   color: $vlink;
                   4930: }
1.396     albertel 4931: 
1.417     albertel 4932: .LC_chrt_popup_exists {
                   4933:   border: 1px solid #339933;
                   4934:   margin: -1px;
                   4935: }
                   4936: .LC_chrt_popup_up {
                   4937:   border: 1px solid yellow;
                   4938:   margin: -1px;
                   4939: }
                   4940: .LC_chrt_popup {
                   4941:   border: 1px solid #8888FF;
                   4942:   background: #CCCCFF;
                   4943: }
1.421     albertel 4944: table.LC_pick_box {
                   4945:   border-collapse: separate;
                   4946:   background: white;
                   4947:   border: 1px solid black;
                   4948:   border-spacing: 1px;
                   4949: }
                   4950: table.LC_pick_box td.LC_pick_box_title {
                   4951:   background: $tabbg;
                   4952:   font-weight: bold;
                   4953:   text-align: right;
                   4954:   width: 184px;
                   4955:   padding: 8px;
                   4956: }
1.645     raeburn  4957: table.LC_pick_box td.LC_selfenroll_pick_box_title {
                   4958:   background: $tabbg;
                   4959:   font-weight: bold;
                   4960:   text-align: right;
                   4961:   width: 350px;
                   4962:   padding: 8px;
                   4963: }
                   4964: 
1.579     raeburn  4965: table.LC_pick_box td.LC_pick_box_value {
                   4966:   text-align: left;
                   4967:   padding: 8px;
                   4968: }
                   4969: table.LC_pick_box td.LC_pick_box_select {
                   4970:   text-align: left;
                   4971:   padding: 8px;
                   4972: }
1.424     albertel 4973: table.LC_pick_box td.LC_pick_box_separator {
1.421     albertel 4974:   padding: 0px;
                   4975:   height: 1px;
                   4976:   background: black;
                   4977: }
                   4978: table.LC_pick_box td.LC_pick_box_submit {
                   4979:   text-align: right;
                   4980: }
1.579     raeburn  4981: table.LC_pick_box td.LC_evenrow_value {
                   4982:   text-align: left;
                   4983:   padding: 8px;
                   4984:   background-color: $data_table_light;
                   4985: }
                   4986: table.LC_pick_box td.LC_oddrow_value {
                   4987:   text-align: left;
                   4988:   padding: 8px;
                   4989:   background-color: $data_table_light;
                   4990: }
                   4991: table.LC_helpform_receipt {
                   4992:   width: 620px;
                   4993:   border-collapse: separate;
                   4994:   background: white;
                   4995:   border: 1px solid black;
                   4996:   border-spacing: 1px;
                   4997: }
                   4998: table.LC_helpform_receipt td.LC_pick_box_title {
                   4999:   background: $tabbg;
                   5000:   font-weight: bold;
                   5001:   text-align: right;
                   5002:   width: 184px;
                   5003:   padding: 8px;
                   5004: }
                   5005: table.LC_helpform_receipt td.LC_evenrow_value {
                   5006:   text-align: left;
                   5007:   padding: 8px;
                   5008:   background-color: $data_table_light;
                   5009: }
                   5010: table.LC_helpform_receipt td.LC_oddrow_value {
                   5011:   text-align: left;
                   5012:   padding: 8px;
                   5013:   background-color: $data_table_light;
                   5014: }
                   5015: table.LC_helpform_receipt td.LC_pick_box_separator {
                   5016:   padding: 0px;
                   5017:   height: 1px;
                   5018:   background: black;
                   5019: }
                   5020: span.LC_helpform_receipt_cat {
                   5021:   font-weight: bold;
                   5022: }
1.424     albertel 5023: table.LC_group_priv_box {
                   5024:   background: white;
                   5025:   border: 1px solid black;
                   5026:   border-spacing: 1px;
                   5027: }
                   5028: table.LC_group_priv_box td.LC_pick_box_title {
                   5029:   background: $tabbg;
                   5030:   font-weight: bold;
                   5031:   text-align: right;
                   5032:   width: 184px;
                   5033: }
                   5034: table.LC_group_priv_box td.LC_groups_fixed {
                   5035:   background: $data_table_light;
                   5036:   text-align: center;
                   5037: }
                   5038: table.LC_group_priv_box td.LC_groups_optional {
                   5039:   background: $data_table_dark;
                   5040:   text-align: center;
                   5041: }
                   5042: table.LC_group_priv_box td.LC_groups_functionality {
                   5043:   background: $data_table_darker;
                   5044:   text-align: center;
                   5045:   font-weight: bold;
                   5046: }
                   5047: table.LC_group_priv td {
                   5048:   text-align: left;
                   5049:   padding: 0px;
                   5050: }
                   5051: 
1.421     albertel 5052: table.LC_notify_front_page {
                   5053:   background: white;
                   5054:   border: 1px solid black;
                   5055:   padding: 8px;
                   5056: }
                   5057: table.LC_notify_front_page td {
                   5058:   padding: 8px;
                   5059: }
1.424     albertel 5060: .LC_navbuttons {
                   5061:   margin: 2ex 0ex 2ex 0ex;
                   5062: }
1.423     albertel 5063: .LC_topic_bar {
                   5064:   font-family: $sans;
                   5065:   font-weight: bold;
                   5066:   width: 100%;
                   5067:   background: $tabbg;
                   5068:   vertical-align: middle;
                   5069:   margin: 2ex 0ex 2ex 0ex;
                   5070: }
                   5071: .LC_topic_bar span {
                   5072:   vertical-align: middle;
                   5073: }
                   5074: .LC_topic_bar img {
                   5075:   vertical-align: bottom;
                   5076: }
                   5077: table.LC_course_group_status {
                   5078:   margin: 20px;
                   5079: }
                   5080: table.LC_status_selector td {
                   5081:   vertical-align: top;
                   5082:   text-align: center;
1.424     albertel 5083:   padding: 4px;
                   5084: }
                   5085: table.LC_descriptive_input td.LC_description {
                   5086:   vertical-align: top;
                   5087:   text-align: right;
                   5088:   font-weight: bold;
1.423     albertel 5089: }
1.599     albertel 5090: div.LC_feedback_link {
1.616     albertel 5091:   clear: both;
1.599     albertel 5092:   background: white;
                   5093:   width: 100%;  
1.489     raeburn  5094: }
                   5095: span.LC_feedback_link {
1.599     albertel 5096:   background: $feedback_link_bg;
                   5097:   font-size: larger;
                   5098: }
                   5099: span.LC_message_link {
                   5100:   background: $feedback_link_bg;
                   5101:   font-size: larger;
                   5102:   position: absolute;
                   5103:   right: 1em;
1.489     raeburn  5104: }
1.421     albertel 5105: 
1.515     albertel 5106: table.LC_prior_tries {
1.524     albertel 5107:   border: 1px solid #000000;
                   5108:   border-collapse: separate;
                   5109:   border-spacing: 1px;
1.515     albertel 5110: }
1.523     albertel 5111: 
1.515     albertel 5112: table.LC_prior_tries td {
1.524     albertel 5113:   padding: 2px;
1.515     albertel 5114: }
1.523     albertel 5115: 
                   5116: .LC_answer_correct {
                   5117:   background: #AAFFAA;
                   5118:   color: black;
                   5119: }
                   5120: .LC_answer_charged_try {
                   5121:   background: #FFAAAA ! important;
                   5122:   color: black;
                   5123: }
                   5124: .LC_answer_not_charged_try, 
                   5125: .LC_answer_no_grade,
                   5126: .LC_answer_late {
                   5127:   background: #FFFFAA;
                   5128:   color: black;
                   5129: }
                   5130: .LC_answer_previous {
                   5131:   background: #AAAAFF;
                   5132:   color: black;
                   5133: }
                   5134: .LC_answer_no_message {
                   5135:   background: #FFFFFF;
                   5136:   color: black;
                   5137: }
                   5138: .LC_answer_unknown {
                   5139:   background: orange;
                   5140:   color: black;
                   5141: }
                   5142: 
                   5143: 
1.529     albertel 5144: span.LC_prior_numerical,
                   5145: span.LC_prior_string,
                   5146: span.LC_prior_custom,
                   5147: span.LC_prior_reaction,
                   5148: span.LC_prior_math {
1.523     albertel 5149:   font-family: monospace;
                   5150:   white-space: pre;
                   5151: }
                   5152: 
1.525     albertel 5153: span.LC_prior_string {
                   5154:   font-family: monospace;
                   5155:   white-space: pre;
                   5156: }
                   5157: 
1.523     albertel 5158: table.LC_prior_option {
                   5159:   width: 100%;
                   5160:   border-collapse: collapse;
                   5161: }
1.528     albertel 5162: table.LC_prior_rank, table.LC_prior_match {
                   5163:   border-collapse: collapse;
                   5164: }
                   5165: table.LC_prior_option tr td,
                   5166: table.LC_prior_rank tr td,
                   5167: table.LC_prior_match tr td {
1.524     albertel 5168:   border: 1px solid #000000;
1.515     albertel 5169: }
                   5170: 
1.519     raeburn  5171: span.LC_nobreak {
1.544     albertel 5172:   white-space: nowrap;
1.519     raeburn  5173: }
                   5174: 
1.576     raeburn  5175: span.LC_cusr_emph {
                   5176:   font-style: italic;
                   5177: }
                   5178: 
1.633     raeburn  5179: span.LC_cusr_subheading {
                   5180:   font-weight: normal;
                   5181:   font-size: 85%;
                   5182: }
                   5183: 
1.545     albertel 5184: table.LC_docs_documents {
                   5185:   background: #BBBBBB;
1.547     albertel 5186:   border-width: 0px;
1.545     albertel 5187:   border-collapse: collapse;
                   5188: }
                   5189: 
                   5190: table.LC_docs_documents td.LC_docs_document {
                   5191:   border: 2px solid black;
                   5192:   padding: 4px;
                   5193: }
                   5194: 
                   5195: .LC_docs_course_commands div {
                   5196:   float: left;
                   5197:   border: 4px solid #AAAAAA;
                   5198:   padding: 4px;
                   5199:   background: #DDDDCC;
                   5200: }
                   5201: 
                   5202: .LC_docs_entry_move {
                   5203:   border: 0px;
                   5204:   border-collapse: collapse;
1.544     albertel 5205: }
                   5206: 
1.545     albertel 5207: .LC_docs_entry_move td {
                   5208:   border: 2px solid #BBBBBB;
                   5209:   background: #DDDDDD;
                   5210: }
                   5211: 
                   5212: .LC_docs_editor td.LC_docs_entry_commands {
                   5213:   background: #DDDDDD;
                   5214:   font-size: x-small;
                   5215: }
1.544     albertel 5216: .LC_docs_copy {
1.545     albertel 5217:   color: #000099;
1.544     albertel 5218: }
                   5219: .LC_docs_cut {
1.545     albertel 5220:   color: #550044;
1.544     albertel 5221: }
                   5222: .LC_docs_rename {
1.545     albertel 5223:   color: #009900;
1.544     albertel 5224: }
                   5225: .LC_docs_remove {
1.545     albertel 5226:   color: #990000;
                   5227: }
                   5228: 
1.547     albertel 5229: .LC_docs_reinit_warn,
                   5230: .LC_docs_ext_edit {
                   5231:   font-size: x-small;
                   5232: }
                   5233: 
1.545     albertel 5234: .LC_docs_editor td.LC_docs_entry_title,
                   5235: .LC_docs_editor td.LC_docs_entry_icon {
                   5236:   background: #FFFFBB;
                   5237: }
                   5238: .LC_docs_editor td.LC_docs_entry_parameter {
                   5239:   background: #BBBBFF;
                   5240:   font-size: x-small;
                   5241:   white-space: nowrap;
                   5242: }
                   5243: 
                   5244: table.LC_docs_adddocs td,
                   5245: table.LC_docs_adddocs th {
                   5246:   border: 1px solid #BBBBBB;
                   5247:   padding: 4px;
                   5248:   background: #DDDDDD;
1.543     albertel 5249: }
                   5250: 
1.584     albertel 5251: table.LC_sty_begin {
                   5252:   background: #BBFFBB;
                   5253: }
                   5254: table.LC_sty_end {
                   5255:   background: #FFBBBB;
                   5256: }
                   5257: 
1.589     raeburn  5258: table.LC_double_column {
                   5259:   border-width: 0px;
                   5260:   border-collapse: collapse;
                   5261:   width: 100%;
                   5262:   padding: 2px;
                   5263: }
                   5264: 
                   5265: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5266:   top: 2px;
1.589     raeburn  5267:   left: 2px;
                   5268:   width: 47%;
                   5269:   vertical-align: top;
                   5270: }
                   5271: 
                   5272: table.LC_double_column tr td.LC_right_col {
                   5273:   top: 2px;
                   5274:   right: 2px; 
                   5275:   width: 47%;
                   5276:   vertical-align: top;
                   5277: }
                   5278: 
1.594     raeburn  5279: span.LC_role_level {
                   5280:   font-weight: bold;
                   5281: }
                   5282: 
1.591     raeburn  5283: div.LC_left_float {
                   5284:   float: left;
                   5285:   padding-right: 5%;
1.597     albertel 5286:   padding-bottom: 4px;
1.591     raeburn  5287: }
                   5288: 
                   5289: div.LC_clear_float_header {
1.597     albertel 5290:   padding-bottom: 2px;
1.591     raeburn  5291: }
                   5292: 
                   5293: div.LC_clear_float_footer {
1.597     albertel 5294:   padding-top: 10px;
1.591     raeburn  5295:   clear: both;
                   5296: }
                   5297: 
1.597     albertel 5298: 
1.601     albertel 5299: div.LC_grade_select_mode {
1.604     albertel 5300:   font-family: $sans;
1.601     albertel 5301: }
                   5302: div.LC_grade_select_mode div div {
                   5303:   margin: 5px;
                   5304: }
                   5305: div.LC_grade_select_mode_selector {
                   5306:   margin: 5px;
                   5307:   float: left;
                   5308: }
                   5309: div.LC_grade_select_mode_selector_header {
                   5310:   font: bold medium $sans;
                   5311: }
                   5312: div.LC_grade_select_mode_type {
                   5313:   clear: left;
                   5314: }
                   5315: 
1.597     albertel 5316: div.LC_grade_show_user {
                   5317:   margin-top: 20px;
                   5318:   border: 1px solid black;
                   5319: }
                   5320: div.LC_grade_user_name {
                   5321:   background: #DDDDEE;
                   5322:   border-bottom: 1px solid black;
                   5323:   font: bold large $sans;
                   5324: }
                   5325: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5326:   background: #DDEEDD;
                   5327: }
                   5328: 
                   5329: div.LC_grade_show_problem,
                   5330: div.LC_grade_submissions,
                   5331: div.LC_grade_message_center,
                   5332: div.LC_grade_info_links,
                   5333: div.LC_grade_assign {
                   5334:   margin: 5px;
                   5335:   width: 99%;
                   5336:   background: #FFFFFF;
                   5337: }
                   5338: div.LC_grade_show_problem_header,
                   5339: div.LC_grade_submissions_header,
                   5340: div.LC_grade_message_center_header,
                   5341: div.LC_grade_assign_header {
                   5342:   font: bold large $sans;
                   5343: }
                   5344: div.LC_grade_show_problem_problem,
                   5345: div.LC_grade_submissions_body,
                   5346: div.LC_grade_message_center_body,
                   5347: div.LC_grade_assign_body {
                   5348:   border: 1px solid black;
                   5349:   width: 99%;
                   5350:   background: #FFFFFF;
                   5351: }
1.598     albertel 5352: span.LC_grade_check_note {
                   5353:   font: normal medium $sans;
                   5354:   display: inline;
                   5355:   position: absolute;
                   5356:   right: 1em;
                   5357: }
1.597     albertel 5358: 
1.613     albertel 5359: table.LC_scantron_action {
                   5360:   width: 100%;
                   5361: }
                   5362: table.LC_scantron_action tr th {
                   5363:   font: normal bold $sans;
                   5364: }
1.600     albertel 5365: 
1.614     albertel 5366: div.LC_edit_problem_header, 
                   5367: div.LC_edit_problem_footer {
1.600     albertel 5368:   font: normal medium $sans;
1.602     albertel 5369:   margin: 2px;
1.600     albertel 5370: }
                   5371: div.LC_edit_problem_header,
1.602     albertel 5372: div.LC_edit_problem_header div,
1.614     albertel 5373: div.LC_edit_problem_footer,
                   5374: div.LC_edit_problem_footer div,
1.602     albertel 5375: div.LC_edit_problem_editxml_header,
                   5376: div.LC_edit_problem_editxml_header div {
1.600     albertel 5377:   margin-top: 5px;
                   5378: }
1.602     albertel 5379: div.LC_edit_problem_header_edit_row {
                   5380:   background: $tabbg;
                   5381:   padding: 3px;
                   5382:   margin-bottom: 5px;
                   5383: }
1.600     albertel 5384: div.LC_edit_problem_header_title {
1.602     albertel 5385:   font: larger bold $sans;
                   5386:   background: $tabbg;
                   5387:   padding: 3px;
                   5388: }
                   5389: table.LC_edit_problem_header_title {
                   5390:   font: larger bold $sans;
                   5391:   width: 100%;
                   5392:   border-color: $pgbg;
                   5393:   border-style: solid;
                   5394:   border-width: $border;
                   5395: 
1.600     albertel 5396:   background: $tabbg;
1.602     albertel 5397:   border-collapse: collapse;
                   5398:   padding: 0px
                   5399: }
                   5400: 
                   5401: div.LC_edit_problem_discards {
                   5402:   float: left;
                   5403:   padding-bottom: 5px;
                   5404: }
                   5405: div.LC_edit_problem_saves {
                   5406:   float: right;
                   5407:   padding-bottom: 5px;
1.600     albertel 5408: }
                   5409: hr.LC_edit_problem_divide {
1.602     albertel 5410:   clear: both;
1.600     albertel 5411:   color: $tabbg;
                   5412:   background-color: $tabbg;
                   5413:   height: 3px;
                   5414:   border: 0px;
                   5415: }
1.679     riegler  5416: img.stift{
1.678     riegler  5417:   border-width:0;
1.679     riegler  5418:   vertical-align:middle;
1.677     riegler  5419: }
1.680     riegler  5420: 
1.681     riegler  5421: table#LC_mainmenu{
                   5422:  margin-top:10px;
                   5423:  width:80%;
                   5424: 
                   5425: }
                   5426: 
1.680     riegler  5427: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5428:   vertical-align: top;
                   5429:   width: 45%;
                   5430: }
                   5431: .LC_mainmenu_fieldset_category {
                   5432:   color: $font;
                   5433:   background: $pgbg;
                   5434:   font-family: $sans;
                   5435:   font-size: small;
                   5436:   font-weight: bold;
                   5437: }
                   5438: fieldset#LC_mainmenu_fieldset {
1.681     riegler  5439:   margin:0px 10px 10px 0px;
1.680     riegler  5440: 
                   5441: }
1.343     albertel 5442: END
                   5443: }
                   5444: 
1.306     albertel 5445: =pod
                   5446: 
                   5447: =item * &headtag()
                   5448: 
                   5449: Returns a uniform footer for LON-CAPA web pages.
                   5450: 
1.307     albertel 5451: Inputs: $title - optional title for the head
                   5452:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 5453:         $args - optional arguments
1.319     albertel 5454:             force_register - if is true call registerurl so the remote is 
                   5455:                              informed
1.415     albertel 5456:             redirect       -> array ref of
                   5457:                                    1- seconds before redirect occurs
                   5458:                                    2- url to redirect to
                   5459:                                    3- whether the side effect should occur
1.315     albertel 5460:                            (side effect of setting 
                   5461:                                $env{'internal.head.redirect'} to the url 
                   5462:                                redirected too)
1.352     albertel 5463:             domain         -> force to color decorate a page for a specific
                   5464:                                domain
                   5465:             function       -> force usage of a specific rolish color scheme
                   5466:             bgcolor        -> override the default page bgcolor
1.460     albertel 5467:             no_auto_mt_title
                   5468:                            -> prevent &mt()ing the title arg
1.464     albertel 5469: 
1.306     albertel 5470: =cut
                   5471: 
                   5472: sub headtag {
1.313     albertel 5473:     my ($title,$head_extra,$args) = @_;
1.306     albertel 5474:     
1.363     albertel 5475:     my $function = $args->{'function'} || &get_users_function();
                   5476:     my $domain   = $args->{'domain'}   || &determinedomain();
                   5477:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 5478:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 5479: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 5480: 		   #time(),
1.418     albertel 5481: 		   $env{'environment.color.timestamp'},
1.363     albertel 5482: 		   $function,$domain,$bgcolor);
                   5483: 
1.369     www      5484:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 5485: 
1.308     albertel 5486:     my $result =
                   5487: 	'<head>'.
1.461     albertel 5488: 	&font_settings();
1.319     albertel 5489: 
1.461     albertel 5490:     if (!$args->{'frameset'}) {
                   5491: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   5492:     }
1.319     albertel 5493:     if ($args->{'force_register'}) {
                   5494: 	$result .= &Apache::lonmenu::registerurl(1);
                   5495:     }
1.436     albertel 5496:     if (!$args->{'no_nav_bar'} 
                   5497: 	&& !$args->{'only_body'}
                   5498: 	&& !$args->{'frameset'}) {
                   5499: 	$result .= &help_menu_js();
                   5500:     }
1.319     albertel 5501: 
1.314     albertel 5502:     if (ref($args->{'redirect'})) {
1.414     albertel 5503: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 5504: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 5505: 	if (!$inhibit_continue) {
                   5506: 	    $env{'internal.head.redirect'} = $url;
                   5507: 	}
1.313     albertel 5508: 	$result.=<<ADDMETA
                   5509: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 5510: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 5511: ADDMETA
                   5512:     }
1.306     albertel 5513:     if (!defined($title)) {
                   5514: 	$title = 'The LearningOnline Network with CAPA';
                   5515:     }
1.460     albertel 5516:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   5517:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 5518: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   5519: 	.$head_extra;
1.306     albertel 5520:     return $result;
                   5521: }
                   5522: 
                   5523: =pod
                   5524: 
1.340     albertel 5525: =item * &font_settings()
                   5526: 
                   5527: Returns neccessary <meta> to set the proper encoding
                   5528: 
                   5529: Inputs: none
                   5530: 
                   5531: =cut
                   5532: 
                   5533: sub font_settings {
                   5534:     my $headerstring='';
1.647     www      5535:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 5536: 	$headerstring.=
                   5537: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   5538:     }
                   5539:     return $headerstring;
                   5540: }
                   5541: 
1.341     albertel 5542: =pod
                   5543: 
                   5544: =item * &xml_begin()
                   5545: 
                   5546: Returns the needed doctype and <html>
                   5547: 
                   5548: Inputs: none
                   5549: 
                   5550: =cut
                   5551: 
                   5552: sub xml_begin {
                   5553:     my $output='';
                   5554: 
1.592     albertel 5555:     if ($env{'internal.start_page'}==1) {
                   5556: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   5557:     }
1.342     albertel 5558: 
1.341     albertel 5559:     if ($env{'browser.mathml'}) {
                   5560: 	$output='<?xml version="1.0"?>'
                   5561:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   5562: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   5563:             
                   5564: #	    .'<!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">] >'
                   5565: 	    .'<!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">'
                   5566:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   5567: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   5568:     } else {
                   5569: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
                   5570:     }
                   5571:     return $output;
                   5572: }
1.340     albertel 5573: 
                   5574: =pod
                   5575: 
1.306     albertel 5576: =item * &endheadtag()
                   5577: 
                   5578: Returns a uniform </head> for LON-CAPA web pages.
                   5579: 
                   5580: Inputs: none
                   5581: 
                   5582: =cut
                   5583: 
                   5584: sub endheadtag {
                   5585:     return '</head>';
                   5586: }
                   5587: 
                   5588: =pod
                   5589: 
                   5590: =item * &head()
                   5591: 
                   5592: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   5593: 
1.648     raeburn  5594: Inputs:
                   5595: 
                   5596: =over 4
                   5597: 
                   5598: $title - optional title for the page
                   5599: 
                   5600: $head_extra - optional extra HTML to put inside the <head>
                   5601: 
                   5602: =back
1.405     albertel 5603: 
1.306     albertel 5604: =cut
                   5605: 
                   5606: sub head {
1.325     albertel 5607:     my ($title,$head_extra,$args) = @_;
                   5608:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 5609: }
                   5610: 
                   5611: =pod
                   5612: 
                   5613: =item * &start_page()
                   5614: 
                   5615: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   5616: 
1.648     raeburn  5617: Inputs:
                   5618: 
                   5619: =over 4
                   5620: 
                   5621: $title - optional title for the page
                   5622: 
                   5623: $head_extra - optional extra HTML to incude inside the <head>
                   5624: 
                   5625: $args - additional optional args supported are:
                   5626: 
                   5627: =over 8
                   5628: 
                   5629:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 5630:                                     arg on
1.648     raeburn  5631:              no_nav_bar     -> is true will set &bodytag() notopbar arg on
                   5632:              add_entries    -> additional attributes to add to the  <body>
                   5633:              domain         -> force to color decorate a page for a 
1.317     albertel 5634:                                     specific domain
1.648     raeburn  5635:              function       -> force usage of a specific rolish color
1.317     albertel 5636:                                     scheme
1.648     raeburn  5637:              redirect       -> see &headtag()
                   5638:              bgcolor        -> override the default page bg color
                   5639:              js_ready       -> return a string ready for being used in 
1.317     albertel 5640:                                     a javascript writeln
1.648     raeburn  5641:              html_encode    -> return a string ready for being used in 
1.320     albertel 5642:                                     a html attribute
1.648     raeburn  5643:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 5644:                                     $forcereg arg
1.648     raeburn  5645:              body_title     -> alternate text to use instead of $title
1.326     albertel 5646:                                     in the title box that appears, this text
                   5647:                                     is not auto translated like the $title is
1.648     raeburn  5648:              frameset       -> if true will start with a <frameset>
1.330     albertel 5649:                                     rather than <body>
1.648     raeburn  5650:              no_title       -> if true the title bar won't be shown
                   5651:              skip_phases    -> hash ref of 
1.338     albertel 5652:                                     head -> skip the <html><head> generation
                   5653:                                     body -> skip all <body> generation
1.648     raeburn  5654:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 5655:                                     'Switch To Inline Menu' link
1.648     raeburn  5656:              no_auto_mt_title -> prevent &mt()ing the title arg
                   5657:              inherit_jsmath -> when creating popup window in a page,
                   5658:                                     should it have jsmath forced on by the
                   5659:                                     current page
1.361     albertel 5660: 
1.648     raeburn  5661: =back
1.460     albertel 5662: 
1.648     raeburn  5663: =back
1.562     albertel 5664: 
1.306     albertel 5665: =cut
                   5666: 
                   5667: sub start_page {
1.309     albertel 5668:     my ($title,$head_extra,$args) = @_;
1.318     albertel 5669:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 5670:     my %head_args;
1.352     albertel 5671:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 5672: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   5673: 		     'no_auto_mt_title') {
1.319     albertel 5674: 	if (defined($args->{$arg})) {
1.324     raeburn  5675: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 5676: 	}
1.313     albertel 5677:     }
1.319     albertel 5678: 
1.315     albertel 5679:     $env{'internal.start_page'}++;
1.338     albertel 5680:     my $result;
                   5681:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   5682: 	$result.=
1.341     albertel 5683: 	    &xml_begin().
1.338     albertel 5684: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   5685:     }
                   5686:     
                   5687:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   5688: 	if ($args->{'frameset'}) {
                   5689: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   5690: 						$args->{'add_entries'});
                   5691: 	    $result .= "\n<frameset $attr_string>\n";
                   5692: 	} else {
                   5693: 	    $result .=
                   5694: 		&bodytag($title, 
                   5695: 			 $args->{'function'},       $args->{'add_entries'},
                   5696: 			 $args->{'only_body'},      $args->{'domain'},
                   5697: 			 $args->{'force_register'}, $args->{'body_title'},
                   5698: 			 $args->{'no_nav_bar'},     $args->{'bgcolor'},
1.460     albertel 5699: 			 $args->{'no_title'},       $args->{'no_inline_link'},
                   5700: 			 $args);
1.338     albertel 5701: 	}
1.330     albertel 5702:     }
1.338     albertel 5703: 
1.315     albertel 5704:     if ($args->{'js_ready'}) {
1.317     albertel 5705: 	$result = &js_ready($result);
1.315     albertel 5706:     }
1.320     albertel 5707:     if ($args->{'html_encode'}) {
                   5708: 	$result = &html_encode($result);
                   5709:     }
1.315     albertel 5710:     return $result;
1.306     albertel 5711: }
                   5712: 
1.330     albertel 5713: 
1.306     albertel 5714: =pod
                   5715: 
                   5716: =item * &head()
                   5717: 
                   5718: Returns a complete </body></html> section for LON-CAPA web pages.
                   5719: 
1.315     albertel 5720: Inputs:         $args - additional optional args supported are:
                   5721:                  js_ready     -> return a string ready for being used in 
                   5722:                                  a javascript writeln
1.320     albertel 5723:                  html_encode  -> return a string ready for being used in 
                   5724:                                  a html attribute
1.330     albertel 5725:                  frameset     -> if true will start with a <frameset>
                   5726:                                  rather than <body>
1.493     albertel 5727:                  dicsussion   -> if true will get discussion from
                   5728:                                   lonxml::xmlend
                   5729:                                  (you can pass the target and parser arguments
                   5730:                                   through optional 'target' and 'parser' args
                   5731:                                   to this routine)
1.306     albertel 5732: 
                   5733: =cut
                   5734: 
                   5735: sub end_page {
1.315     albertel 5736:     my ($args) = @_;
                   5737:     $env{'internal.end_page'}++;
1.330     albertel 5738:     my $result;
1.335     albertel 5739:     if ($args->{'discussion'}) {
                   5740: 	my ($target,$parser);
                   5741: 	if (ref($args->{'discussion'})) {
                   5742: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   5743: 				$args->{'discussion'}{'parser'});
                   5744: 	}
                   5745: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   5746:     }
                   5747: 
1.330     albertel 5748:     if ($args->{'frameset'}) {
                   5749: 	$result .= '</frameset>';
                   5750:     } else {
1.635     raeburn  5751: 	$result .= &endbodytag($args);
1.330     albertel 5752:     }
                   5753:     $result .= "\n</html>";
                   5754: 
1.315     albertel 5755:     if ($args->{'js_ready'}) {
1.317     albertel 5756: 	$result = &js_ready($result);
1.315     albertel 5757:     }
1.335     albertel 5758: 
1.320     albertel 5759:     if ($args->{'html_encode'}) {
                   5760: 	$result = &html_encode($result);
                   5761:     }
1.335     albertel 5762: 
1.315     albertel 5763:     return $result;
                   5764: }
                   5765: 
1.320     albertel 5766: sub html_encode {
                   5767:     my ($result) = @_;
                   5768: 
1.322     albertel 5769:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 5770:     
                   5771:     return $result;
                   5772: }
1.317     albertel 5773: sub js_ready {
                   5774:     my ($result) = @_;
                   5775: 
1.323     albertel 5776:     $result =~ s/[\n\r]/ /xmsg;
                   5777:     $result =~ s/\\/\\\\/xmsg;
                   5778:     $result =~ s/'/\\'/xmsg;
1.372     albertel 5779:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 5780:     
                   5781:     return $result;
                   5782: }
                   5783: 
1.315     albertel 5784: sub validate_page {
                   5785:     if (  exists($env{'internal.start_page'})
1.316     albertel 5786: 	  &&     $env{'internal.start_page'} > 1) {
                   5787: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 5788: 				 $env{'internal.start_page'}.' '.
1.316     albertel 5789: 				 $ENV{'request.filename'});
1.315     albertel 5790:     }
                   5791:     if (  exists($env{'internal.end_page'})
1.316     albertel 5792: 	  &&     $env{'internal.end_page'} > 1) {
                   5793: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 5794: 				 $env{'internal.end_page'}.' '.
1.316     albertel 5795: 				 $env{'request.filename'});
1.315     albertel 5796:     }
                   5797:     if (     exists($env{'internal.start_page'})
                   5798: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 5799: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   5800: 				 $env{'request.filename'});
1.315     albertel 5801:     }
                   5802:     if (   ! exists($env{'internal.start_page'})
                   5803: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 5804: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   5805: 				 $env{'request.filename'});
1.315     albertel 5806:     }
1.306     albertel 5807: }
1.315     albertel 5808: 
1.318     albertel 5809: sub simple_error_page {
                   5810:     my ($r,$title,$msg) = @_;
                   5811:     my $page =
                   5812: 	&Apache::loncommon::start_page($title).
                   5813: 	&mt($msg).
                   5814: 	&Apache::loncommon::end_page();
                   5815:     if (ref($r)) {
                   5816: 	$r->print($page);
1.327     albertel 5817: 	return;
1.318     albertel 5818:     }
                   5819:     return $page;
                   5820: }
1.347     albertel 5821: 
                   5822: {
1.610     albertel 5823:     my @row_count;
1.347     albertel 5824:     sub start_data_table {
1.422     albertel 5825: 	my ($add_class) = @_;
                   5826: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 5827: 	unshift(@row_count,0);
1.422     albertel 5828: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 5829:     }
                   5830: 
                   5831:     sub end_data_table {
1.610     albertel 5832: 	shift(@row_count);
1.389     albertel 5833: 	return '</table>'."\n";;
1.347     albertel 5834:     }
                   5835: 
                   5836:     sub start_data_table_row {
1.422     albertel 5837: 	my ($add_class) = @_;
1.610     albertel 5838: 	$row_count[0]++;
                   5839: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 5840: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 5841: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 5842:     }
1.471     banghart 5843:     
                   5844:     sub continue_data_table_row {
                   5845: 	my ($add_class) = @_;
1.610     albertel 5846: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 5847: 	$css_class = (join(' ',$css_class,$add_class));
                   5848: 	return  '<tr class="'.$css_class.'">'."\n";;
                   5849:     }
1.347     albertel 5850: 
                   5851:     sub end_data_table_row {
1.389     albertel 5852: 	return '</tr>'."\n";;
1.347     albertel 5853:     }
1.367     www      5854: 
1.421     albertel 5855:     sub start_data_table_empty_row {
1.610     albertel 5856: 	$row_count[0]++;
1.421     albertel 5857: 	return  '<tr class="LC_empty_row" >'."\n";;
                   5858:     }
                   5859: 
                   5860:     sub end_data_table_empty_row {
                   5861: 	return '</tr>'."\n";;
                   5862:     }
                   5863: 
1.367     www      5864:     sub start_data_table_header_row {
1.389     albertel 5865: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      5866:     }
                   5867: 
                   5868:     sub end_data_table_header_row {
1.389     albertel 5869: 	return '</tr>'."\n";;
1.367     www      5870:     }
1.347     albertel 5871: }
                   5872: 
1.548     albertel 5873: =pod
                   5874: 
                   5875: =item * &inhibit_menu_check($arg)
                   5876: 
                   5877: Checks for a inhibitmenu state and generates output to preserve it
                   5878: 
                   5879: Inputs:         $arg - can be any of
                   5880:                      - undef - in which case the return value is a string 
                   5881:                                to add  into arguments list of a uri
                   5882:                      - 'input' - in which case the return value is a HTML
                   5883:                                  <form> <input> field of type hidden to
                   5884:                                  preserve the value
                   5885:                      - a url - in which case the return value is the url with
                   5886:                                the neccesary cgi args added to preserve the
                   5887:                                inhibitmenu state
                   5888:                      - a ref to a url - no return value, but the string is
                   5889:                                         updated to include the neccessary cgi
                   5890:                                         args to preserve the inhibitmenu state
                   5891: 
                   5892: =cut
                   5893: 
                   5894: sub inhibit_menu_check {
                   5895:     my ($arg) = @_;
                   5896:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   5897:     if ($arg eq 'input') {
                   5898: 	if ($env{'form.inhibitmenu'}) {
                   5899: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   5900: 	} else {
                   5901: 	    return
                   5902: 	}
                   5903:     }
                   5904:     if ($env{'form.inhibitmenu'}) {
                   5905: 	if (ref($arg)) {
                   5906: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   5907: 	} elsif ($arg eq '') {
                   5908: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   5909: 	} else {
                   5910: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   5911: 	}
                   5912:     }
                   5913:     if (!ref($arg)) {
                   5914: 	return $arg;
                   5915:     }
                   5916: }
                   5917: 
1.251     albertel 5918: ###############################################
1.182     matthew  5919: 
                   5920: =pod
                   5921: 
1.549     albertel 5922: =back
                   5923: 
                   5924: =head1 User Information Routines
                   5925: 
                   5926: =over 4
                   5927: 
1.405     albertel 5928: =item * &get_users_function()
1.182     matthew  5929: 
                   5930: Used by &bodytag to determine the current users primary role.
                   5931: Returns either 'student','coordinator','admin', or 'author'.
                   5932: 
                   5933: =cut
                   5934: 
                   5935: ###############################################
                   5936: sub get_users_function {
                   5937:     my $function = 'student';
1.258     albertel 5938:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  5939:         $function='coordinator';
                   5940:     }
1.258     albertel 5941:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  5942:         $function='admin';
                   5943:     }
1.258     albertel 5944:     if (($env{'request.role'}=~/^(au|ca)/) ||
1.182     matthew  5945:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   5946:         $function='author';
                   5947:     }
                   5948:     return $function;
1.54      www      5949: }
1.99      www      5950: 
                   5951: ###############################################
                   5952: 
1.233     raeburn  5953: =pod
                   5954: 
1.542     raeburn  5955: =item * &check_user_status()
1.274     raeburn  5956: 
                   5957: Determines current status of supplied role for a
                   5958: specific user. Roles can be active, previous or future.
                   5959: 
                   5960: Inputs: 
                   5961: user's domain, user's username, course's domain,
1.375     raeburn  5962: course's number, optional section ID.
1.274     raeburn  5963: 
                   5964: Outputs:
                   5965: role status: active, previous or future. 
                   5966: 
                   5967: =cut
                   5968: 
                   5969: sub check_user_status {
1.412     raeburn  5970:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  5971:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   5972:     my @uroles = keys %userinfo;
                   5973:     my $srchstr;
                   5974:     my $active_chk = 'none';
1.412     raeburn  5975:     my $now = time;
1.274     raeburn  5976:     if (@uroles > 0) {
1.412     raeburn  5977:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  5978:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   5979:         } else {
1.412     raeburn  5980:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   5981:         }
                   5982:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  5983:             my $role_end = 0;
                   5984:             my $role_start = 0;
                   5985:             $active_chk = 'active';
1.412     raeburn  5986:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   5987:                 $role_end = $1;
                   5988:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   5989:                     $role_start = $1;
1.274     raeburn  5990:                 }
                   5991:             }
                   5992:             if ($role_start > 0) {
1.412     raeburn  5993:                 if ($now < $role_start) {
1.274     raeburn  5994:                     $active_chk = 'future';
                   5995:                 }
                   5996:             }
                   5997:             if ($role_end > 0) {
1.412     raeburn  5998:                 if ($now > $role_end) {
1.274     raeburn  5999:                     $active_chk = 'previous';
                   6000:                 }
                   6001:             }
                   6002:         }
                   6003:     }
                   6004:     return $active_chk;
                   6005: }
                   6006: 
                   6007: ###############################################
                   6008: 
                   6009: =pod
                   6010: 
1.405     albertel 6011: =item * &get_sections()
1.233     raeburn  6012: 
                   6013: Determines all the sections for a course including
                   6014: sections with students and sections containing other roles.
1.419     raeburn  6015: Incoming parameters: 
                   6016: 
                   6017: 1. domain
                   6018: 2. course number 
                   6019: 3. reference to array containing roles for which sections should 
                   6020: be gathered (optional).
                   6021: 4. reference to array containing status types for which sections 
                   6022: should be gathered (optional).
                   6023: 
                   6024: If the third argument is undefined, sections are gathered for any role. 
                   6025: If the fourth argument is undefined, sections are gathered for any status.
                   6026: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6027:  
1.374     raeburn  6028: Returns section hash (keys are section IDs, values are
                   6029: number of users in each section), subject to the
1.419     raeburn  6030: optional roles filter, optional status filter 
1.233     raeburn  6031: 
                   6032: =cut
                   6033: 
                   6034: ###############################################
                   6035: sub get_sections {
1.419     raeburn  6036:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6037:     if (!defined($cdom) || !defined($cnum)) {
                   6038:         my $cid =  $env{'request.course.id'};
                   6039: 
                   6040: 	return if (!defined($cid));
                   6041: 
                   6042:         $cdom = $env{'course.'.$cid.'.domain'};
                   6043:         $cnum = $env{'course.'.$cid.'.num'};
                   6044:     }
                   6045: 
                   6046:     my %sectioncount;
1.419     raeburn  6047:     my $now = time;
1.240     albertel 6048: 
1.366     albertel 6049:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6050: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6051: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6052: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6053:         my $start_index = &Apache::loncoursedata::CL_START();
                   6054:         my $end_index = &Apache::loncoursedata::CL_END();
                   6055:         my $status;
1.366     albertel 6056: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6057: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6058: 				                     $data->[$status_index],
                   6059:                                                      $data->[$start_index],
                   6060:                                                      $data->[$end_index]);
                   6061:             if ($stu_status eq 'Active') {
                   6062:                 $status = 'active';
                   6063:             } elsif ($end < $now) {
                   6064:                 $status = 'previous';
                   6065:             } elsif ($start > $now) {
                   6066:                 $status = 'future';
                   6067:             } 
                   6068: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   6069:                 if ((!defined($possible_status)) || (($status ne '') && 
                   6070:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   6071: 		    $sectioncount{$section}++;
                   6072:                 }
1.240     albertel 6073: 	    }
                   6074: 	}
                   6075:     }
                   6076:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6077:     foreach my $user (sort(keys(%courseroles))) {
                   6078: 	if ($user !~ /^(\w{2})/) { next; }
                   6079: 	my ($role) = ($user =~ /^(\w{2})/);
                   6080: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  6081: 	my ($section,$status);
1.240     albertel 6082: 	if ($role eq 'cr' &&
                   6083: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   6084: 	    $section=$1;
                   6085: 	}
                   6086: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   6087: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  6088:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   6089:         if ($end == -1 && $start == -1) {
                   6090:             next; #deleted role
                   6091:         }
                   6092:         if (!defined($possible_status)) { 
                   6093:             $sectioncount{$section}++;
                   6094:         } else {
                   6095:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   6096:                 $status = 'active';
                   6097:             } elsif ($end < $now) {
                   6098:                 $status = 'future';
                   6099:             } elsif ($start > $now) {
                   6100:                 $status = 'previous';
                   6101:             }
                   6102:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   6103:                 $sectioncount{$section}++;
                   6104:             }
                   6105:         }
1.233     raeburn  6106:     }
1.366     albertel 6107:     return %sectioncount;
1.233     raeburn  6108: }
                   6109: 
1.274     raeburn  6110: ###############################################
1.294     raeburn  6111: 
                   6112: =pod
1.405     albertel 6113: 
                   6114: =item * &get_course_users()
                   6115: 
1.275     raeburn  6116: Retrieves usernames:domains for users in the specified course
                   6117: with specific role(s), and access status. 
                   6118: 
                   6119: Incoming parameters:
1.277     albertel 6120: 1. course domain
                   6121: 2. course number
                   6122: 3. access status: users must have - either active, 
1.275     raeburn  6123: previous, future, or all.
1.277     albertel 6124: 4. reference to array of permissible roles
1.288     raeburn  6125: 5. reference to array of section restrictions (optional)
                   6126: 6. reference to results object (hash of hashes).
                   6127: 7. reference to optional userdata hash
1.609     raeburn  6128: 8. reference to optional statushash
1.630     raeburn  6129: 9. flag if privileged users (except those set to unhide in
                   6130:    course settings) should be excluded    
1.609     raeburn  6131: Keys of top level results hash are roles.
1.275     raeburn  6132: Keys of inner hashes are username:domain, with 
                   6133: values set to access type.
1.288     raeburn  6134: Optional userdata hash returns an array with arguments in the 
                   6135: same order as loncoursedata::get_classlist() for student data.
                   6136: 
1.609     raeburn  6137: Optional statushash returns
                   6138: 
1.288     raeburn  6139: Entries for end, start, section and status are blank because
                   6140: of the possibility of multiple values for non-student roles.
                   6141: 
1.275     raeburn  6142: =cut
1.405     albertel 6143: 
1.275     raeburn  6144: ###############################################
1.405     albertel 6145: 
1.275     raeburn  6146: sub get_course_users {
1.630     raeburn  6147:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  6148:     my %idx = ();
1.419     raeburn  6149:     my %seclists;
1.288     raeburn  6150: 
                   6151:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   6152:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   6153:     $idx{end} = &Apache::loncoursedata::CL_END();
                   6154:     $idx{start} = &Apache::loncoursedata::CL_START();
                   6155:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   6156:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   6157:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   6158:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   6159: 
1.290     albertel 6160:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 6161:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  6162:         my $now = time;
1.277     albertel 6163:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  6164:             my $match = 0;
1.412     raeburn  6165:             my $secmatch = 0;
1.419     raeburn  6166:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  6167:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  6168:             if ($section eq '') {
                   6169:                 $section = 'none';
                   6170:             }
1.291     albertel 6171:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 6172:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  6173:                     $secmatch = 1;
                   6174:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 6175:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  6176:                         $secmatch = 1;
                   6177:                     }
                   6178:                 } else {  
1.419     raeburn  6179: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  6180: 		        $secmatch = 1;
                   6181:                     }
1.290     albertel 6182: 		}
1.412     raeburn  6183:                 if (!$secmatch) {
                   6184:                     next;
                   6185:                 }
1.419     raeburn  6186:             }
1.275     raeburn  6187:             if (defined($$types{'active'})) {
1.288     raeburn  6188:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  6189:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  6190:                     $match = 1;
1.275     raeburn  6191:                 }
                   6192:             }
                   6193:             if (defined($$types{'previous'})) {
1.609     raeburn  6194:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  6195:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  6196:                     $match = 1;
1.275     raeburn  6197:                 }
                   6198:             }
                   6199:             if (defined($$types{'future'})) {
1.609     raeburn  6200:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  6201:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  6202:                     $match = 1;
1.275     raeburn  6203:                 }
                   6204:             }
1.609     raeburn  6205:             if ($match) {
                   6206:                 push(@{$seclists{$student}},$section);
                   6207:                 if (ref($userdata) eq 'HASH') {
                   6208:                     $$userdata{$student} = $$classlist{$student};
                   6209:                 }
                   6210:                 if (ref($statushash) eq 'HASH') {
                   6211:                     $statushash->{$student}{'st'}{$section} = $status;
                   6212:                 }
1.288     raeburn  6213:             }
1.275     raeburn  6214:         }
                   6215:     }
1.412     raeburn  6216:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  6217:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6218:         my $now = time;
1.609     raeburn  6219:         my %displaystatus = ( previous => 'Expired',
                   6220:                               active   => 'Active',
                   6221:                               future   => 'Future',
                   6222:                             );
1.630     raeburn  6223:         my %nothide;
                   6224:         if ($hidepriv) {
                   6225:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   6226:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   6227:                 if ($user !~ /:/) {
                   6228:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   6229:                 } else {
                   6230:                     $nothide{$user} = 1;
                   6231:                 }
                   6232:             }
                   6233:         }
1.439     raeburn  6234:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  6235:             my $match = 0;
1.412     raeburn  6236:             my $secmatch = 0;
1.439     raeburn  6237:             my $status;
1.412     raeburn  6238:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  6239:             $user =~ s/:$//;
1.439     raeburn  6240:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   6241:             if ($end == -1 || $start == -1) {
                   6242:                 next;
                   6243:             }
                   6244:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   6245:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  6246:                 my ($uname,$udom) = split(/:/,$user);
                   6247:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 6248:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  6249:                         $secmatch = 1;
                   6250:                     } elsif ($usec eq '') {
1.420     albertel 6251:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  6252:                             $secmatch = 1;
                   6253:                         }
                   6254:                     } else {
                   6255:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   6256:                             $secmatch = 1;
                   6257:                         }
                   6258:                     }
                   6259:                     if (!$secmatch) {
                   6260:                         next;
                   6261:                     }
1.288     raeburn  6262:                 }
1.419     raeburn  6263:                 if ($usec eq '') {
                   6264:                     $usec = 'none';
                   6265:                 }
1.275     raeburn  6266:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  6267:                     if ($hidepriv) {
                   6268:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   6269:                             (!$nothide{$uname.':'.$udom})) {
                   6270:                             next;
                   6271:                         }
                   6272:                     }
1.503     raeburn  6273:                     if ($end > 0 && $end < $now) {
1.439     raeburn  6274:                         $status = 'previous';
                   6275:                     } elsif ($start > $now) {
                   6276:                         $status = 'future';
                   6277:                     } else {
                   6278:                         $status = 'active';
                   6279:                     }
1.277     albertel 6280:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  6281:                         if ($status eq $type) {
1.420     albertel 6282:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  6283:                                 push(@{$$users{$role}{$user}},$type);
                   6284:                             }
1.288     raeburn  6285:                             $match = 1;
                   6286:                         }
                   6287:                     }
1.419     raeburn  6288:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   6289:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   6290: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   6291:                         }
1.420     albertel 6292:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  6293:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   6294:                         }
1.609     raeburn  6295:                         if (ref($statushash) eq 'HASH') {
                   6296:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   6297:                         }
1.275     raeburn  6298:                     }
                   6299:                 }
                   6300:             }
                   6301:         }
1.290     albertel 6302:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  6303:             if ((defined($cdom)) && (defined($cnum))) {
                   6304:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   6305:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   6306:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  6307:                     next if ($owner eq '');
                   6308:                     my ($ownername,$ownerdom);
                   6309:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   6310:                         $ownername = $1;
                   6311:                         $ownerdom = $2;
                   6312:                     } else {
                   6313:                         $ownername = $owner;
                   6314:                         $ownerdom = $cdom;
                   6315:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  6316:                     }
                   6317:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 6318:                     if (defined($userdata) && 
1.609     raeburn  6319: 			!exists($$userdata{$owner})) {
                   6320: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   6321:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   6322:                             push(@{$seclists{$owner}},'none');
                   6323:                         }
                   6324:                         if (ref($statushash) eq 'HASH') {
                   6325:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  6326:                         }
1.290     albertel 6327: 		    }
1.279     raeburn  6328:                 }
                   6329:             }
                   6330:         }
1.419     raeburn  6331:         foreach my $user (keys(%seclists)) {
                   6332:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   6333:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   6334:         }
1.275     raeburn  6335:     }
                   6336:     return;
                   6337: }
                   6338: 
1.288     raeburn  6339: sub get_user_info {
                   6340:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 6341:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   6342: 	&plainname($uname,$udom,'lastname');
1.291     albertel 6343:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  6344:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  6345:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   6346:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  6347:     return;
                   6348: }
1.275     raeburn  6349: 
1.472     raeburn  6350: ###############################################
                   6351: 
                   6352: =pod
                   6353: 
                   6354: =item * &get_user_quota()
                   6355: 
                   6356: Retrieves quota assigned for storage of portfolio files for a user  
                   6357: 
                   6358: Incoming parameters:
                   6359: 1. user's username
                   6360: 2. user's domain
                   6361: 
                   6362: Returns:
1.536     raeburn  6363: 1. Disk quota (in Mb) assigned to student.
                   6364: 2. (Optional) Type of setting: custom or default
                   6365:    (individually assigned or default for user's 
                   6366:    institutional status).
                   6367: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   6368:    or student - types as defined in localenroll::inst_usertypes 
                   6369:    for user's domain, which determines default quota for user.
                   6370: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  6371: 
                   6372: If a value has been stored in the user's environment, 
1.536     raeburn  6373: it will return that, otherwise it returns the maximal default
                   6374: defined for the user's instituional status(es) in the domain.
1.472     raeburn  6375: 
                   6376: =cut
                   6377: 
                   6378: ###############################################
                   6379: 
                   6380: 
                   6381: sub get_user_quota {
                   6382:     my ($uname,$udom) = @_;
1.536     raeburn  6383:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  6384:     if (!defined($udom)) {
                   6385:         $udom = $env{'user.domain'};
                   6386:     }
                   6387:     if (!defined($uname)) {
                   6388:         $uname = $env{'user.name'};
                   6389:     }
                   6390:     if (($udom eq '' || $uname eq '') ||
                   6391:         ($udom eq 'public') && ($uname eq 'public')) {
                   6392:         $quota = 0;
1.536     raeburn  6393:         $quotatype = 'default';
                   6394:         $defquota = 0; 
1.472     raeburn  6395:     } else {
1.536     raeburn  6396:         my $inststatus;
1.472     raeburn  6397:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   6398:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  6399:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  6400:         } else {
1.536     raeburn  6401:             my %userenv = 
                   6402:                 &Apache::lonnet::get('environment',['portfolioquota',
                   6403:                                      'inststatus'],$udom,$uname);
1.472     raeburn  6404:             my ($tmp) = keys(%userenv);
                   6405:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   6406:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  6407:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  6408:             } else {
                   6409:                 undef(%userenv);
                   6410:             }
                   6411:         }
1.536     raeburn  6412:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  6413:         if ($quota eq '') {
1.536     raeburn  6414:             $quota = $defquota;
                   6415:             $quotatype = 'default';
                   6416:         } else {
                   6417:             $quotatype = 'custom';
1.472     raeburn  6418:         }
                   6419:     }
1.536     raeburn  6420:     if (wantarray) {
                   6421:         return ($quota,$quotatype,$settingstatus,$defquota);
                   6422:     } else {
                   6423:         return $quota;
                   6424:     }
1.472     raeburn  6425: }
                   6426: 
                   6427: ###############################################
                   6428: 
                   6429: =pod
                   6430: 
                   6431: =item * &default_quota()
                   6432: 
1.536     raeburn  6433: Retrieves default quota assigned for storage of user portfolio files,
                   6434: given an (optional) user's institutional status.
1.472     raeburn  6435: 
                   6436: Incoming parameters:
                   6437: 1. domain
1.536     raeburn  6438: 2. (Optional) institutional status(es).  This is a : separated list of 
                   6439:    status types (e.g., faculty, staff, student etc.)
                   6440:    which apply to the user for whom the default is being retrieved.
                   6441:    If the institutional status string in undefined, the domain
                   6442:    default quota will be returned. 
1.472     raeburn  6443: 
                   6444: Returns:
                   6445: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  6446: 2. (Optional) institutional type which determined the value of the
                   6447:    default quota.
1.472     raeburn  6448: 
                   6449: If a value has been stored in the domain's configuration db,
                   6450: it will return that, otherwise it returns 20 (for backwards 
                   6451: compatibility with domains which have not set up a configuration
                   6452: db file; the original statically defined portfolio quota was 20 Mb). 
                   6453: 
1.536     raeburn  6454: If the user's status includes multiple types (e.g., staff and student),
                   6455: the largest default quota which applies to the user determines the
                   6456: default quota returned.
                   6457: 
1.472     raeburn  6458: =cut
                   6459: 
                   6460: ###############################################
                   6461: 
                   6462: 
                   6463: sub default_quota {
1.536     raeburn  6464:     my ($udom,$inststatus) = @_;
                   6465:     my ($defquota,$settingstatus);
                   6466:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  6467:                                             ['quotas'],$udom);
                   6468:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  6469:         if ($inststatus ne '') {
                   6470:             my @statuses = split(/:/,$inststatus);
                   6471:             foreach my $item (@statuses) {
1.622     raeburn  6472:                 if ($quotahash{'quotas'}{$item} ne '') {
1.536     raeburn  6473:                     if ($defquota eq '') {
1.622     raeburn  6474:                         $defquota = $quotahash{'quotas'}{$item};
1.536     raeburn  6475:                         $settingstatus = $item;
1.622     raeburn  6476:                     } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   6477:                         $defquota = $quotahash{'quotas'}{$item};
1.536     raeburn  6478:                         $settingstatus = $item;
                   6479:                     }
                   6480:                 }
                   6481:             }
                   6482:         }
                   6483:         if ($defquota eq '') {
1.622     raeburn  6484:             $defquota = $quotahash{'quotas'}{'default'};
1.536     raeburn  6485:             $settingstatus = 'default';
                   6486:         }
                   6487:     } else {
                   6488:         $settingstatus = 'default';
                   6489:         $defquota = 20;
                   6490:     }
                   6491:     if (wantarray) {
                   6492:         return ($defquota,$settingstatus);
1.472     raeburn  6493:     } else {
1.536     raeburn  6494:         return $defquota;
1.472     raeburn  6495:     }
                   6496: }
                   6497: 
1.384     raeburn  6498: sub get_secgrprole_info {
                   6499:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   6500:     my %sections_count = &get_sections($cdom,$cnum);
                   6501:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   6502:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   6503:     my @groups = sort(keys(%curr_groups));
                   6504:     my $allroles = [];
                   6505:     my $rolehash;
                   6506:     my $accesshash = {
                   6507:                      active => 'Currently has access',
                   6508:                      future => 'Will have future access',
                   6509:                      previous => 'Previously had access',
                   6510:                   };
                   6511:     if ($needroles) {
                   6512:         $rolehash = {'all' => 'all'};
1.385     albertel 6513:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   6514: 	if (&Apache::lonnet::error(%user_roles)) {
                   6515: 	    undef(%user_roles);
                   6516: 	}
                   6517:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  6518:             my ($role)=split(/\:/,$item,2);
                   6519:             if ($role eq 'cr') { next; }
                   6520:             if ($role =~ /^cr/) {
                   6521:                 $$rolehash{$role} = (split('/',$role))[3];
                   6522:             } else {
                   6523:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   6524:             }
                   6525:         }
                   6526:         foreach my $key (sort(keys(%{$rolehash}))) {
                   6527:             push(@{$allroles},$key);
                   6528:         }
                   6529:         push (@{$allroles},'st');
                   6530:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   6531:     }
                   6532:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   6533: }
                   6534: 
1.555     raeburn  6535: sub user_picker {
1.627     raeburn  6536:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  6537:     my $currdom = $dom;
                   6538:     my %curr_selected = (
                   6539:                         srchin => 'dom',
1.580     raeburn  6540:                         srchby => 'lastname',
1.555     raeburn  6541:                       );
                   6542:     my $srchterm;
1.625     raeburn  6543:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  6544:         if ($srch->{'srchby'} ne '') {
                   6545:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   6546:         }
                   6547:         if ($srch->{'srchin'} ne '') {
                   6548:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   6549:         }
                   6550:         if ($srch->{'srchtype'} ne '') {
                   6551:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   6552:         }
                   6553:         if ($srch->{'srchdomain'} ne '') {
                   6554:             $currdom = $srch->{'srchdomain'};
                   6555:         }
                   6556:         $srchterm = $srch->{'srchterm'};
                   6557:     }
                   6558:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  6559:                     'usr'       => 'Search criteria',
1.563     raeburn  6560:                     'doma'      => 'Domain/institution to search',
1.558     albertel 6561:                     'uname'     => 'username',
                   6562:                     'lastname'  => 'last name',
1.555     raeburn  6563:                     'lastfirst' => 'last name, first name',
1.558     albertel 6564:                     'crs'       => 'in this course',
1.576     raeburn  6565:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 6566:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  6567:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 6568:                     'exact'     => 'is',
                   6569:                     'contains'  => 'contains',
1.569     raeburn  6570:                     'begins'    => 'begins with',
1.571     raeburn  6571:                     'youm'      => "You must include some text to search for.",
                   6572:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   6573:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   6574:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   6575:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   6576:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   6577:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   6578:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  6579:                                        );
1.563     raeburn  6580:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   6581:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  6582: 
                   6583:     my @srchins = ('crs','dom','alc','instd');
                   6584: 
                   6585:     foreach my $option (@srchins) {
                   6586:         # FIXME 'alc' option unavailable until 
                   6587:         #       loncreateuser::print_user_query_page()
                   6588:         #       has been completed.
                   6589:         next if ($option eq 'alc');
                   6590:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  6591:         if ($curr_selected{'srchin'} eq $option) {
                   6592:             $srchinsel .= ' 
                   6593:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   6594:         } else {
                   6595:             $srchinsel .= '
                   6596:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   6597:         }
1.555     raeburn  6598:     }
1.563     raeburn  6599:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  6600: 
                   6601:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  6602:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  6603:         if ($curr_selected{'srchby'} eq $option) {
                   6604:             $srchbysel .= '
                   6605:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   6606:         } else {
                   6607:             $srchbysel .= '
                   6608:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   6609:          }
                   6610:     }
                   6611:     $srchbysel .= "\n  </select>\n";
                   6612: 
                   6613:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  6614:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  6615:         if ($curr_selected{'srchtype'} eq $option) {
                   6616:             $srchtypesel .= '
                   6617:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   6618:         } else {
                   6619:             $srchtypesel .= '
                   6620:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   6621:         }
                   6622:     }
                   6623:     $srchtypesel .= "\n  </select>\n";
                   6624: 
1.558     albertel 6625:     my ($newuserscript,$new_user_create);
1.556     raeburn  6626: 
                   6627:     if ($forcenewuser) {
1.576     raeburn  6628:         if (ref($srch) eq 'HASH') {
                   6629:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  6630:                 if ($cancreate) {
                   6631:                     $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
                   6632:                 } else {
                   6633:                     my $helplink = ' href="javascript:helpMenu('."'display'".')"';
                   6634:                     my %usertypetext = (
                   6635:                         official   => 'institutional',
                   6636:                         unofficial => 'non-institutional',
                   6637:                     );
                   6638:                     $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
                   6639:                 }
1.576     raeburn  6640:             }
                   6641:         }
                   6642: 
1.556     raeburn  6643:         $newuserscript = <<"ENDSCRIPT";
                   6644: 
1.570     raeburn  6645: function setSearch(createnew,callingForm) {
1.556     raeburn  6646:     if (createnew == 1) {
1.570     raeburn  6647:         for (var i=0; i<callingForm.srchby.length; i++) {
                   6648:             if (callingForm.srchby.options[i].value == 'uname') {
                   6649:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  6650:             }
                   6651:         }
1.570     raeburn  6652:         for (var i=0; i<callingForm.srchin.length; i++) {
                   6653:             if ( callingForm.srchin.options[i].value == 'dom') {
                   6654: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  6655:             }
                   6656:         }
1.570     raeburn  6657:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   6658:             if (callingForm.srchtype.options[i].value == 'exact') {
                   6659:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  6660:             }
                   6661:         }
1.570     raeburn  6662:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   6663:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   6664:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  6665:             }
                   6666:         }
                   6667:     }
                   6668: }
                   6669: ENDSCRIPT
1.558     albertel 6670: 
1.556     raeburn  6671:     }
                   6672: 
1.555     raeburn  6673:     my $output = <<"END_BLOCK";
1.556     raeburn  6674: <script type="text/javascript">
1.570     raeburn  6675: function validateEntry(callingForm) {
1.558     albertel 6676: 
1.556     raeburn  6677:     var checkok = 1;
1.558     albertel 6678:     var srchin;
1.570     raeburn  6679:     for (var i=0; i<callingForm.srchin.length; i++) {
                   6680: 	if ( callingForm.srchin[i].checked ) {
                   6681: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 6682: 	}
                   6683:     }
                   6684: 
1.570     raeburn  6685:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   6686:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   6687:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   6688:     var srchterm =  callingForm.srchterm.value;
                   6689:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  6690:     var msg = "";
                   6691: 
                   6692:     if (srchterm == "") {
                   6693:         checkok = 0;
1.571     raeburn  6694:         msg += "$lt{'youm'}\\n";
1.556     raeburn  6695:     }
                   6696: 
1.569     raeburn  6697:     if (srchtype== 'begins') {
                   6698:         if (srchterm.length < 2) {
                   6699:             checkok = 0;
1.571     raeburn  6700:             msg += "$lt{'thte'}\\n";
1.569     raeburn  6701:         }
                   6702:     }
                   6703: 
1.556     raeburn  6704:     if (srchtype== 'contains') {
                   6705:         if (srchterm.length < 3) {
                   6706:             checkok = 0;
1.571     raeburn  6707:             msg += "$lt{'thet'}\\n";
1.556     raeburn  6708:         }
                   6709:     }
                   6710:     if (srchin == 'instd') {
                   6711:         if (srchdomain == '') {
                   6712:             checkok = 0;
1.571     raeburn  6713:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  6714:         }
                   6715:     }
                   6716:     if (srchin == 'dom') {
                   6717:         if (srchdomain == '') {
                   6718:             checkok = 0;
1.571     raeburn  6719:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  6720:         }
                   6721:     }
                   6722:     if (srchby == 'lastfirst') {
                   6723:         if (srchterm.indexOf(",") == -1) {
                   6724:             checkok = 0;
1.571     raeburn  6725:             msg += "$lt{'whus'}\\n";
1.556     raeburn  6726:         }
                   6727:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   6728:             checkok = 0;
1.571     raeburn  6729:             msg += "$lt{'whse'}\\n";
1.556     raeburn  6730:         }
                   6731:     }
                   6732:     if (checkok == 0) {
1.571     raeburn  6733:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  6734:         return;
                   6735:     }
                   6736:     if (checkok == 1) {
1.570     raeburn  6737:         callingForm.submit();
1.556     raeburn  6738:     }
                   6739: }
                   6740: 
                   6741: $newuserscript
                   6742: 
                   6743: </script>
1.558     albertel 6744: 
                   6745: $new_user_create
                   6746: 
1.555     raeburn  6747: <table>
1.558     albertel 6748:  <tr>
1.573     raeburn  6749:   <td>$lt{'doma'}:</td>
                   6750:   <td>$domform</td>
                   6751:   </td>
                   6752:  </tr>
                   6753:  <tr>
                   6754:   <td>$lt{'usr'}:</td>
1.563     raeburn  6755:   <td>$srchbysel
                   6756:       $srchtypesel 
                   6757:       <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564     albertel 6758:       $srchinsel 
1.563     raeburn  6759:   </td>
                   6760:  </tr>
1.555     raeburn  6761: </table>
                   6762: <br />
                   6763: END_BLOCK
1.558     albertel 6764: 
1.555     raeburn  6765:     return $output;
                   6766: }
                   6767: 
1.612     raeburn  6768: sub user_rule_check {
1.615     raeburn  6769:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  6770:     my $response;
                   6771:     if (ref($usershash) eq 'HASH') {
                   6772:         foreach my $user (keys(%{$usershash})) {
                   6773:             my ($uname,$udom) = split(/:/,$user);
                   6774:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  6775:             my ($id,$newuser);
1.612     raeburn  6776:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  6777:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  6778:                 $id = $usershash->{$user}->{'id'};
                   6779:             }
                   6780:             my $inst_response;
                   6781:             if (ref($checks) eq 'HASH') {
                   6782:                 if (defined($checks->{'username'})) {
1.615     raeburn  6783:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  6784:                         &Apache::lonnet::get_instuser($udom,$uname);
                   6785:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  6786:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  6787:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   6788:                 }
1.615     raeburn  6789:             } else {
                   6790:                 ($inst_response,%{$inst_results->{$user}}) =
                   6791:                     &Apache::lonnet::get_instuser($udom,$uname);
                   6792:                 return;
1.612     raeburn  6793:             }
1.615     raeburn  6794:             if (!$got_rules->{$udom}) {
1.612     raeburn  6795:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   6796:                                                   ['usercreation'],$udom);
                   6797:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  6798:                     foreach my $item ('username','id') {
1.612     raeburn  6799:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   6800:                             $$curr_rules{$udom}{$item} = 
                   6801:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  6802:                         }
                   6803:                     }
                   6804:                 }
1.615     raeburn  6805:                 $got_rules->{$udom} = 1;  
1.585     raeburn  6806:             }
1.612     raeburn  6807:             foreach my $item (keys(%{$checks})) {
                   6808:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   6809:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   6810:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   6811:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   6812:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   6813:                                 if ($rule_check{$rule}) {
                   6814:                                     $$rulematch{$user}{$item} = $rule;
                   6815:                                     if ($inst_response eq 'ok') {
1.615     raeburn  6816:                                         if (ref($inst_results) eq 'HASH') {
                   6817:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   6818:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   6819:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   6820:                                                 }
1.612     raeburn  6821:                                             }
                   6822:                                         }
1.615     raeburn  6823:                                     }
                   6824:                                     last;
1.585     raeburn  6825:                                 }
                   6826:                             }
                   6827:                         }
                   6828:                     }
                   6829:                 }
                   6830:             }
                   6831:         }
                   6832:     }
1.612     raeburn  6833:     return;
                   6834: }
                   6835: 
                   6836: sub user_rule_formats {
                   6837:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   6838:     my %text = ( 
                   6839:                  'username' => 'Usernames',
                   6840:                  'id'       => 'IDs',
                   6841:                );
                   6842:     my $output;
                   6843:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   6844:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   6845:         if (@{$ruleorder} > 0) {
                   6846:             $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
                   6847:             foreach my $rule (@{$ruleorder}) {
                   6848:                 if (ref($curr_rules) eq 'ARRAY') {
                   6849:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   6850:                         if (ref($rules->{$rule}) eq 'HASH') {
                   6851:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   6852:                                         $rules->{$rule}{'desc'}.'</li>';
                   6853:                         }
                   6854:                     }
                   6855:                 }
                   6856:             }
                   6857:             $output .= '</ul>';
                   6858:         }
                   6859:     }
                   6860:     return $output;
                   6861: }
                   6862: 
                   6863: sub instrule_disallow_msg {
1.615     raeburn  6864:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  6865:     my $response;
                   6866:     my %text = (
                   6867:                   item   => 'username',
                   6868:                   items  => 'usernames',
                   6869:                   match  => 'matches',
                   6870:                   do     => 'does',
                   6871:                   action => 'a username',
                   6872:                   one    => 'one',
                   6873:                );
                   6874:     if ($count > 1) {
                   6875:         $text{'item'} = 'usernames';
                   6876:         $text{'match'} ='match';
                   6877:         $text{'do'} = 'do';
                   6878:         $text{'action'} = 'usernames',
                   6879:         $text{'one'} = 'ones';
                   6880:     }
                   6881:     if ($checkitem eq 'id') {
                   6882:         $text{'items'} = 'IDs';
                   6883:         $text{'item'} = 'ID';
                   6884:         $text{'action'} = 'an ID';
1.615     raeburn  6885:         if ($count > 1) {
                   6886:             $text{'item'} = 'IDs';
                   6887:             $text{'action'} = 'IDs';
                   6888:         }
1.612     raeburn  6889:     }
1.674     bisitz   6890:     $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615     raeburn  6891:     if ($mode eq 'upload') {
                   6892:         if ($checkitem eq 'username') {
                   6893:             $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   6894:         } elsif ($checkitem eq 'id') {
1.674     bisitz   6895:             $response .= &mt("Either upload a file which includes $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615     raeburn  6896:         }
1.669     raeburn  6897:     } elsif ($mode eq 'selfcreate') {
                   6898:         if ($checkitem eq 'id') {
                   6899:             $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
                   6900:         }
1.615     raeburn  6901:     } else {
                   6902:         if ($checkitem eq 'username') {
                   6903:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   6904:         } elsif ($checkitem eq 'id') {
                   6905:             $response .= &mt("You must either choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
                   6906:         }
1.612     raeburn  6907:     }
                   6908:     return $response;
1.585     raeburn  6909: }
                   6910: 
1.624     raeburn  6911: sub personal_data_fieldtitles {
                   6912:     my %fieldtitles = &Apache::lonlocal::texthash (
                   6913:                         id => 'Student/Employee ID',
                   6914:                         permanentemail => 'E-mail address',
                   6915:                         lastname => 'Last Name',
                   6916:                         firstname => 'First Name',
                   6917:                         middlename => 'Middle Name',
                   6918:                         generation => 'Generation',
                   6919:                         gen => 'Generation',
                   6920:                    );
                   6921:     return %fieldtitles;
                   6922: }
                   6923: 
1.642     raeburn  6924: sub sorted_inst_types {
                   6925:     my ($dom) = @_;
                   6926:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   6927:     my $othertitle = &mt('All users');
                   6928:     if ($env{'request.course.id'}) {
1.668     raeburn  6929:         $othertitle  = &mt('Any users');
1.642     raeburn  6930:     }
                   6931:     my @types;
                   6932:     if (ref($order) eq 'ARRAY') {
                   6933:         @types = @{$order};
                   6934:     }
                   6935:     if (@types == 0) {
                   6936:         if (ref($usertypes) eq 'HASH') {
                   6937:             @types = sort(keys(%{$usertypes}));
                   6938:         }
                   6939:     }
                   6940:     if (keys(%{$usertypes}) > 0) {
                   6941:         $othertitle = &mt('Other users');
                   6942:     }
                   6943:     return ($othertitle,$usertypes,\@types);
                   6944: }
                   6945: 
1.645     raeburn  6946: sub get_institutional_codes {
                   6947:     my ($settings,$allcourses,$LC_code) = @_;
                   6948: # Get complete list of course sections to update
                   6949:     my @currsections = ();
                   6950:     my @currxlists = ();
                   6951:     my $coursecode = $$settings{'internal.coursecode'};
                   6952: 
                   6953:     if ($$settings{'internal.sectionnums'} ne '') {
                   6954:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   6955:     }
                   6956: 
                   6957:     if ($$settings{'internal.crosslistings'} ne '') {
                   6958:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   6959:     }
                   6960: 
                   6961:     if (@currxlists > 0) {
                   6962:         foreach (@currxlists) {
                   6963:             if (m/^([^:]+):(\w*)$/) {
                   6964:                 unless (grep/^$1$/,@{$allcourses}) {
                   6965:                     push @{$allcourses},$1;
                   6966:                     $$LC_code{$1} = $2;
                   6967:                 }
                   6968:             }
                   6969:         }
                   6970:     }
                   6971:  
                   6972:     if (@currsections > 0) {
                   6973:         foreach (@currsections) {
                   6974:             if (m/^(\w+):(\w*)$/) {
                   6975:                 my $sec = $coursecode.$1;
                   6976:                 my $lc_sec = $2;
                   6977:                 unless (grep/^$sec$/,@{$allcourses}) {
                   6978:                     push @{$allcourses},$sec;
                   6979:                     $$LC_code{$sec} = $lc_sec;
                   6980:                 }
                   6981:             }
                   6982:         }
                   6983:     }
                   6984:     return;
                   6985: }
                   6986: 
1.112     bowersj2 6987: =pod
                   6988: 
1.549     albertel 6989: =back
                   6990: 
                   6991: =head1 HTTP Helpers
                   6992: 
                   6993: =over 4
                   6994: 
1.648     raeburn  6995: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 6996: 
1.258     albertel 6997: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 6998: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 6999: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 7000: 
                   7001: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   7002: $possible_names is an ref to an array of form element names.  As an example:
                   7003: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 7004: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 7005: 
                   7006: =cut
1.1       albertel 7007: 
1.6       albertel 7008: sub get_unprocessed_cgi {
1.25      albertel 7009:   my ($query,$possible_names)= @_;
1.26      matthew  7010:   # $Apache::lonxml::debug=1;
1.356     albertel 7011:   foreach my $pair (split(/&/,$query)) {
                   7012:     my ($name, $value) = split(/=/,$pair);
1.369     www      7013:     $name = &unescape($name);
1.25      albertel 7014:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   7015:       $value =~ tr/+/ /;
                   7016:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 7017:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 7018:     }
1.16      harris41 7019:   }
1.6       albertel 7020: }
                   7021: 
1.112     bowersj2 7022: =pod
                   7023: 
1.648     raeburn  7024: =item * &cacheheader() 
1.112     bowersj2 7025: 
                   7026: returns cache-controlling header code
                   7027: 
                   7028: =cut
                   7029: 
1.7       albertel 7030: sub cacheheader {
1.258     albertel 7031:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 7032:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   7033:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 7034:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   7035:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 7036:     return $output;
1.7       albertel 7037: }
                   7038: 
1.112     bowersj2 7039: =pod
                   7040: 
1.648     raeburn  7041: =item * &no_cache($r) 
1.112     bowersj2 7042: 
                   7043: specifies header code to not have cache
                   7044: 
                   7045: =cut
                   7046: 
1.9       albertel 7047: sub no_cache {
1.216     albertel 7048:     my ($r) = @_;
                   7049:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 7050: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 7051:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   7052:     $r->no_cache(1);
                   7053:     $r->header_out("Expires" => $date);
                   7054:     $r->header_out("Pragma" => "no-cache");
1.123     www      7055: }
                   7056: 
                   7057: sub content_type {
1.181     albertel 7058:     my ($r,$type,$charset) = @_;
1.299     foxr     7059:     if ($r) {
                   7060: 	#  Note that printout.pl calls this with undef for $r.
                   7061: 	&no_cache($r);
                   7062:     }
1.258     albertel 7063:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 7064:     unless ($charset) {
                   7065: 	$charset=&Apache::lonlocal::current_encoding;
                   7066:     }
                   7067:     if ($charset) { $type.='; charset='.$charset; }
                   7068:     if ($r) {
                   7069: 	$r->content_type($type);
                   7070:     } else {
                   7071: 	print("Content-type: $type\n\n");
                   7072:     }
1.9       albertel 7073: }
1.25      albertel 7074: 
1.112     bowersj2 7075: =pod
                   7076: 
1.648     raeburn  7077: =item * &add_to_env($name,$value) 
1.112     bowersj2 7078: 
1.258     albertel 7079: adds $name to the %env hash with value
1.112     bowersj2 7080: $value, if $name already exists, the entry is converted to an array
                   7081: reference and $value is added to the array.
                   7082: 
                   7083: =cut
                   7084: 
1.25      albertel 7085: sub add_to_env {
                   7086:   my ($name,$value)=@_;
1.258     albertel 7087:   if (defined($env{$name})) {
                   7088:     if (ref($env{$name})) {
1.25      albertel 7089:       #already have multiple values
1.258     albertel 7090:       push(@{ $env{$name} },$value);
1.25      albertel 7091:     } else {
                   7092:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 7093:       my $first=$env{$name};
                   7094:       undef($env{$name});
                   7095:       push(@{ $env{$name} },$first,$value);
1.25      albertel 7096:     }
                   7097:   } else {
1.258     albertel 7098:     $env{$name}=$value;
1.25      albertel 7099:   }
1.31      albertel 7100: }
1.149     albertel 7101: 
                   7102: =pod
                   7103: 
1.648     raeburn  7104: =item * &get_env_multiple($name) 
1.149     albertel 7105: 
1.258     albertel 7106: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 7107: values may be defined and end up as an array ref.
                   7108: 
                   7109: returns an array of values
                   7110: 
                   7111: =cut
                   7112: 
                   7113: sub get_env_multiple {
                   7114:     my ($name) = @_;
                   7115:     my @values;
1.258     albertel 7116:     if (defined($env{$name})) {
1.149     albertel 7117:         # exists is it an array
1.258     albertel 7118:         if (ref($env{$name})) {
                   7119:             @values=@{ $env{$name} };
1.149     albertel 7120:         } else {
1.258     albertel 7121:             $values[0]=$env{$name};
1.149     albertel 7122:         }
                   7123:     }
                   7124:     return(@values);
                   7125: }
                   7126: 
1.660     raeburn  7127: sub ask_for_embedded_content {
                   7128:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   7129:     my $upload_output = '
                   7130:    <form name="upload_embedded" action="'.$actionurl.'"
                   7131:                   method="post" enctype="multipart/form-data">';
                   7132:     $upload_output .= $state;
1.661     raeburn  7133:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  7134: 
                   7135:     my $num = 0;
                   7136:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   7137:         $upload_output .= &start_data_table_row().
                   7138:             '<td>'.$embed_file.'</td><td>';
                   7139:         if ($args->{'ignore_remote_references'}
                   7140:             && $embed_file =~ m{^\w+://}) {
                   7141:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   7142:         } elsif ($args->{'error_on_invalid_names'}
                   7143:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   7144: 
                   7145:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   7146: 
                   7147:         } else {
                   7148:             $upload_output .='
1.661     raeburn  7149:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  7150:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   7151:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   7152:             $upload_output .=
                   7153:                 "\n\t\t".
                   7154:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   7155:                 $attrib.'" />';
                   7156:             if (exists($$codebase{$embed_file})) {
                   7157:                 $upload_output .=
                   7158:                     "\n\t\t".
                   7159:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   7160:                     &escape($$codebase{$embed_file}).'" />';
                   7161:             }
                   7162:         }
                   7163:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   7164:         $num++;
                   7165:     }
                   7166:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   7167:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   7168:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   7169:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   7170:    </form>';
                   7171:     return $upload_output;
                   7172: }
                   7173: 
1.661     raeburn  7174: sub upload_embedded {
                   7175:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   7176:         $current_disk_usage) = @_;
                   7177:     my $output;
                   7178:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   7179:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   7180:         my $orig_uploaded_filename =
                   7181:             $env{'form.embedded_item_'.$i.'.filename'};
                   7182: 
                   7183:         $env{'form.embedded_orig_'.$i} =
                   7184:             &unescape($env{'form.embedded_orig_'.$i});
                   7185:         my ($path,$fname) =
                   7186:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   7187:         # no path, whole string is fname
                   7188:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   7189: 
                   7190:         $path = $env{'form.currentpath'}.$path;
                   7191:         $fname = &Apache::lonnet::clean_filename($fname);
                   7192:         # See if there is anything left
                   7193:         next if ($fname eq '');
                   7194: 
                   7195:         # Check if file already exists as a file or directory.
                   7196:         my ($state,$msg);
                   7197:         if ($context eq 'portfolio') {
                   7198:             my $port_path = $dirpath;
                   7199:             if ($group ne '') {
                   7200:                 $port_path = "groups/$group/$port_path";
                   7201:             }
                   7202:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   7203:                                               $dir_root,$port_path,$disk_quota,
                   7204:                                               $current_disk_usage,$uname,$udom);
                   7205:             if ($state eq 'will_exceed_quota'
                   7206:                 || $state eq 'file_locked'
                   7207:                 || $state eq 'file_exists' ) {
                   7208:                 $output .= $msg;
                   7209:                 next;
                   7210:             }
                   7211:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   7212:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   7213:             if ($state eq 'exists') {
                   7214:                 $output .= $msg;
                   7215:                 next;
                   7216:             }
                   7217:         }
                   7218:         # Check if extension is valid
                   7219:         if (($fname =~ /\.(\w+)$/) &&
                   7220:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   7221:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   7222:             next;
                   7223:         } elsif (($fname =~ /\.(\w+)$/) &&
                   7224:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   7225:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   7226:             next;
                   7227:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   7228:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   7229:             next;
                   7230:         }
                   7231: 
                   7232:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   7233:         if ($context eq 'portfolio') {
                   7234:             my $result=
                   7235:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   7236:                                                 $dirpath.$path);
                   7237:             if ($result !~ m|^/uploaded/|) {
                   7238:                 $output .= '<span class="LC_error">'
                   7239:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   7240:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   7241:                       .'</span><br />';
                   7242:                 next;
                   7243:             } else {
                   7244:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   7245:                            $path.$fname.'</span>').'</p>';     
                   7246:             }
                   7247:         } else {
                   7248: # Save the file
                   7249:             my $target = $env{'form.embedded_item_'.$i};
                   7250:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   7251:             my $dest = $fullpath.$fname;
                   7252:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   7253:             my @parts=split(/\//,$fullpath);
                   7254:             my $count;
                   7255:             my $filepath = $dir_root;
                   7256:             for ($count=4;$count<=$#parts;$count++) {
                   7257:                 $filepath .= "/$parts[$count]";
                   7258:                 if ((-e $filepath)!=1) {
                   7259:                     mkdir($filepath,0770);
                   7260:                 }
                   7261:             }
                   7262:             my $fh;
                   7263:             if (!open($fh,'>'.$dest)) {
                   7264:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   7265:                 $output .= '<span class="LC_error">'.
                   7266:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   7267:                            '</span><br />';
                   7268:             } else {
                   7269:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   7270:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   7271:                     $output .= '<span class="LC_error">'.
                   7272:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   7273:                               '</span><br />';
                   7274:                 } else {
                   7275:                     if ($context eq 'testbank') {
                   7276:                         $output .= &mt('Embedded file uploaded successfully:').
                   7277:                                    '&nbsp;<a href="'.$url.'">'.
                   7278:                                    $orig_uploaded_filename.'</a><br />';
                   7279:                     } else {
                   7280:                         $output .= '<font size="+2">'.
                   7281:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
                   7282:                                    $orig_uploaded_filename.'</a>').'</font><br />';
                   7283:                     }
                   7284:                 }
                   7285:                 close($fh);
                   7286:             }
                   7287:         }
                   7288:     }
                   7289:     return $output;
                   7290: }
                   7291: 
                   7292: sub check_for_existing {
                   7293:     my ($path,$fname,$element) = @_;
                   7294:     my ($state,$msg);
                   7295:     if (-d $path.'/'.$fname) {
                   7296:         $state = 'exists';
                   7297:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   7298:     } elsif (-e $path.'/'.$fname) {
                   7299:         $state = 'exists';
                   7300:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   7301:     }
                   7302:     if ($state eq 'exists') {
                   7303:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   7304:     }
                   7305:     return ($state,$msg);
                   7306: }
                   7307: 
                   7308: sub check_for_upload {
                   7309:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   7310:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   7311:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   7312:     my $getpropath = 1;
                   7313:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   7314:                                             $getpropath);
                   7315:     my $found_file = 0;
                   7316:     my $locked_file = 0;
                   7317:     foreach my $line (@dir_list) {
                   7318:         my ($file_name)=split(/\&/,$line,2);
                   7319:         if ($file_name eq $fname){
                   7320:             $file_name = $path.$file_name;
                   7321:             if ($group ne '') {
                   7322:                 $file_name = $group.$file_name;
                   7323:             }
                   7324:             $found_file = 1;
                   7325:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   7326:                 $locked_file = 1;
                   7327:             }
                   7328:         }
                   7329:     }
                   7330:     if (($current_disk_usage + $filesize) > $disk_quota){
                   7331:         my $msg = '<span class="LC_error">'.
                   7332:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   7333:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   7334:         return ('will_exceed_quota',$msg);
                   7335:     } elsif ($found_file) {
                   7336:         if ($locked_file) {
                   7337:             my $msg = '<span class="LC_error">';
                   7338:             $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
                   7339:             $msg .= '</span><br />';
                   7340:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   7341:             return ('file_locked',$msg);
                   7342:         } else {
                   7343:             my $msg = '<span class="LC_error">';
                   7344:             $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
                   7345:             $msg .= '</span>';
                   7346:             $msg .= '<br />';
                   7347:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   7348:             return ('file_exists',$msg);
                   7349:         }
                   7350:     }
                   7351: }
                   7352: 
1.31      albertel 7353: 
1.41      ng       7354: =pod
1.45      matthew  7355: 
1.464     albertel 7356: =back
1.41      ng       7357: 
1.112     bowersj2 7358: =head1 CSV Upload/Handling functions
1.38      albertel 7359: 
1.41      ng       7360: =over 4
                   7361: 
1.648     raeburn  7362: =item * &upfile_store($r)
1.41      ng       7363: 
                   7364: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 7365: needs $env{'form.upfile'}
1.41      ng       7366: returns $datatoken to be put into hidden field
                   7367: 
                   7368: =cut
1.31      albertel 7369: 
                   7370: sub upfile_store {
                   7371:     my $r=shift;
1.258     albertel 7372:     $env{'form.upfile'}=~s/\r/\n/gs;
                   7373:     $env{'form.upfile'}=~s/\f/\n/gs;
                   7374:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   7375:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 7376: 
1.258     albertel 7377:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   7378: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 7379:     {
1.158     raeburn  7380:         my $datafile = $r->dir_config('lonDaemons').
                   7381:                            '/tmp/'.$datatoken.'.tmp';
                   7382:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 7383:             print $fh $env{'form.upfile'};
1.158     raeburn  7384:             close($fh);
                   7385:         }
1.31      albertel 7386:     }
                   7387:     return $datatoken;
                   7388: }
                   7389: 
1.56      matthew  7390: =pod
                   7391: 
1.648     raeburn  7392: =item * &load_tmp_file($r)
1.41      ng       7393: 
                   7394: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 7395: needs $env{'form.datatoken'},
                   7396: sets $env{'form.upfile'} to the contents of the file
1.41      ng       7397: 
                   7398: =cut
1.31      albertel 7399: 
                   7400: sub load_tmp_file {
                   7401:     my $r=shift;
                   7402:     my @studentdata=();
                   7403:     {
1.158     raeburn  7404:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 7405:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  7406:         if ( open(my $fh,"<$studentfile") ) {
                   7407:             @studentdata=<$fh>;
                   7408:             close($fh);
                   7409:         }
1.31      albertel 7410:     }
1.258     albertel 7411:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 7412: }
                   7413: 
1.56      matthew  7414: =pod
                   7415: 
1.648     raeburn  7416: =item * &upfile_record_sep()
1.41      ng       7417: 
                   7418: Separate uploaded file into records
                   7419: returns array of records,
1.258     albertel 7420: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       7421: 
                   7422: =cut
1.31      albertel 7423: 
                   7424: sub upfile_record_sep {
1.258     albertel 7425:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 7426:     } else {
1.248     albertel 7427: 	my @records;
1.258     albertel 7428: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 7429: 	    if ($line=~/^\s*$/) { next; }
                   7430: 	    push(@records,$line);
                   7431: 	}
                   7432: 	return @records;
1.31      albertel 7433:     }
                   7434: }
                   7435: 
1.56      matthew  7436: =pod
                   7437: 
1.648     raeburn  7438: =item * &record_sep($record)
1.41      ng       7439: 
1.258     albertel 7440: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       7441: 
                   7442: =cut
                   7443: 
1.263     www      7444: sub takeleft {
                   7445:     my $index=shift;
                   7446:     return substr('0000'.$index,-4,4);
                   7447: }
                   7448: 
1.31      albertel 7449: sub record_sep {
                   7450:     my $record=shift;
                   7451:     my %components=();
1.258     albertel 7452:     if ($env{'form.upfiletype'} eq 'xml') {
                   7453:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 7454:         my $i=0;
1.356     albertel 7455:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 7456:             $field=~s/^(\"|\')//;
                   7457:             $field=~s/(\"|\')$//;
1.263     www      7458:             $components{&takeleft($i)}=$field;
1.31      albertel 7459:             $i++;
                   7460:         }
1.258     albertel 7461:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 7462:         my $i=0;
1.356     albertel 7463:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 7464:             $field=~s/^(\"|\')//;
                   7465:             $field=~s/(\"|\')$//;
1.263     www      7466:             $components{&takeleft($i)}=$field;
1.31      albertel 7467:             $i++;
                   7468:         }
                   7469:     } else {
1.561     www      7470:         my $separator=',';
1.480     banghart 7471:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      7472:             $separator=';';
1.480     banghart 7473:         }
1.31      albertel 7474:         my $i=0;
1.561     www      7475: # the character we are looking for to indicate the end of a quote or a record 
                   7476:         my $looking_for=$separator;
                   7477: # do not add the characters to the fields
                   7478:         my $ignore=0;
                   7479: # we just encountered a separator (or the beginning of the record)
                   7480:         my $just_found_separator=1;
                   7481: # store the field we are working on here
                   7482:         my $field='';
                   7483: # work our way through all characters in record
                   7484:         foreach my $character ($record=~/(.)/g) {
                   7485:             if ($character eq $looking_for) {
                   7486:                if ($character ne $separator) {
                   7487: # Found the end of a quote, again looking for separator
                   7488:                   $looking_for=$separator;
                   7489:                   $ignore=1;
                   7490:                } else {
                   7491: # Found a separator, store away what we got
                   7492:                   $components{&takeleft($i)}=$field;
                   7493: 	          $i++;
                   7494:                   $just_found_separator=1;
                   7495:                   $ignore=0;
                   7496:                   $field='';
                   7497:                }
                   7498:                next;
                   7499:             }
                   7500: # single or double quotation marks after a separator indicate beginning of a quote
                   7501: # we are now looking for the end of the quote and need to ignore separators
                   7502:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   7503:                $looking_for=$character;
                   7504:                next;
                   7505:             }
                   7506: # ignore would be true after we reached the end of a quote
                   7507:             if ($ignore) { next; }
                   7508:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   7509:             $field.=$character;
                   7510:             $just_found_separator=0; 
1.31      albertel 7511:         }
1.561     www      7512: # catch the very last entry, since we never encountered the separator
                   7513:         $components{&takeleft($i)}=$field;
1.31      albertel 7514:     }
                   7515:     return %components;
                   7516: }
                   7517: 
1.144     matthew  7518: ######################################################
                   7519: ######################################################
                   7520: 
1.56      matthew  7521: =pod
                   7522: 
1.648     raeburn  7523: =item * &upfile_select_html()
1.41      ng       7524: 
1.144     matthew  7525: Return HTML code to select a file from the users machine and specify 
                   7526: the file type.
1.41      ng       7527: 
                   7528: =cut
                   7529: 
1.144     matthew  7530: ######################################################
                   7531: ######################################################
1.31      albertel 7532: sub upfile_select_html {
1.144     matthew  7533:     my %Types = (
                   7534:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 7535:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  7536:                  space => &mt('Space separated'),
                   7537:                  tab   => &mt('Tabulator separated'),
                   7538: #                 xml   => &mt('HTML/XML'),
                   7539:                  );
                   7540:     my $Str = '<input type="file" name="upfile" size="50" />'.
                   7541:         '<br />Type: <select name="upfiletype">';
                   7542:     foreach my $type (sort(keys(%Types))) {
                   7543:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   7544:     }
                   7545:     $Str .= "</select>\n";
                   7546:     return $Str;
1.31      albertel 7547: }
                   7548: 
1.301     albertel 7549: sub get_samples {
                   7550:     my ($records,$toget) = @_;
                   7551:     my @samples=({});
                   7552:     my $got=0;
                   7553:     foreach my $rec (@$records) {
                   7554: 	my %temp = &record_sep($rec);
                   7555: 	if (! grep(/\S/, values(%temp))) { next; }
                   7556: 	if (%temp) {
                   7557: 	    $samples[$got]=\%temp;
                   7558: 	    $got++;
                   7559: 	    if ($got == $toget) { last; }
                   7560: 	}
                   7561:     }
                   7562:     return \@samples;
                   7563: }
                   7564: 
1.144     matthew  7565: ######################################################
                   7566: ######################################################
                   7567: 
1.56      matthew  7568: =pod
                   7569: 
1.648     raeburn  7570: =item * &csv_print_samples($r,$records)
1.41      ng       7571: 
                   7572: Prints a table of sample values from each column uploaded $r is an
                   7573: Apache Request ref, $records is an arrayref from
                   7574: &Apache::loncommon::upfile_record_sep
                   7575: 
                   7576: =cut
                   7577: 
1.144     matthew  7578: ######################################################
                   7579: ######################################################
1.31      albertel 7580: sub csv_print_samples {
                   7581:     my ($r,$records) = @_;
1.662     bisitz   7582:     my $samples = &get_samples($records,5);
1.301     albertel 7583: 
1.594     raeburn  7584:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   7585:               &start_data_table_header_row());
1.356     albertel 7586:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
                   7587:         $r->print('<th>'.&mt('Column&nbsp;[_1]',($sample+1)).'</th>'); }
1.594     raeburn  7588:     $r->print(&end_data_table_header_row());
1.301     albertel 7589:     foreach my $hash (@$samples) {
1.594     raeburn  7590: 	$r->print(&start_data_table_row());
1.356     albertel 7591: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 7592: 	    $r->print('<td>');
1.356     albertel 7593: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 7594: 	    $r->print('</td>');
                   7595: 	}
1.594     raeburn  7596: 	$r->print(&end_data_table_row());
1.31      albertel 7597:     }
1.594     raeburn  7598:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 7599: }
                   7600: 
1.144     matthew  7601: ######################################################
                   7602: ######################################################
                   7603: 
1.56      matthew  7604: =pod
                   7605: 
1.648     raeburn  7606: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       7607: 
                   7608: Prints a table to create associations between values and table columns.
1.144     matthew  7609: 
1.41      ng       7610: $r is an Apache Request ref,
                   7611: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  7612: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       7613: 
                   7614: =cut
                   7615: 
1.144     matthew  7616: ######################################################
                   7617: ######################################################
1.31      albertel 7618: sub csv_print_select_table {
                   7619:     my ($r,$records,$d) = @_;
1.301     albertel 7620:     my $i=0;
                   7621:     my $samples = &get_samples($records,1);
1.144     matthew  7622:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  7623: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  7624:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  7625:               '<th>'.&mt('Column').'</th>'.
                   7626:               &end_data_table_header_row()."\n");
1.356     albertel 7627:     foreach my $array_ref (@$d) {
                   7628: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.594     raeburn  7629: 	$r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31      albertel 7630: 
                   7631: 	$r->print('<td><select name=f'.$i.
1.32      matthew  7632: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 7633: 	$r->print('<option value="none"></option>');
1.356     albertel 7634: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   7635: 	    $r->print('<option value="'.$sample.'"'.
                   7636:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   7637:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 7638: 	}
1.594     raeburn  7639: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 7640: 	$i++;
                   7641:     }
1.594     raeburn  7642:     $r->print(&end_data_table());
1.31      albertel 7643:     $i--;
                   7644:     return $i;
                   7645: }
1.56      matthew  7646: 
1.144     matthew  7647: ######################################################
                   7648: ######################################################
                   7649: 
1.56      matthew  7650: =pod
1.31      albertel 7651: 
1.648     raeburn  7652: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       7653: 
                   7654: Prints a table of sample values from the upload and can make associate samples to internal names.
                   7655: 
                   7656: $r is an Apache Request ref,
                   7657: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   7658: $d is an array of 2 element arrays (internal name, displayed name)
                   7659: 
                   7660: =cut
                   7661: 
1.144     matthew  7662: ######################################################
                   7663: ######################################################
1.31      albertel 7664: sub csv_samples_select_table {
                   7665:     my ($r,$records,$d) = @_;
                   7666:     my $i=0;
1.144     matthew  7667:     #
1.662     bisitz   7668:     my $max_samples = 5;
                   7669:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  7670:     $r->print(&start_data_table().
                   7671:               &start_data_table_header_row().'<th>'.
                   7672:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   7673:               &end_data_table_header_row());
1.301     albertel 7674: 
                   7675:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  7676: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  7677: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 7678: 	foreach my $option (@$d) {
                   7679: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  7680: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 7681:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  7682:                       $display.'</option>');
1.31      albertel 7683: 	}
                   7684: 	$r->print('</select></td><td>');
1.662     bisitz   7685: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 7686: 	    if (defined($samples->[$line]{$key})) { 
                   7687: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   7688: 	    }
                   7689: 	}
1.594     raeburn  7690: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 7691: 	$i++;
                   7692:     }
1.594     raeburn  7693:     $r->print(&end_data_table());
1.31      albertel 7694:     $i--;
                   7695:     return($i);
1.115     matthew  7696: }
                   7697: 
1.144     matthew  7698: ######################################################
                   7699: ######################################################
                   7700: 
1.115     matthew  7701: =pod
                   7702: 
1.648     raeburn  7703: =item * &clean_excel_name($name)
1.115     matthew  7704: 
                   7705: Returns a replacement for $name which does not contain any illegal characters.
                   7706: 
                   7707: =cut
                   7708: 
1.144     matthew  7709: ######################################################
                   7710: ######################################################
1.115     matthew  7711: sub clean_excel_name {
                   7712:     my ($name) = @_;
                   7713:     $name =~ s/[:\*\?\/\\]//g;
                   7714:     if (length($name) > 31) {
                   7715:         $name = substr($name,0,31);
                   7716:     }
                   7717:     return $name;
1.25      albertel 7718: }
1.84      albertel 7719: 
1.85      albertel 7720: =pod
                   7721: 
1.648     raeburn  7722: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 7723: 
                   7724: Returns either 1 or undef
                   7725: 
                   7726: 1 if the part is to be hidden, undef if it is to be shown
                   7727: 
                   7728: Arguments are:
                   7729: 
                   7730: $id the id of the part to be checked
                   7731: $symb, optional the symb of the resource to check
                   7732: $udom, optional the domain of the user to check for
                   7733: $uname, optional the username of the user to check for
                   7734: 
                   7735: =cut
1.84      albertel 7736: 
                   7737: sub check_if_partid_hidden {
                   7738:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 7739:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 7740: 					 $symb,$udom,$uname);
1.141     albertel 7741:     my $truth=1;
                   7742:     #if the string starts with !, then the list is the list to show not hide
                   7743:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 7744:     my @hiddenlist=split(/,/,$hiddenparts);
                   7745:     foreach my $checkid (@hiddenlist) {
1.141     albertel 7746: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 7747:     }
1.141     albertel 7748:     return !$truth;
1.84      albertel 7749: }
1.127     matthew  7750: 
1.138     matthew  7751: 
                   7752: ############################################################
                   7753: ############################################################
                   7754: 
                   7755: =pod
                   7756: 
1.157     matthew  7757: =back 
                   7758: 
1.138     matthew  7759: =head1 cgi-bin script and graphing routines
                   7760: 
1.157     matthew  7761: =over 4
                   7762: 
1.648     raeburn  7763: =item * &get_cgi_id()
1.138     matthew  7764: 
                   7765: Inputs: none
                   7766: 
                   7767: Returns an id which can be used to pass environment variables
                   7768: to various cgi-bin scripts.  These environment variables will
                   7769: be removed from the users environment after a given time by
                   7770: the routine &Apache::lonnet::transfer_profile_to_env.
                   7771: 
                   7772: =cut
                   7773: 
                   7774: ############################################################
                   7775: ############################################################
1.152     albertel 7776: my $uniq=0;
1.136     matthew  7777: sub get_cgi_id {
1.154     albertel 7778:     $uniq=($uniq+1)%100000;
1.280     albertel 7779:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  7780: }
                   7781: 
1.127     matthew  7782: ############################################################
                   7783: ############################################################
                   7784: 
                   7785: =pod
                   7786: 
1.648     raeburn  7787: =item * &DrawBarGraph()
1.127     matthew  7788: 
1.138     matthew  7789: Facilitates the plotting of data in a (stacked) bar graph.
                   7790: Puts plot definition data into the users environment in order for 
                   7791: graph.png to plot it.  Returns an <img> tag for the plot.
                   7792: The bars on the plot are labeled '1','2',...,'n'.
                   7793: 
                   7794: Inputs:
                   7795: 
                   7796: =over 4
                   7797: 
                   7798: =item $Title: string, the title of the plot
                   7799: 
                   7800: =item $xlabel: string, text describing the X-axis of the plot
                   7801: 
                   7802: =item $ylabel: string, text describing the Y-axis of the plot
                   7803: 
                   7804: =item $Max: scalar, the maximum Y value to use in the plot
                   7805: If $Max is < any data point, the graph will not be rendered.
                   7806: 
1.140     matthew  7807: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  7808: they are plotted.  If undefined, default values will be used.
                   7809: 
1.178     matthew  7810: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   7811: 
1.138     matthew  7812: =item @Values: An array of array references.  Each array reference holds data
                   7813: to be plotted in a stacked bar chart.
                   7814: 
1.239     matthew  7815: =item If the final element of @Values is a hash reference the key/value
                   7816: pairs will be added to the graph definition.
                   7817: 
1.138     matthew  7818: =back
                   7819: 
                   7820: Returns:
                   7821: 
                   7822: An <img> tag which references graph.png and the appropriate identifying
                   7823: information for the plot.
                   7824: 
1.127     matthew  7825: =cut
                   7826: 
                   7827: ############################################################
                   7828: ############################################################
1.134     matthew  7829: sub DrawBarGraph {
1.178     matthew  7830:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  7831:     #
                   7832:     if (! defined($colors)) {
                   7833:         $colors = ['#33ff00', 
                   7834:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   7835:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   7836:                   ]; 
                   7837:     }
1.228     matthew  7838:     my $extra_settings = {};
                   7839:     if (ref($Values[-1]) eq 'HASH') {
                   7840:         $extra_settings = pop(@Values);
                   7841:     }
1.127     matthew  7842:     #
1.136     matthew  7843:     my $identifier = &get_cgi_id();
                   7844:     my $id = 'cgi.'.$identifier;        
1.129     matthew  7845:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  7846:         return '';
                   7847:     }
1.225     matthew  7848:     #
                   7849:     my @Labels;
                   7850:     if (defined($labels)) {
                   7851:         @Labels = @$labels;
                   7852:     } else {
                   7853:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   7854:             push (@Labels,$i+1);
                   7855:         }
                   7856:     }
                   7857:     #
1.129     matthew  7858:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  7859:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  7860:     my %ValuesHash;
                   7861:     my $NumSets=1;
                   7862:     foreach my $array (@Values) {
                   7863:         next if (! ref($array));
1.136     matthew  7864:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  7865:             join(',',@$array);
1.129     matthew  7866:     }
1.127     matthew  7867:     #
1.136     matthew  7868:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  7869:     if ($NumBars < 3) {
                   7870:         $width = 120+$NumBars*32;
1.220     matthew  7871:         $xskip = 1;
1.225     matthew  7872:         $bar_width = 30;
                   7873:     } elsif ($NumBars < 5) {
                   7874:         $width = 120+$NumBars*20;
                   7875:         $xskip = 1;
                   7876:         $bar_width = 20;
1.220     matthew  7877:     } elsif ($NumBars < 10) {
1.136     matthew  7878:         $width = 120+$NumBars*15;
                   7879:         $xskip = 1;
                   7880:         $bar_width = 15;
                   7881:     } elsif ($NumBars <= 25) {
                   7882:         $width = 120+$NumBars*11;
                   7883:         $xskip = 5;
                   7884:         $bar_width = 8;
                   7885:     } elsif ($NumBars <= 50) {
                   7886:         $width = 120+$NumBars*8;
                   7887:         $xskip = 5;
                   7888:         $bar_width = 4;
                   7889:     } else {
                   7890:         $width = 120+$NumBars*8;
                   7891:         $xskip = 5;
                   7892:         $bar_width = 4;
                   7893:     }
                   7894:     #
1.137     matthew  7895:     $Max = 1 if ($Max < 1);
                   7896:     if ( int($Max) < $Max ) {
                   7897:         $Max++;
                   7898:         $Max = int($Max);
                   7899:     }
1.127     matthew  7900:     $Title  = '' if (! defined($Title));
                   7901:     $xlabel = '' if (! defined($xlabel));
                   7902:     $ylabel = '' if (! defined($ylabel));
1.369     www      7903:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   7904:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   7905:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  7906:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  7907:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   7908:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   7909:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   7910:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   7911:     $ValuesHash{$id.'.height'}   = $height;
                   7912:     $ValuesHash{$id.'.width'}    = $width;
                   7913:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   7914:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   7915:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  7916:     #
1.228     matthew  7917:     # Deal with other parameters
                   7918:     while (my ($key,$value) = each(%$extra_settings)) {
                   7919:         $ValuesHash{$id.'.'.$key} = $value;
                   7920:     }
                   7921:     #
1.646     raeburn  7922:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  7923:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   7924: }
                   7925: 
                   7926: ############################################################
                   7927: ############################################################
                   7928: 
                   7929: =pod
                   7930: 
1.648     raeburn  7931: =item * &DrawXYGraph()
1.137     matthew  7932: 
1.138     matthew  7933: Facilitates the plotting of data in an XY graph.
                   7934: Puts plot definition data into the users environment in order for 
                   7935: graph.png to plot it.  Returns an <img> tag for the plot.
                   7936: 
                   7937: Inputs:
                   7938: 
                   7939: =over 4
                   7940: 
                   7941: =item $Title: string, the title of the plot
                   7942: 
                   7943: =item $xlabel: string, text describing the X-axis of the plot
                   7944: 
                   7945: =item $ylabel: string, text describing the Y-axis of the plot
                   7946: 
                   7947: =item $Max: scalar, the maximum Y value to use in the plot
                   7948: If $Max is < any data point, the graph will not be rendered.
                   7949: 
                   7950: =item $colors: Array ref containing the hex color codes for the data to be 
                   7951: plotted in.  If undefined, default values will be used.
                   7952: 
                   7953: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   7954: 
                   7955: =item $Ydata: Array ref containing Array refs.  
1.185     www      7956: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  7957: 
                   7958: =item %Values: hash indicating or overriding any default values which are 
                   7959: passed to graph.png.  
                   7960: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   7961: 
                   7962: =back
                   7963: 
                   7964: Returns:
                   7965: 
                   7966: An <img> tag which references graph.png and the appropriate identifying
                   7967: information for the plot.
                   7968: 
1.137     matthew  7969: =cut
                   7970: 
                   7971: ############################################################
                   7972: ############################################################
                   7973: sub DrawXYGraph {
                   7974:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   7975:     #
                   7976:     # Create the identifier for the graph
                   7977:     my $identifier = &get_cgi_id();
                   7978:     my $id = 'cgi.'.$identifier;
                   7979:     #
                   7980:     $Title  = '' if (! defined($Title));
                   7981:     $xlabel = '' if (! defined($xlabel));
                   7982:     $ylabel = '' if (! defined($ylabel));
                   7983:     my %ValuesHash = 
                   7984:         (
1.369     www      7985:          $id.'.title'  => &escape($Title),
                   7986:          $id.'.xlabel' => &escape($xlabel),
                   7987:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  7988:          $id.'.y_max_value'=> $Max,
                   7989:          $id.'.labels'     => join(',',@$Xlabels),
                   7990:          $id.'.PlotType'   => 'XY',
                   7991:          );
                   7992:     #
                   7993:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   7994:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   7995:     }
                   7996:     #
                   7997:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   7998:         return '';
                   7999:     }
                   8000:     my $NumSets=1;
1.138     matthew  8001:     foreach my $array (@{$Ydata}){
1.137     matthew  8002:         next if (! ref($array));
                   8003:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   8004:     }
1.138     matthew  8005:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  8006:     #
                   8007:     # Deal with other parameters
                   8008:     while (my ($key,$value) = each(%Values)) {
                   8009:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  8010:     }
                   8011:     #
1.646     raeburn  8012:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  8013:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8014: }
                   8015: 
                   8016: ############################################################
                   8017: ############################################################
                   8018: 
                   8019: =pod
                   8020: 
1.648     raeburn  8021: =item * &DrawXYYGraph()
1.138     matthew  8022: 
                   8023: Facilitates the plotting of data in an XY graph with two Y axes.
                   8024: Puts plot definition data into the users environment in order for 
                   8025: graph.png to plot it.  Returns an <img> tag for the plot.
                   8026: 
                   8027: Inputs:
                   8028: 
                   8029: =over 4
                   8030: 
                   8031: =item $Title: string, the title of the plot
                   8032: 
                   8033: =item $xlabel: string, text describing the X-axis of the plot
                   8034: 
                   8035: =item $ylabel: string, text describing the Y-axis of the plot
                   8036: 
                   8037: =item $colors: Array ref containing the hex color codes for the data to be 
                   8038: plotted in.  If undefined, default values will be used.
                   8039: 
                   8040: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8041: 
                   8042: =item $Ydata1: The first data set
                   8043: 
                   8044: =item $Min1: The minimum value of the left Y-axis
                   8045: 
                   8046: =item $Max1: The maximum value of the left Y-axis
                   8047: 
                   8048: =item $Ydata2: The second data set
                   8049: 
                   8050: =item $Min2: The minimum value of the right Y-axis
                   8051: 
                   8052: =item $Max2: The maximum value of the left Y-axis
                   8053: 
                   8054: =item %Values: hash indicating or overriding any default values which are 
                   8055: passed to graph.png.  
                   8056: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8057: 
                   8058: =back
                   8059: 
                   8060: Returns:
                   8061: 
                   8062: An <img> tag which references graph.png and the appropriate identifying
                   8063: information for the plot.
1.136     matthew  8064: 
                   8065: =cut
                   8066: 
                   8067: ############################################################
                   8068: ############################################################
1.137     matthew  8069: sub DrawXYYGraph {
                   8070:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   8071:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  8072:     #
                   8073:     # Create the identifier for the graph
                   8074:     my $identifier = &get_cgi_id();
                   8075:     my $id = 'cgi.'.$identifier;
                   8076:     #
                   8077:     $Title  = '' if (! defined($Title));
                   8078:     $xlabel = '' if (! defined($xlabel));
                   8079:     $ylabel = '' if (! defined($ylabel));
                   8080:     my %ValuesHash = 
                   8081:         (
1.369     www      8082:          $id.'.title'  => &escape($Title),
                   8083:          $id.'.xlabel' => &escape($xlabel),
                   8084:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  8085:          $id.'.labels' => join(',',@$Xlabels),
                   8086:          $id.'.PlotType' => 'XY',
                   8087:          $id.'.NumSets' => 2,
1.137     matthew  8088:          $id.'.two_axes' => 1,
                   8089:          $id.'.y1_max_value' => $Max1,
                   8090:          $id.'.y1_min_value' => $Min1,
                   8091:          $id.'.y2_max_value' => $Max2,
                   8092:          $id.'.y2_min_value' => $Min2,
1.136     matthew  8093:          );
                   8094:     #
1.137     matthew  8095:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8096:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8097:     }
                   8098:     #
                   8099:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   8100:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  8101:         return '';
                   8102:     }
                   8103:     my $NumSets=1;
1.137     matthew  8104:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  8105:         next if (! ref($array));
                   8106:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  8107:     }
                   8108:     #
                   8109:     # Deal with other parameters
                   8110:     while (my ($key,$value) = each(%Values)) {
                   8111:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  8112:     }
                   8113:     #
1.646     raeburn  8114:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 8115:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  8116: }
                   8117: 
                   8118: ############################################################
                   8119: ############################################################
                   8120: 
                   8121: =pod
                   8122: 
1.157     matthew  8123: =back 
                   8124: 
1.139     matthew  8125: =head1 Statistics helper routines?  
                   8126: 
                   8127: Bad place for them but what the hell.
                   8128: 
1.157     matthew  8129: =over 4
                   8130: 
1.648     raeburn  8131: =item * &chartlink()
1.139     matthew  8132: 
                   8133: Returns a link to the chart for a specific student.  
                   8134: 
                   8135: Inputs:
                   8136: 
                   8137: =over 4
                   8138: 
                   8139: =item $linktext: The text of the link
                   8140: 
                   8141: =item $sname: The students username
                   8142: 
                   8143: =item $sdomain: The students domain
                   8144: 
                   8145: =back
                   8146: 
1.157     matthew  8147: =back
                   8148: 
1.139     matthew  8149: =cut
                   8150: 
                   8151: ############################################################
                   8152: ############################################################
                   8153: sub chartlink {
                   8154:     my ($linktext, $sname, $sdomain) = @_;
                   8155:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      8156:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 8157:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  8158:        '">'.$linktext.'</a>';
1.153     matthew  8159: }
                   8160: 
                   8161: #######################################################
                   8162: #######################################################
                   8163: 
                   8164: =pod
                   8165: 
                   8166: =head1 Course Environment Routines
1.157     matthew  8167: 
                   8168: =over 4
1.153     matthew  8169: 
1.648     raeburn  8170: =item * &restore_course_settings()
1.153     matthew  8171: 
1.648     raeburn  8172: =item * &store_course_settings()
1.153     matthew  8173: 
                   8174: Restores/Store indicated form parameters from the course environment.
                   8175: Will not overwrite existing values of the form parameters.
                   8176: 
                   8177: Inputs: 
                   8178: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   8179: 
                   8180: a hash ref describing the data to be stored.  For example:
                   8181:    
                   8182: %Save_Parameters = ('Status' => 'scalar',
                   8183:     'chartoutputmode' => 'scalar',
                   8184:     'chartoutputdata' => 'scalar',
                   8185:     'Section' => 'array',
1.373     raeburn  8186:     'Group' => 'array',
1.153     matthew  8187:     'StudentData' => 'array',
                   8188:     'Maps' => 'array');
                   8189: 
                   8190: Returns: both routines return nothing
                   8191: 
1.631     raeburn  8192: =back
                   8193: 
1.153     matthew  8194: =cut
                   8195: 
                   8196: #######################################################
                   8197: #######################################################
                   8198: sub store_course_settings {
1.496     albertel 8199:     return &store_settings($env{'request.course.id'},@_);
                   8200: }
                   8201: 
                   8202: sub store_settings {
1.153     matthew  8203:     # save to the environment
                   8204:     # appenv the same items, just to be safe
1.300     albertel 8205:     my $udom  = $env{'user.domain'};
                   8206:     my $uname = $env{'user.name'};
1.496     albertel 8207:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  8208:     my %SaveHash;
                   8209:     my %AppHash;
                   8210:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 8211:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 8212:         my $envname = 'environment.'.$basename;
1.258     albertel 8213:         if (exists($env{'form.'.$setting})) {
1.153     matthew  8214:             # Save this value away
                   8215:             if ($type eq 'scalar' &&
1.258     albertel 8216:                 (! exists($env{$envname}) || 
                   8217:                  $env{$envname} ne $env{'form.'.$setting})) {
                   8218:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   8219:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  8220:             } elsif ($type eq 'array') {
                   8221:                 my $stored_form;
1.258     albertel 8222:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  8223:                     $stored_form = join(',',
                   8224:                                         map {
1.369     www      8225:                                             &escape($_);
1.258     albertel 8226:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  8227:                 } else {
                   8228:                     $stored_form = 
1.369     www      8229:                         &escape($env{'form.'.$setting});
1.153     matthew  8230:                 }
                   8231:                 # Determine if the array contents are the same.
1.258     albertel 8232:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  8233:                     $SaveHash{$basename} = $stored_form;
                   8234:                     $AppHash{$envname}   = $stored_form;
                   8235:                 }
                   8236:             }
                   8237:         }
                   8238:     }
                   8239:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 8240:                                           $udom,$uname);
1.153     matthew  8241:     if ($put_result !~ /^(ok|delayed)/) {
                   8242:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   8243:                                  'got error:'.$put_result);
                   8244:     }
                   8245:     # Make sure these settings stick around in this session, too
1.646     raeburn  8246:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  8247:     return;
                   8248: }
                   8249: 
                   8250: sub restore_course_settings {
1.499     albertel 8251:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 8252: }
                   8253: 
                   8254: sub restore_settings {
                   8255:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  8256:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 8257:         next if (exists($env{'form.'.$setting}));
1.496     albertel 8258:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  8259:             '.'.$setting;
1.258     albertel 8260:         if (exists($env{$envname})) {
1.153     matthew  8261:             if ($type eq 'scalar') {
1.258     albertel 8262:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  8263:             } elsif ($type eq 'array') {
1.258     albertel 8264:                 $env{'form.'.$setting} = [ 
1.153     matthew  8265:                                            map { 
1.369     www      8266:                                                &unescape($_); 
1.258     albertel 8267:                                            } split(',',$env{$envname})
1.153     matthew  8268:                                            ];
                   8269:             }
                   8270:         }
                   8271:     }
1.127     matthew  8272: }
                   8273: 
1.618     raeburn  8274: #######################################################
                   8275: #######################################################
                   8276: 
                   8277: =pod
                   8278: 
                   8279: =head1 Domain E-mail Routines  
                   8280: 
                   8281: =over 4
                   8282: 
1.648     raeburn  8283: =item * &build_recipient_list()
1.618     raeburn  8284: 
                   8285: Build recipient lists for three types of e-mail:
                   8286: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619     raeburn  8287: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618     raeburn  8288: 
                   8289: Inputs:
1.619     raeburn  8290: defmail (scalar - email address of default recipient), 
1.618     raeburn  8291: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  8292: defdom (domain for which to retrieve configuration settings),
                   8293: origmail (scalar - email address of recipient from loncapa.conf, 
                   8294: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  8295: 
1.655     raeburn  8296: Returns: comma separated list of addresses to which to send e-mail.
                   8297: 
                   8298: =back
1.618     raeburn  8299: 
                   8300: =cut
                   8301: 
                   8302: ############################################################
                   8303: ############################################################
                   8304: sub build_recipient_list {
1.619     raeburn  8305:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  8306:     my @recipients;
                   8307:     my $otheremails;
                   8308:     my %domconfig =
                   8309:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   8310:     if (ref($domconfig{'contacts'}) eq 'HASH') {
                   8311:         if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   8312:             my @contacts = ('adminemail','supportemail');
                   8313:             foreach my $item (@contacts) {
                   8314:                 if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619     raeburn  8315:                     my $addr = $domconfig{'contacts'}{$item}; 
                   8316:                     if (!grep(/^\Q$addr\E$/,@recipients)) {
                   8317:                         push(@recipients,$addr);
                   8318:                     }
1.618     raeburn  8319:                 }
                   8320:                 $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
                   8321:             }
                   8322:         }
1.619     raeburn  8323:     } elsif ($origmail ne '') {
                   8324:         push(@recipients,$origmail);
1.618     raeburn  8325:     }
                   8326:     if ($defmail ne '') {
                   8327:         push(@recipients,$defmail);
                   8328:     }
                   8329:     if ($otheremails) {
1.619     raeburn  8330:         my @others;
                   8331:         if ($otheremails =~ /,/) {
                   8332:             @others = split(/,/,$otheremails);
1.618     raeburn  8333:         } else {
1.619     raeburn  8334:             push(@others,$otheremails);
                   8335:         }
                   8336:         foreach my $addr (@others) {
                   8337:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   8338:                 push(@recipients,$addr);
                   8339:             }
1.618     raeburn  8340:         }
                   8341:     }
1.619     raeburn  8342:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  8343:     return $recipientlist;
                   8344: }
                   8345: 
1.127     matthew  8346: ############################################################
                   8347: ############################################################
1.154     albertel 8348: 
1.655     raeburn  8349: =pod
                   8350: 
                   8351: =head1 Course Catalog Routines
                   8352: 
                   8353: =over 4
                   8354: 
                   8355: =item * &gather_categories()
                   8356: 
                   8357: Converts category definitions - keys of categories hash stored in  
                   8358: coursecategories in configuration.db on the primary library server in a 
                   8359: domain - to an array.  Also generates javascript and idx hash used to 
                   8360: generate Domain Coordinator interface for editing Course Categories.
                   8361: 
                   8362: Inputs:
1.663     raeburn  8363: 
1.655     raeburn  8364: categories (reference to hash of category definitions).
1.663     raeburn  8365: 
1.655     raeburn  8366: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8367:       categories and subcategories).
1.663     raeburn  8368: 
1.655     raeburn  8369: idx (reference to hash of counters used in Domain Coordinator interface for 
                   8370:       editing Course Categories).
1.663     raeburn  8371: 
1.655     raeburn  8372: jsarray (reference to array of categories used to create Javascript arrays for
                   8373:          Domain Coordinator interface for editing Course Categories).
                   8374: 
                   8375: Returns: nothing
                   8376: 
                   8377: Side effects: populates cats, idx and jsarray. 
                   8378: 
                   8379: =cut
                   8380: 
                   8381: sub gather_categories {
                   8382:     my ($categories,$cats,$idx,$jsarray) = @_;
                   8383:     my %counters;
                   8384:     my $num = 0;
                   8385:     foreach my $item (keys(%{$categories})) {
                   8386:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   8387:         if ($container eq '' && $depth == 0) {
                   8388:             $cats->[$depth][$categories->{$item}] = $cat;
                   8389:         } else {
                   8390:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   8391:         }
                   8392:         my ($escitem,$tail) = split(/:/,$item,2);
                   8393:         if ($counters{$tail} eq '') {
                   8394:             $counters{$tail} = $num;
                   8395:             $num ++;
                   8396:         }
                   8397:         if (ref($idx) eq 'HASH') {
                   8398:             $idx->{$item} = $counters{$tail};
                   8399:         }
                   8400:         if (ref($jsarray) eq 'ARRAY') {
                   8401:             push(@{$jsarray->[$counters{$tail}]},$item);
                   8402:         }
                   8403:     }
                   8404:     return;
                   8405: }
                   8406: 
                   8407: =pod
                   8408: 
                   8409: =item * &extract_categories()
                   8410: 
                   8411: Used to generate breadcrumb trails for course categories.
                   8412: 
                   8413: Inputs:
1.663     raeburn  8414: 
1.655     raeburn  8415: categories (reference to hash of category definitions).
1.663     raeburn  8416: 
1.655     raeburn  8417: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8418:       categories and subcategories).
1.663     raeburn  8419: 
1.655     raeburn  8420: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  8421: 
1.655     raeburn  8422: allitems (reference to hash - key is category key 
                   8423:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  8424: 
1.655     raeburn  8425: idx (reference to hash of counters used in Domain Coordinator interface for
                   8426:       editing Course Categories).
1.663     raeburn  8427: 
1.655     raeburn  8428: jsarray (reference to array of categories used to create Javascript arrays for
                   8429:          Domain Coordinator interface for editing Course Categories).
                   8430: 
1.665     raeburn  8431: subcats (reference to hash of arrays containing all subcategories within each 
                   8432:          category, -recursive)
                   8433: 
1.655     raeburn  8434: Returns: nothing
                   8435: 
                   8436: Side effects: populates trails and allitems hash references.
                   8437: 
                   8438: =cut
                   8439: 
                   8440: sub extract_categories {
1.665     raeburn  8441:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  8442:     if (ref($categories) eq 'HASH') {
                   8443:         &gather_categories($categories,$cats,$idx,$jsarray);
                   8444:         if (ref($cats->[0]) eq 'ARRAY') {
                   8445:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   8446:                 my $name = $cats->[0][$i];
                   8447:                 my $item = &escape($name).'::0';
                   8448:                 my $trailstr;
                   8449:                 if ($name eq 'instcode') {
                   8450:                     $trailstr = &mt('Official courses (with institutional codes)');
                   8451:                 } else {
                   8452:                     $trailstr = $name;
                   8453:                 }
                   8454:                 if ($allitems->{$item} eq '') {
                   8455:                     push(@{$trails},$trailstr);
                   8456:                     $allitems->{$item} = scalar(@{$trails})-1;
                   8457:                 }
                   8458:                 my @parents = ($name);
                   8459:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   8460:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   8461:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  8462:                         if (ref($subcats) eq 'HASH') {
                   8463:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   8464:                         }
                   8465:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   8466:                     }
                   8467:                 } else {
                   8468:                     if (ref($subcats) eq 'HASH') {
                   8469:                         $subcats->{$item} = [];
1.655     raeburn  8470:                     }
                   8471:                 }
                   8472:             }
                   8473:         }
                   8474:     }
                   8475:     return;
                   8476: }
                   8477: 
                   8478: =pod
                   8479: 
                   8480: =item *&recurse_categories()
                   8481: 
                   8482: Recursively used to generate breadcrumb trails for course categories.
                   8483: 
                   8484: Inputs:
1.663     raeburn  8485: 
1.655     raeburn  8486: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   8487:       categories and subcategories).
1.663     raeburn  8488: 
1.655     raeburn  8489: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  8490: 
                   8491: category (current course category, for which breadcrumb trail is being generated).
                   8492: 
                   8493: trails (reference to array of breadcrumb trails for each category).
                   8494: 
1.655     raeburn  8495: allitems (reference to hash - key is category key
                   8496:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  8497: 
1.655     raeburn  8498: parents (array containing containers directories for current category, 
                   8499:          back to top level). 
                   8500: 
                   8501: Returns: nothing
                   8502: 
                   8503: Side effects: populates trails and allitems hash references
                   8504: 
                   8505: =cut
                   8506: 
                   8507: sub recurse_categories {
1.665     raeburn  8508:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  8509:     my $shallower = $depth - 1;
                   8510:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   8511:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   8512:             my $name = $cats->[$depth]{$category}[$k];
                   8513:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   8514:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   8515:             if ($allitems->{$item} eq '') {
                   8516:                 push(@{$trails},$trailstr);
                   8517:                 $allitems->{$item} = scalar(@{$trails})-1;
                   8518:             }
                   8519:             my $deeper = $depth+1;
                   8520:             push(@{$parents},$category);
1.665     raeburn  8521:             if (ref($subcats) eq 'HASH') {
                   8522:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   8523:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   8524:                     my $higher;
                   8525:                     if ($j > 0) {
                   8526:                         $higher = &escape($parents->[$j]).':'.
                   8527:                                   &escape($parents->[$j-1]).':'.$j;
                   8528:                     } else {
                   8529:                         $higher = &escape($parents->[$j]).'::'.$j;
                   8530:                     }
                   8531:                     push(@{$subcats->{$higher}},$subcat);
                   8532:                 }
                   8533:             }
                   8534:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   8535:                                 $subcats);
1.655     raeburn  8536:             pop(@{$parents});
                   8537:         }
                   8538:     } else {
                   8539:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   8540:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   8541:         if ($allitems->{$item} eq '') {
                   8542:             push(@{$trails},$trailstr);
                   8543:             $allitems->{$item} = scalar(@{$trails})-1;
                   8544:         }
                   8545:     }
                   8546:     return;
                   8547: }
                   8548: 
1.663     raeburn  8549: =pod
                   8550: 
                   8551: =item *&assign_categories_table()
                   8552: 
                   8553: Create a datatable for display of hierarchical categories in a domain,
                   8554: with checkboxes to allow a course to be categorized. 
                   8555: 
                   8556: Inputs:
                   8557: 
                   8558: cathash - reference to hash of categories defined for the domain (from
                   8559:           configuration.db)
                   8560: 
                   8561: currcat - scalar with an & separated list of categories assigned to a course. 
                   8562: 
                   8563: Returns: $output (markup to be displayed) 
                   8564: 
                   8565: =cut
                   8566: 
                   8567: sub assign_categories_table {
                   8568:     my ($cathash,$currcat) = @_;
                   8569:     my $output;
                   8570:     if (ref($cathash) eq 'HASH') {
                   8571:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   8572:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   8573:         $maxdepth = scalar(@cats);
                   8574:         if (@cats > 0) {
                   8575:             my $itemcount = 0;
                   8576:             if (ref($cats[0]) eq 'ARRAY') {
                   8577:                 $output = &Apache::loncommon::start_data_table();
                   8578:                 my @currcategories;
                   8579:                 if ($currcat ne '') {
                   8580:                     @currcategories = split('&',$currcat);
                   8581:                 }
                   8582:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   8583:                     my $parent = $cats[0][$i];
                   8584:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   8585:                     next if ($parent eq 'instcode');
                   8586:                     my $item = &escape($parent).'::0';
                   8587:                     my $checked = '';
                   8588:                     if (@currcategories > 0) {
                   8589:                         if (grep(/^\Q$item\E$/,@currcategories)) {
                   8590:                             $checked = ' checked="checked" ';
                   8591:                         }
                   8592:                     }
1.675     raeburn  8593:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   8594:                                '<input type="checkbox" name="usecategory" value="'.
                   8595:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   8596:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  8597:                     my $depth = 1;
                   8598:                     push(@path,$parent);
                   8599:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   8600:                     pop(@path);
                   8601:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   8602:                     $itemcount ++;
                   8603:                 }
                   8604:                 $output .= &Apache::loncommon::end_data_table();
                   8605:             }
                   8606:         }
                   8607:     }
                   8608:     return $output;
                   8609: }
                   8610: 
                   8611: =pod
                   8612: 
                   8613: =item *&assign_category_rows()
                   8614: 
                   8615: Create a datatable row for display of nested categories in a domain,
                   8616: with checkboxes to allow a course to be categorized,called recursively.
                   8617: 
                   8618: Inputs:
                   8619: 
                   8620: itemcount - track row number for alternating colors
                   8621: 
                   8622: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   8623:       categories and subcategories.
                   8624: 
                   8625: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   8626: 
                   8627: parent - parent of current category item
                   8628: 
                   8629: path - Array containing all categories back up through the hierarchy from the
                   8630:        current category to the top level.
                   8631: 
                   8632: currcategories - reference to array of current categories assigned to the course
                   8633: 
                   8634: Returns: $output (markup to be displayed).
                   8635: 
                   8636: =cut
                   8637: 
                   8638: sub assign_category_rows {
                   8639:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   8640:     my ($text,$name,$item,$chgstr);
                   8641:     if (ref($cats) eq 'ARRAY') {
                   8642:         my $maxdepth = scalar(@{$cats});
                   8643:         if (ref($cats->[$depth]) eq 'HASH') {
                   8644:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   8645:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   8646:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   8647:                 $text .= '<td><table class="LC_datatable">';
                   8648:                 for (my $j=0; $j<$numchildren; $j++) {
                   8649:                     $name = $cats->[$depth]{$parent}[$j];
                   8650:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   8651:                     my $deeper = $depth+1;
                   8652:                     my $checked = '';
                   8653:                     if (ref($currcategories) eq 'ARRAY') {
                   8654:                         if (@{$currcategories} > 0) {
                   8655:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
                   8656:                                 $checked = ' checked="checked" ';
                   8657:                             }
                   8658:                         }
                   8659:                     }
1.664     raeburn  8660:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   8661:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  8662:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   8663:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   8664:                              '</td><td>';
1.663     raeburn  8665:                     if (ref($path) eq 'ARRAY') {
                   8666:                         push(@{$path},$name);
                   8667:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   8668:                         pop(@{$path});
                   8669:                     }
                   8670:                     $text .= '</td></tr>';
                   8671:                 }
                   8672:                 $text .= '</table></td>';
                   8673:             }
                   8674:         }
                   8675:     }
                   8676:     return $text;
                   8677: }
                   8678: 
1.655     raeburn  8679: ############################################################
                   8680: ############################################################
                   8681: 
                   8682: 
1.443     albertel 8683: sub commit_customrole {
1.664     raeburn  8684:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  8685:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 8686:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   8687:                          ($end?', ending '.localtime($end):'').': <b>'.
                   8688:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  8689:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 8690:                  '</b><br />';
                   8691:     return $output;
                   8692: }
                   8693: 
                   8694: sub commit_standardrole {
1.541     raeburn  8695:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   8696:     my ($output,$logmsg,$linefeed);
                   8697:     if ($context eq 'auto') {
                   8698:         $linefeed = "\n";
                   8699:     } else {
                   8700:         $linefeed = "<br />\n";
                   8701:     }  
1.443     albertel 8702:     if ($three eq 'st') {
1.541     raeburn  8703:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   8704:                                          $one,$two,$sec,$context);
                   8705:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  8706:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   8707:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 8708:         } else {
1.541     raeburn  8709:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 8710:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  8711:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   8712:             if ($context eq 'auto') {
                   8713:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   8714:             } else {
                   8715:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   8716:                &mt('Add to classlist').': <b>ok</b>';
                   8717:             }
                   8718:             $output .= $linefeed;
1.443     albertel 8719:         }
                   8720:     } else {
                   8721:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   8722:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  8723:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  8724:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  8725:         if ($context eq 'auto') {
                   8726:             $output .= $result.$linefeed;
                   8727:         } else {
                   8728:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   8729:         }
1.443     albertel 8730:     }
                   8731:     return $output;
                   8732: }
                   8733: 
                   8734: sub commit_studentrole {
1.541     raeburn  8735:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  8736:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  8737:     if ($context eq 'auto') {
                   8738:         $linefeed = "\n";
                   8739:     } else {
                   8740:         $linefeed = '<br />'."\n";
                   8741:     }
1.443     albertel 8742:     if (defined($one) && defined($two)) {
                   8743:         my $cid=$one.'_'.$two;
                   8744:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   8745:         my $secchange = 0;
                   8746:         my $expire_role_result;
                   8747:         my $modify_section_result;
1.628     raeburn  8748:         if ($oldsec ne '-1') { 
                   8749:             if ($oldsec ne $sec) {
1.443     albertel 8750:                 $secchange = 1;
1.628     raeburn  8751:                 my $now = time;
1.443     albertel 8752:                 my $uurl='/'.$cid;
                   8753:                 $uurl=~s/\_/\//g;
                   8754:                 if ($oldsec) {
                   8755:                     $uurl.='/'.$oldsec;
                   8756:                 }
1.626     raeburn  8757:                 $oldsecurl = $uurl;
1.628     raeburn  8758:                 $expire_role_result = 
1.652     raeburn  8759:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  8760:                 if ($env{'request.course.sec'} ne '') { 
                   8761:                     if ($expire_role_result eq 'refused') {
                   8762:                         my @roles = ('st');
                   8763:                         my @statuses = ('previous');
                   8764:                         my @roledoms = ($one);
                   8765:                         my $withsec = 1;
                   8766:                         my %roleshash = 
                   8767:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   8768:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   8769:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   8770:                             my ($oldstart,$oldend) = 
                   8771:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   8772:                             if ($oldend > 0 && $oldend <= $now) {
                   8773:                                 $expire_role_result = 'ok';
                   8774:                             }
                   8775:                         }
                   8776:                     }
                   8777:                 }
1.443     albertel 8778:                 $result = $expire_role_result;
                   8779:             }
                   8780:         }
                   8781:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  8782:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 8783:             if ($modify_section_result =~ /^ok/) {
                   8784:                 if ($secchange == 1) {
1.628     raeburn  8785:                     if ($sec eq '') {
                   8786:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   8787:                     } else {
                   8788:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   8789:                     }
1.443     albertel 8790:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  8791:                     if ($sec eq '') {
                   8792:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   8793:                     } else {
                   8794:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   8795:                     }
1.443     albertel 8796:                 } else {
1.628     raeburn  8797:                     if ($sec eq '') {
                   8798:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   8799:                     } else {
                   8800:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   8801:                     }
1.443     albertel 8802:                 }
                   8803:             } else {
1.628     raeburn  8804:                 if ($secchange) {       
                   8805:                     $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
                   8806:                 } else {
                   8807:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   8808:                 }
1.443     albertel 8809:             }
                   8810:             $result = $modify_section_result;
                   8811:         } elsif ($secchange == 1) {
1.628     raeburn  8812:             if ($oldsec eq '') {
                   8813:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   8814:             } else {
                   8815:                 $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
                   8816:             }
1.626     raeburn  8817:             if ($expire_role_result eq 'refused') {
                   8818:                 my $newsecurl = '/'.$cid;
                   8819:                 $newsecurl =~ s/\_/\//g;
                   8820:                 if ($sec ne '') {
                   8821:                     $newsecurl.='/'.$sec;
                   8822:                 }
                   8823:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   8824:                     if ($sec eq '') {
                   8825:                         $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
                   8826:                     } else {
                   8827:                         $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
                   8828:                     }
                   8829:                 }
                   8830:             }
1.443     albertel 8831:         }
                   8832:     } else {
1.626     raeburn  8833:         $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443     albertel 8834:         $result = "error: incomplete course id\n";
                   8835:     }
                   8836:     return $result;
                   8837: }
                   8838: 
                   8839: ############################################################
                   8840: ############################################################
                   8841: 
1.566     albertel 8842: sub check_clone {
1.578     raeburn  8843:     my ($args,$linefeed) = @_;
1.566     albertel 8844:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   8845:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   8846:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   8847:     my $clonemsg;
                   8848:     my $can_clone = 0;
                   8849: 
                   8850:     if ($clonehome eq 'no_host') {
1.578     raeburn  8851:         $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});     
1.566     albertel 8852:     } else {
                   8853: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568     albertel 8854: 	if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566     albertel 8855: 	    $can_clone = 1;
                   8856: 	} else {
                   8857: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   8858: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   8859: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  8860:             if (grep(/^\*$/,@cloners)) {
                   8861:                 $can_clone = 1;
                   8862:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   8863:                 $can_clone = 1;
                   8864:             } else {
                   8865: 	        my %roleshash =
                   8866: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   8867: 					 $args->{'ccdomain'},
                   8868:                                          'userroles',['active'],['cc'],
                   8869: 					 [$args->{'clonedomain'}]);
                   8870: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   8871: 		    $can_clone = 1;
                   8872: 	        } else {
                   8873:                     $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   8874: 	        }
1.566     albertel 8875: 	    }
1.578     raeburn  8876:         }
1.566     albertel 8877:     }
                   8878:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   8879: }
                   8880: 
1.444     albertel 8881: sub construct_course {
1.541     raeburn  8882:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444     albertel 8883:     my $outcome;
1.541     raeburn  8884:     my $linefeed =  '<br />'."\n";
                   8885:     if ($context eq 'auto') {
                   8886:         $linefeed = "\n";
                   8887:     }
1.566     albertel 8888: 
                   8889: #
                   8890: # Are we cloning?
                   8891: #
                   8892:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   8893:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  8894: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 8895: 	if ($context ne 'auto') {
1.578     raeburn  8896:             if ($clonemsg ne '') {
                   8897: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   8898:             }
1.566     albertel 8899: 	}
                   8900: 	$outcome .= $clonemsg.$linefeed;
                   8901: 
                   8902:         if (!$can_clone) {
                   8903: 	    return (0,$outcome);
                   8904: 	}
                   8905:     }
                   8906: 
1.444     albertel 8907: #
                   8908: # Open course
                   8909: #
                   8910:     my $crstype = lc($args->{'crstype'});
                   8911:     my %cenv=();
                   8912:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   8913:                                              $args->{'cdescr'},
                   8914:                                              $args->{'curl'},
                   8915:                                              $args->{'course_home'},
                   8916:                                              $args->{'nonstandard'},
                   8917:                                              $args->{'crscode'},
                   8918:                                              $args->{'ccuname'}.':'.
                   8919:                                              $args->{'ccdomain'},
                   8920:                                              $args->{'crstype'});
                   8921: 
                   8922:     # Note: The testing routines depend on this being output; see 
                   8923:     # Utils::Course. This needs to at least be output as a comment
                   8924:     # if anyone ever decides to not show this, and Utils::Course::new
                   8925:     # will need to be suitably modified.
1.541     raeburn  8926:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 8927: #
                   8928: # Check if created correctly
                   8929: #
1.479     albertel 8930:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 8931:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  8932:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 8933: 
1.444     albertel 8934: #
1.566     albertel 8935: # Do the cloning
                   8936: #   
                   8937:     if ($can_clone && $cloneid) {
                   8938: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   8939: 	if ($context ne 'auto') {
                   8940: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   8941: 	}
                   8942: 	$outcome .= $clonemsg.$linefeed;
                   8943: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 8944: # Copy all files
1.637     www      8945: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 8946: # Restore URL
1.566     albertel 8947: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 8948: # Restore title
1.566     albertel 8949: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 8950: # Mark as cloned
1.566     albertel 8951: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      8952: # Need to clone grading mode
                   8953:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   8954:         $cenv{'grading'}=$newenv{'grading'};
                   8955: # Do not clone these environment entries
                   8956:         &Apache::lonnet::del('environment',
                   8957:                   ['default_enrollment_start_date',
                   8958:                    'default_enrollment_end_date',
                   8959:                    'question.email',
                   8960:                    'policy.email',
                   8961:                    'comment.email',
                   8962:                    'pch.users.denied',
                   8963:                    'plc.users.denied'],
                   8964:                    $$crsudom,$$crsunum);
1.444     albertel 8965:     }
1.566     albertel 8966: 
1.444     albertel 8967: #
                   8968: # Set environment (will override cloned, if existing)
                   8969: #
                   8970:     my @sections = ();
                   8971:     my @xlists = ();
                   8972:     if ($args->{'crstype'}) {
                   8973:         $cenv{'type'}=$args->{'crstype'};
                   8974:     }
                   8975:     if ($args->{'crsid'}) {
                   8976:         $cenv{'courseid'}=$args->{'crsid'};
                   8977:     }
                   8978:     if ($args->{'crscode'}) {
                   8979:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   8980:     }
                   8981:     if ($args->{'crsquota'} ne '') {
                   8982:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   8983:     } else {
                   8984:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   8985:     }
                   8986:     if ($args->{'ccuname'}) {
                   8987:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   8988:                                         ':'.$args->{'ccdomain'};
                   8989:     } else {
                   8990:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   8991:     }
                   8992:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   8993:     if ($args->{'crssections'}) {
                   8994:         $cenv{'internal.sectionnums'} = '';
                   8995:         if ($args->{'crssections'} =~ m/,/) {
                   8996:             @sections = split/,/,$args->{'crssections'};
                   8997:         } else {
                   8998:             $sections[0] = $args->{'crssections'};
                   8999:         }
                   9000:         if (@sections > 0) {
                   9001:             foreach my $item (@sections) {
                   9002:                 my ($sec,$gp) = split/:/,$item;
                   9003:                 my $class = $args->{'crscode'}.$sec;
                   9004:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   9005:                 $cenv{'internal.sectionnums'} .= $item.',';
                   9006:                 unless ($addcheck eq 'ok') {
                   9007:                     push @badclasses, $class;
                   9008:                 }
                   9009:             }
                   9010:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   9011:         }
                   9012:     }
                   9013: # do not hide course coordinator from staff listing, 
                   9014: # even if privileged
                   9015:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9016: # add crosslistings
                   9017:     if ($args->{'crsxlist'}) {
                   9018:         $cenv{'internal.crosslistings'}='';
                   9019:         if ($args->{'crsxlist'} =~ m/,/) {
                   9020:             @xlists = split/,/,$args->{'crsxlist'};
                   9021:         } else {
                   9022:             $xlists[0] = $args->{'crsxlist'};
                   9023:         }
                   9024:         if (@xlists > 0) {
                   9025:             foreach my $item (@xlists) {
                   9026:                 my ($xl,$gp) = split/:/,$item;
                   9027:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   9028:                 $cenv{'internal.crosslistings'} .= $item.',';
                   9029:                 unless ($addcheck eq 'ok') {
                   9030:                     push @badclasses, $xl;
                   9031:                 }
                   9032:             }
                   9033:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   9034:         }
                   9035:     }
                   9036:     if ($args->{'autoadds'}) {
                   9037:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   9038:     }
                   9039:     if ($args->{'autodrops'}) {
                   9040:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   9041:     }
                   9042: # check for notification of enrollment changes
                   9043:     my @notified = ();
                   9044:     if ($args->{'notify_owner'}) {
                   9045:         if ($args->{'ccuname'} ne '') {
                   9046:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   9047:         }
                   9048:     }
                   9049:     if ($args->{'notify_dc'}) {
                   9050:         if ($uname ne '') { 
1.630     raeburn  9051:             push(@notified,$uname.':'.$udom);
1.444     albertel 9052:         }
                   9053:     }
                   9054:     if (@notified > 0) {
                   9055:         my $notifylist;
                   9056:         if (@notified > 1) {
                   9057:             $notifylist = join(',',@notified);
                   9058:         } else {
                   9059:             $notifylist = $notified[0];
                   9060:         }
                   9061:         $cenv{'internal.notifylist'} = $notifylist;
                   9062:     }
                   9063:     if (@badclasses > 0) {
                   9064:         my %lt=&Apache::lonlocal::texthash(
                   9065:                 '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',
                   9066:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   9067:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   9068:         );
1.541     raeburn  9069:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   9070:                            ' ('.$lt{'adby'}.')';
                   9071:         if ($context eq 'auto') {
                   9072:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 9073:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  9074:             foreach my $item (@badclasses) {
                   9075:                 if ($context eq 'auto') {
                   9076:                     $outcome .= " - $item\n";
                   9077:                 } else {
                   9078:                     $outcome .= "<li>$item</li>\n";
                   9079:                 }
                   9080:             }
                   9081:             if ($context eq 'auto') {
                   9082:                 $outcome .= $linefeed;
                   9083:             } else {
1.566     albertel 9084:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  9085:             }
                   9086:         } 
1.444     albertel 9087:     }
                   9088:     if ($args->{'no_end_date'}) {
                   9089:         $args->{'endaccess'} = 0;
                   9090:     }
                   9091:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   9092:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   9093:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   9094:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   9095:     if ($args->{'showphotos'}) {
                   9096:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   9097:     }
                   9098:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   9099:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   9100:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   9101:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  9102:             my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student'); 
                   9103:             if ($context eq 'auto') {
                   9104:                 $outcome .= $krb_msg;
                   9105:             } else {
1.566     albertel 9106:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  9107:             }
                   9108:             $outcome .= $linefeed;
1.444     albertel 9109:         }
                   9110:     }
                   9111:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   9112:        if ($args->{'setpolicy'}) {
                   9113:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9114:        }
                   9115:        if ($args->{'setcontent'}) {
                   9116:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   9117:        }
                   9118:     }
                   9119:     if ($args->{'reshome'}) {
                   9120: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   9121: 	$cenv{'reshome'}=~s/\/+$/\//;
                   9122:     }
                   9123: #
                   9124: # course has keyed access
                   9125: #
                   9126:     if ($args->{'setkeys'}) {
                   9127:        $cenv{'keyaccess'}='yes';
                   9128:     }
                   9129: # if specified, key authority is not course, but user
                   9130: # only active if keyaccess is yes
                   9131:     if ($args->{'keyauth'}) {
1.487     albertel 9132: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   9133: 	$user = &LONCAPA::clean_username($user);
                   9134: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     9135: 	if ($user ne '' && $domain ne '') {
1.487     albertel 9136: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 9137: 	}
                   9138:     }
                   9139: 
                   9140:     if ($args->{'disresdis'}) {
                   9141:         $cenv{'pch.roles.denied'}='st';
                   9142:     }
                   9143:     if ($args->{'disablechat'}) {
                   9144:         $cenv{'plc.roles.denied'}='st';
                   9145:     }
                   9146: 
                   9147:     # Record we've not yet viewed the Course Initialization Helper for this 
                   9148:     # course
                   9149:     $cenv{'course.helper.not.run'} = 1;
                   9150:     #
                   9151:     # Use new Randomseed
                   9152:     #
                   9153:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   9154:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   9155:     #
                   9156:     # The encryption code and receipt prefix for this course
                   9157:     #
                   9158:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   9159:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   9160:     #
                   9161:     # By default, use standard grading
                   9162:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   9163: 
1.541     raeburn  9164:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   9165:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 9166: #
                   9167: # Open all assignments
                   9168: #
                   9169:     if ($args->{'openall'}) {
                   9170:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   9171:        my %storecontent = ($storeunder         => time,
                   9172:                            $storeunder.'.type' => 'date_start');
                   9173:        
                   9174:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  9175:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 9176:    }
                   9177: #
                   9178: # Set first page
                   9179: #
                   9180:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   9181: 	    || ($cloneid)) {
1.445     albertel 9182: 	use LONCAPA::map;
1.444     albertel 9183: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 9184: 
                   9185: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   9186:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   9187: 
1.444     albertel 9188:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   9189:         my $title; my $url;
                   9190:         if ($args->{'firstres'} eq 'syl') {
                   9191: 	    $title='Syllabus';
                   9192:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   9193:         } else {
                   9194:             $title='Navigate Contents';
                   9195:             $url='/adm/navmaps';
                   9196:         }
1.445     albertel 9197: 
                   9198:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   9199: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   9200: 
                   9201: 	if ($errtext) { $fatal=2; }
1.541     raeburn  9202:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 9203:     }
1.566     albertel 9204: 
                   9205:     return (1,$outcome);
1.444     albertel 9206: }
                   9207: 
                   9208: ############################################################
                   9209: ############################################################
                   9210: 
1.378     raeburn  9211: sub course_type {
                   9212:     my ($cid) = @_;
                   9213:     if (!defined($cid)) {
                   9214:         $cid = $env{'request.course.id'};
                   9215:     }
1.404     albertel 9216:     if (defined($env{'course.'.$cid.'.type'})) {
                   9217:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  9218:     } else {
                   9219:         return 'Course';
1.377     raeburn  9220:     }
                   9221: }
1.156     albertel 9222: 
1.406     raeburn  9223: sub group_term {
                   9224:     my $crstype = &course_type();
                   9225:     my %names = (
                   9226:                   'Course' => 'group',
                   9227:                   'Group' => 'team',
                   9228:                 );
                   9229:     return $names{$crstype};
                   9230: }
                   9231: 
1.156     albertel 9232: sub icon {
                   9233:     my ($file)=@_;
1.505     albertel 9234:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 9235:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 9236:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 9237:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   9238: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   9239: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   9240: 	            $curfext.".gif") {
                   9241: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   9242: 		$curfext.".gif";
                   9243: 	}
                   9244:     }
1.249     albertel 9245:     return &lonhttpdurl($iconname);
1.154     albertel 9246: } 
1.84      albertel 9247: 
1.575     albertel 9248: sub lonhttpd_port {
1.215     albertel 9249:     my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
                   9250:     if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
1.574     albertel 9251:     # IE doesn't like a secure page getting images from a non-secure
                   9252:     # port (when logging we haven't parsed the browser type so default
                   9253:     # back to secure
                   9254:     if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')
                   9255: 	&& $ENV{'SERVER_PORT'} == 443) {
1.575     albertel 9256: 	return 443;
                   9257:     }
                   9258:     return $lonhttpd_port;
                   9259: 
                   9260: }
                   9261: 
                   9262: sub lonhttpdurl {
                   9263:     my ($url)=@_;
                   9264: 
                   9265:     my $lonhttpd_port = &lonhttpd_port();
                   9266:     if ($lonhttpd_port == 443) {
1.574     albertel 9267: 	return 'https://'.$ENV{'SERVER_NAME'}.$url;
                   9268:     }
1.215     albertel 9269:     return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
                   9270: }
                   9271: 
1.213     albertel 9272: sub connection_aborted {
                   9273:     my ($r)=@_;
                   9274:     $r->print(" ");$r->rflush();
                   9275:     my $c = $r->connection;
                   9276:     return $c->aborted();
                   9277: }
                   9278: 
1.221     foxr     9279: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     9280: #    strings as 'strings'.
                   9281: sub escape_single {
1.221     foxr     9282:     my ($input) = @_;
1.223     albertel 9283:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     9284:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   9285:     return $input;
                   9286: }
1.223     albertel 9287: 
1.222     foxr     9288: #  Same as escape_single, but escape's "'s  This 
                   9289: #  can be used for  "strings"
                   9290: sub escape_double {
                   9291:     my ($input) = @_;
                   9292:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   9293:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   9294:     return $input;
                   9295: }
1.223     albertel 9296:  
1.222     foxr     9297: #   Escapes the last element of a full URL.
                   9298: sub escape_url {
                   9299:     my ($url)   = @_;
1.238     raeburn  9300:     my @urlslices = split(/\//, $url,-1);
1.369     www      9301:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 9302:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     9303: }
1.462     albertel 9304: 
                   9305: # -------------------------------------------------------- Initliaze user login
                   9306: sub init_user_environment {
1.463     albertel 9307:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 9308:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   9309: 
                   9310:     my $public=($username eq 'public' && $domain eq 'public');
                   9311: 
                   9312: # See if old ID present, if so, remove
                   9313: 
                   9314:     my ($filename,$cookie,$userroles);
                   9315:     my $now=time;
                   9316: 
                   9317:     if ($public) {
                   9318: 	my $max_public=100;
                   9319: 	my $oldest;
                   9320: 	my $oldest_time=0;
                   9321: 	for(my $next=1;$next<=$max_public;$next++) {
                   9322: 	    if (-e $lonids."/publicuser_$next.id") {
                   9323: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   9324: 		if ($mtime<$oldest_time || !$oldest_time) {
                   9325: 		    $oldest_time=$mtime;
                   9326: 		    $oldest=$next;
                   9327: 		}
                   9328: 	    } else {
                   9329: 		$cookie="publicuser_$next";
                   9330: 		last;
                   9331: 	    }
                   9332: 	}
                   9333: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   9334:     } else {
1.463     albertel 9335: 	# if this isn't a robot, kill any existing non-robot sessions
                   9336: 	if (!$args->{'robot'}) {
                   9337: 	    opendir(DIR,$lonids);
                   9338: 	    while ($filename=readdir(DIR)) {
                   9339: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   9340: 		    unlink($lonids.'/'.$filename);
                   9341: 		}
1.462     albertel 9342: 	    }
1.463     albertel 9343: 	    closedir(DIR);
1.462     albertel 9344: 	}
                   9345: # Give them a new cookie
1.463     albertel 9346: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
                   9347: 		                   : $now);
                   9348: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 9349:     
                   9350: # Initialize roles
                   9351: 
                   9352: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   9353:     }
                   9354: # ------------------------------------ Check browser type and MathML capability
                   9355: 
                   9356:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   9357:         $clientunicode,$clientos) = &decode_user_agent($r);
                   9358: 
                   9359: # -------------------------------------- Any accessibility options to remember?
                   9360:     if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
                   9361: 	foreach my $option ('imagesuppress','appletsuppress',
                   9362: 			    'embedsuppress','fontenhance','blackwhite') {
                   9363: 	    if ($form->{$option} eq 'true') {
                   9364: 		&Apache::lonnet::put('environment',{$option => 'on'},
                   9365: 				     $domain,$username);
                   9366: 	    } else {
                   9367: 		&Apache::lonnet::del('environment',[$option],
                   9368: 				     $domain,$username);
                   9369: 	    }
                   9370: 	}
                   9371:     }
                   9372: # ------------------------------------------------------------- Get environment
                   9373: 
                   9374:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   9375:     my ($tmp) = keys(%userenv);
                   9376:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   9377: 	# default remote control to off
                   9378: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   9379:     } else {
                   9380: 	undef(%userenv);
                   9381:     }
                   9382:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   9383: 	$form->{'interface'}=$userenv{'interface'};
                   9384:     }
                   9385:     $env{'environment.remote'}=$userenv{'remote'};
                   9386:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   9387: 
                   9388: # --------------- Do not trust query string to be put directly into environment
                   9389:     foreach my $option ('imagesuppress','appletsuppress',
                   9390: 			'embedsuppress','fontenhance','blackwhite',
                   9391: 			'interface','localpath','localres') {
                   9392: 	$form->{$option}=~s/[\n\r\=]//gs;
                   9393:     }
                   9394: # --------------------------------------------------------- Write first profile
                   9395: 
                   9396:     {
                   9397: 	my %initial_env = 
                   9398: 	    ("user.name"          => $username,
                   9399: 	     "user.domain"        => $domain,
                   9400: 	     "user.home"          => $authhost,
                   9401: 	     "browser.type"       => $clientbrowser,
                   9402: 	     "browser.version"    => $clientversion,
                   9403: 	     "browser.mathml"     => $clientmathml,
                   9404: 	     "browser.unicode"    => $clientunicode,
                   9405: 	     "browser.os"         => $clientos,
                   9406: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   9407: 	     "request.course.fn"  => '',
                   9408: 	     "request.course.uri" => '',
                   9409: 	     "request.course.sec" => '',
                   9410: 	     "request.role"       => 'cm',
                   9411: 	     "request.role.adv"   => $env{'user.adv'},
                   9412: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   9413: 
                   9414:         if ($form->{'localpath'}) {
                   9415: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   9416: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   9417:         }
                   9418: 	
                   9419: 	if ($public) {
                   9420: 	    $initial_env{"environment.remote"} = "off";
                   9421: 	}
                   9422: 	if ($form->{'interface'}) {
                   9423: 	    $form->{'interface'}=~s/\W//gs;
                   9424: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   9425: 	    $env{'browser.interface'}=$form->{'interface'};
                   9426: 	    foreach my $option ('imagesuppress','appletsuppress',
                   9427: 				'embedsuppress','fontenhance','blackwhite') {
                   9428: 		if (($form->{$option} eq 'true') ||
                   9429: 		    ($userenv{$option} eq 'on')) {
                   9430: 		    $initial_env{"browser.$option"} = "on";
                   9431: 		}
                   9432: 	    }
                   9433: 	}
                   9434: 
                   9435: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   9436: 	
                   9437: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   9438: 		 &GDBM_WRCREAT(),0640)) {
                   9439: 	    &_add_to_env(\%disk_env,\%initial_env);
                   9440: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   9441: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 9442: 	    if (ref($args->{'extra_env'})) {
                   9443: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   9444: 	    }
1.462     albertel 9445: 	    untie(%disk_env);
                   9446: 	} else {
                   9447: 	    &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
                   9448: 			   'Could not create environment storage in lonauth: '.$!.'</font>');
                   9449: 	    return 'error: '.$!;
                   9450: 	}
                   9451:     }
                   9452:     $env{'request.role'}='cm';
                   9453:     $env{'request.role.adv'}=$env{'user.adv'};
                   9454:     $env{'browser.type'}=$clientbrowser;
                   9455: 
                   9456:     return $cookie;
                   9457: 
                   9458: }
                   9459: 
                   9460: sub _add_to_env {
                   9461:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  9462:     if (ref($env_data) eq 'HASH') {
                   9463:         while (my ($key,$value) = each(%$env_data)) {
                   9464: 	    $idf->{$prefix.$key} = $value;
                   9465: 	    $env{$prefix.$key}   = $value;
                   9466:         }
1.462     albertel 9467:     }
                   9468: }
                   9469: 
                   9470: 
1.41      ng       9471: =pod
                   9472: 
                   9473: =back
                   9474: 
1.112     bowersj2 9475: =cut
1.41      ng       9476: 
1.112     bowersj2 9477: 1;
                   9478: __END__;
1.41      ng       9479: 

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