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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.892   ! amueller    4: # $Id: loncommon.pm,v 1.891 2009/09/26 21:46:38 bisitz 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.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.468     raeburn   485:     my ($domainfilter,$sec_element,$formname)=@_;
1.886     raeburn   486:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Community - for which you wish to add/modify a user role.');
1.876     raeburn   487:     my $id_functions = &javascript_index_functions();
                    488:     my $output = '
1.776     bisitz    489: <script type="text/javascript" language="JavaScript">
1.824     bisitz    490: // <![CDATA[
1.468     raeburn   491:     var stdeditbrowser;'."\n";
1.876     raeburn   492: 
                    493:     $output .= <<"ENDSTDBRW";
1.377     raeburn   494:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       495:         var url = '/adm/pickcourse?';
1.876     raeburn   496:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  497:         if (domainfilter != null) {
                    498:            if (domainfilter != '') {
                    499:                url += 'domainfilter='+domainfilter+'&';
                    500: 	   }
                    501:         }
1.91      www       502:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  503: 	                            '&cdomelement='+udom+
                    504:                                     '&cnameelement='+desc;
1.468     raeburn   505:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   506:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   507:                 url += '&roleelement='+extra_element;
                    508:                 if (domainfilter == null || domainfilter == '') {
                    509:                     url += '&domainfilter='+extra_element;
                    510:                 }
1.234     raeburn   511:             }
1.468     raeburn   512:             else {
                    513:                 if (formname == 'portform') {
                    514:                     url += '&setroles='+extra_element;
1.800     raeburn   515:                 } else {
                    516:                     if (formname == 'rules') {
                    517:                         url += '&fixeddom='+extra_element; 
                    518:                     }
1.468     raeburn   519:                 }
                    520:             }     
1.230     raeburn   521:         }
1.872     raeburn   522:         if (formname == 'ccrs') {
                    523:             var ownername = document.forms[formid].ccuname.value;
                    524:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    525:             url += '&cloner='+ownername+':'+ownerdom;
                    526:         }
1.293     raeburn   527:         if (multflag !=null && multflag != '') {
                    528:             url += '&multiple='+multflag;
                    529:         }
1.865     raeburn   530:         if (crstype == 'Course/Community') {
1.377     raeburn   531:             if (formname == 'cu') {
                    532:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    533:                 if (crstype == "") {
                    534:                     alert("$crs_or_grp_alert");
                    535:                     return;
                    536:                 }
                    537:             }
                    538:         }
                    539:         if (crstype !=null && crstype != '') {
                    540:             url += '&type='+crstype;
                    541:         }
1.102     www       542:         var title = 'Course_Browser';
1.91      www       543:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    544:         options += ',width=700,height=600';
                    545:         stdeditbrowser = open(url,title,options,'1');
                    546:         stdeditbrowser.focus();
                    547:     }
1.876     raeburn   548: $id_functions
                    549: ENDSTDBRW
                    550:     if ($sec_element ne '') {
                    551:         $output .= &setsec_javascript($sec_element,$formname);
                    552:     }
                    553:     $output .= '
                    554: // ]]>
                    555: </script>';
                    556:     return $output;
                    557: }
                    558: 
                    559: sub javascript_index_functions {
                    560:     return <<"ENDJS";
                    561: 
                    562: function getFormIdByName(formname) {
                    563:     for (var i=0;i<document.forms.length;i++) {
                    564:         if (document.forms[i].name == formname) {
                    565:             return i;
                    566:         }
                    567:     }
                    568:     return -1;
                    569: }
                    570: 
                    571: function getIndexByName(formid,item) {
                    572:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    573:         if (document.forms[formid].elements[i].name == item) {
                    574:             return i;
                    575:         }
                    576:     }
                    577:     return -1;
                    578: }
1.468     raeburn   579: 
1.876     raeburn   580: function getDomainFromSelectbox(formname,udom) {
                    581:     var userdom;
                    582:     var formid = getFormIdByName(formname);
                    583:     if (formid > -1) {
                    584:         var domid = getIndexByName(formid,udom);
                    585:         if (domid > -1) {
                    586:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    587:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    588:             }
                    589:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    590:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   591:             }
                    592:         }
                    593:     }
1.876     raeburn   594:     return userdom;
                    595: }
                    596: 
                    597: ENDJS
1.468     raeburn   598: 
1.876     raeburn   599: }
                    600: 
                    601: sub userbrowser_javascript {
                    602:     my $id_functions = &javascript_index_functions();
                    603:     return <<"ENDUSERBRW";
                    604: 
1.888     raeburn   605: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   606:     var url = '/adm/pickuser?';
                    607:     var userdom = getDomainFromSelectbox(formname,udom);
                    608:     if (userdom != null) {
                    609:        if (userdom != '') {
                    610:            url += 'srchdom='+userdom+'&';
                    611:        }
                    612:     }
                    613:     url += 'form=' + formname + '&unameelement='+uname+
                    614:                                 '&udomelement='+udom+
                    615:                                 '&ulastelement='+ulast+
                    616:                                 '&ufirstelement='+ufirst+
                    617:                                 '&uemailelement='+uemail+
1.881     raeburn   618:                                 '&hideudomelement='+hideudom+
                    619:                                 '&coursedom='+crsdom;
1.888     raeburn   620:     if ((caller != null) && (caller != undefined)) {
                    621:         url += '&caller='+caller;
                    622:     }
1.876     raeburn   623:     var title = 'User_Browser';
                    624:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    625:     options += ',width=700,height=600';
                    626:     var stdeditbrowser = open(url,title,options,'1');
                    627:     stdeditbrowser.focus();
                    628: }
                    629: 
1.888     raeburn   630: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   631:     var formid = getFormIdByName(formname);
                    632:     if (formid > -1) {
1.888     raeburn   633:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   634:         var domid = getIndexByName(formid,udom);
                    635:         var hidedomid = getIndexByName(formid,origdom);
                    636:         if (hidedomid > -1) {
                    637:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   638:             var unameval = document.forms[formid].elements[unameid].value;
                    639:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    640:                 if (domid > -1) {
                    641:                     var slct = document.forms[formid].elements[domid];
                    642:                     if (slct.type == 'select-one') {
                    643:                         var i;
                    644:                         for (i=0;i<slct.length;i++) {
                    645:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    646:                         }
                    647:                     }
                    648:                     if (slct.type == 'hidden') {
                    649:                         slct.value = fixeddom;
1.876     raeburn   650:                     }
                    651:                 }
1.468     raeburn   652:             }
                    653:         }
                    654:     }
1.876     raeburn   655:     return;
                    656: }
                    657: 
                    658: $id_functions
                    659: ENDUSERBRW
1.468     raeburn   660: }
                    661: 
                    662: sub setsec_javascript {
                    663:     my ($sec_element,$formname) = @_;
                    664:     my $setsections = qq|
                    665: function setSect(sectionlist) {
1.629     raeburn   666:     var sectionsArray = new Array();
                    667:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    668:         sectionsArray = sectionlist.split(",");
                    669:     }
1.468     raeburn   670:     var numSections = sectionsArray.length;
                    671:     document.$formname.$sec_element.length = 0;
                    672:     if (numSections == 0) {
                    673:         document.$formname.$sec_element.multiple=false;
                    674:         document.$formname.$sec_element.size=1;
                    675:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    676:     } else {
                    677:         if (numSections == 1) {
                    678:             document.$formname.$sec_element.multiple=false;
                    679:             document.$formname.$sec_element.size=1;
                    680:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    681:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    682:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    683:         } else {
                    684:             for (var i=0; i<numSections; i++) {
                    685:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    686:             }
                    687:             document.$formname.$sec_element.multiple=true
                    688:             if (numSections < 3) {
                    689:                 document.$formname.$sec_element.size=numSections;
                    690:             } else {
                    691:                 document.$formname.$sec_element.size=3;
                    692:             }
                    693:             document.$formname.$sec_element.options[0].selected = false
                    694:         }
                    695:     }
1.91      www       696: }
1.468     raeburn   697: |;
                    698:     return $setsections;
                    699: }
                    700: 
1.91      www       701: 
                    702: sub selectcourse_link {
1.377     raeburn   703:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.871     raeburn   704:    my $linktext = &mt('Select Course');
                    705:    if ($selecttype eq 'Community') {
                    706:        $linktext = &mt('Select Community'); 
                    707:    }
1.787     bisitz    708:    return '<span class="LC_nobreak">'
                    709:          ."<a href='"
                    710:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    711:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    712:          .'","'.$multflag.'","'.$selecttype.'");'
1.871     raeburn   713:          ."'>".$linktext.'</a>'
1.787     bisitz    714:          .'</span>';
1.74      www       715: }
1.42      matthew   716: 
1.653     raeburn   717: sub selectauthor_link {
                    718:    my ($form,$udom)=@_;
                    719:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    720:           &mt('Select Author').'</a>';
                    721: }
                    722: 
1.876     raeburn   723: sub selectuser_link {
1.881     raeburn   724:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   725:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   726:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   727:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   728:            ');">'.$linktext.'</a>';
1.876     raeburn   729: }
                    730: 
1.273     raeburn   731: sub check_uncheck_jscript {
                    732:     my $jscript = <<"ENDSCRT";
                    733: function checkAll(field) {
                    734:     if (field.length > 0) {
                    735:         for (i = 0; i < field.length; i++) {
                    736:             field[i].checked = true ;
                    737:         }
                    738:     } else {
                    739:         field.checked = true
                    740:     }
                    741: }
                    742:  
                    743: function uncheckAll(field) {
                    744:     if (field.length > 0) {
                    745:         for (i = 0; i < field.length; i++) {
                    746:             field[i].checked = false ;
1.543     albertel  747:         }
                    748:     } else {
1.273     raeburn   749:         field.checked = false ;
                    750:     }
                    751: }
                    752: ENDSCRT
                    753:     return $jscript;
                    754: }
                    755: 
1.656     www       756: sub select_timezone {
1.659     raeburn   757:    my ($name,$selected,$onchange,$includeempty)=@_;
                    758:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    759:    if ($includeempty) {
                    760:        $output .= '<option value=""';
                    761:        if (($selected eq '') || ($selected eq 'local')) {
                    762:            $output .= ' selected="selected" ';
                    763:        }
                    764:        $output .= '> </option>';
                    765:    }
1.657     raeburn   766:    my @timezones = DateTime::TimeZone->all_names;
                    767:    foreach my $tzone (@timezones) {
                    768:        $output.= '<option value="'.$tzone.'"';
                    769:        if ($tzone eq $selected) {
                    770:            $output.=' selected="selected"';
                    771:        }
                    772:        $output.=">$tzone</option>\n";
1.656     www       773:    }
                    774:    $output.="</select>";
                    775:    return $output;
                    776: }
1.273     raeburn   777: 
1.687     raeburn   778: sub select_datelocale {
                    779:     my ($name,$selected,$onchange,$includeempty)=@_;
                    780:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    781:     if ($includeempty) {
                    782:         $output .= '<option value=""';
                    783:         if ($selected eq '') {
                    784:             $output .= ' selected="selected" ';
                    785:         }
                    786:         $output .= '> </option>';
                    787:     }
                    788:     my (@possibles,%locale_names);
                    789:     my @locales = DateTime::Locale::Catalog::Locales;
                    790:     foreach my $locale (@locales) {
                    791:         if (ref($locale) eq 'HASH') {
                    792:             my $id = $locale->{'id'};
                    793:             if ($id ne '') {
                    794:                 my $en_terr = $locale->{'en_territory'};
                    795:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   796:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   797:                 if (grep(/^en$/,@languages) || !@languages) {
                    798:                     if ($en_terr ne '') {
                    799:                         $locale_names{$id} = '('.$en_terr.')';
                    800:                     } elsif ($native_terr ne '') {
                    801:                         $locale_names{$id} = $native_terr;
                    802:                     }
                    803:                 } else {
                    804:                     if ($native_terr ne '') {
                    805:                         $locale_names{$id} = $native_terr.' ';
                    806:                     } elsif ($en_terr ne '') {
                    807:                         $locale_names{$id} = '('.$en_terr.')';
                    808:                     }
                    809:                 }
                    810:                 push (@possibles,$id);
                    811:             }
                    812:         }
                    813:     }
                    814:     foreach my $item (sort(@possibles)) {
                    815:         $output.= '<option value="'.$item.'"';
                    816:         if ($item eq $selected) {
                    817:             $output.=' selected="selected"';
                    818:         }
                    819:         $output.=">$item";
                    820:         if ($locale_names{$item} ne '') {
                    821:             $output.="  $locale_names{$item}</option>\n";
                    822:         }
                    823:         $output.="</option>\n";
                    824:     }
                    825:     $output.="</select>";
                    826:     return $output;
                    827: }
                    828: 
1.792     raeburn   829: sub select_language {
                    830:     my ($name,$selected,$includeempty) = @_;
                    831:     my %langchoices;
                    832:     if ($includeempty) {
                    833:         %langchoices = ('' => 'No language preference');
                    834:     }
                    835:     foreach my $id (&languageids()) {
                    836:         my $code = &supportedlanguagecode($id);
                    837:         if ($code) {
                    838:             $langchoices{$code} = &plainlanguagedescription($id);
                    839:         }
                    840:     }
                    841:     return &select_form($selected,$name,%langchoices);
                    842: }
                    843: 
1.42      matthew   844: =pod
1.36      matthew   845: 
1.648     raeburn   846: =item * &linked_select_forms(...)
1.36      matthew   847: 
                    848: linked_select_forms returns a string containing a <script></script> block
                    849: and html for two <select> menus.  The select menus will be linked in that
                    850: changing the value of the first menu will result in new values being placed
                    851: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   852: order unless a defined order is provided.
1.36      matthew   853: 
                    854: linked_select_forms takes the following ordered inputs:
                    855: 
                    856: =over 4
                    857: 
1.112     bowersj2  858: =item * $formname, the name of the <form> tag
1.36      matthew   859: 
1.112     bowersj2  860: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   861: 
1.112     bowersj2  862: =item * $firstdefault, the default value for the first menu
1.36      matthew   863: 
1.112     bowersj2  864: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   865: 
1.112     bowersj2  866: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   867: 
1.112     bowersj2  868: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   869: 
1.609     raeburn   870: =item * $menuorder, the order of values in the first menu
                    871: 
1.41      ng        872: =back 
                    873: 
1.36      matthew   874: Below is an example of such a hash.  Only the 'text', 'default', and 
                    875: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    876: values for the first select menu.  The text that coincides with the 
1.41      ng        877: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   878: and text for the second menu are given in the hash pointed to by 
                    879: $menu{$choice1}->{'select2'}.  
                    880: 
1.112     bowersj2  881:  my %menu = ( A1 => { text =>"Choice A1" ,
                    882:                        default => "B3",
                    883:                        select2 => { 
                    884:                            B1 => "Choice B1",
                    885:                            B2 => "Choice B2",
                    886:                            B3 => "Choice B3",
                    887:                            B4 => "Choice B4"
1.609     raeburn   888:                            },
                    889:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  890:                    },
                    891:                A2 => { text =>"Choice A2" ,
                    892:                        default => "C2",
                    893:                        select2 => { 
                    894:                            C1 => "Choice C1",
                    895:                            C2 => "Choice C2",
                    896:                            C3 => "Choice C3"
1.609     raeburn   897:                            },
                    898:                        order => ['C2','C1','C3'],
1.112     bowersj2  899:                    },
                    900:                A3 => { text =>"Choice A3" ,
                    901:                        default => "D6",
                    902:                        select2 => { 
                    903:                            D1 => "Choice D1",
                    904:                            D2 => "Choice D2",
                    905:                            D3 => "Choice D3",
                    906:                            D4 => "Choice D4",
                    907:                            D5 => "Choice D5",
                    908:                            D6 => "Choice D6",
                    909:                            D7 => "Choice D7"
1.609     raeburn   910:                            },
                    911:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  912:                    }
                    913:                );
1.36      matthew   914: 
                    915: =cut
                    916: 
                    917: sub linked_select_forms {
                    918:     my ($formname,
                    919:         $middletext,
                    920:         $firstdefault,
                    921:         $firstselectname,
                    922:         $secondselectname, 
1.609     raeburn   923:         $hashref,
                    924:         $menuorder,
1.36      matthew   925:         ) = @_;
                    926:     my $second = "document.$formname.$secondselectname";
                    927:     my $first = "document.$formname.$firstselectname";
                    928:     # output the javascript to do the changing
                    929:     my $result = '';
1.776     bisitz    930:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    931:     $result.="// <![CDATA[\n";
1.36      matthew   932:     $result.="var select2data = new Object();\n";
                    933:     $" = '","';
                    934:     my $debug = '';
                    935:     foreach my $s1 (sort(keys(%$hashref))) {
                    936:         $result.="select2data.d_$s1 = new Object();\n";        
                    937:         $result.="select2data.d_$s1.def = new String('".
                    938:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   939:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   940:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   941:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    942:             @s2values = @{$hashref->{$s1}->{'order'}};
                    943:         }
1.36      matthew   944:         $result.="\"@s2values\");\n";
                    945:         $result.="select2data.d_$s1.texts = new Array(";        
                    946:         my @s2texts;
                    947:         foreach my $value (@s2values) {
                    948:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    949:         }
                    950:         $result.="\"@s2texts\");\n";
                    951:     }
                    952:     $"=' ';
                    953:     $result.= <<"END";
                    954: 
                    955: function select1_changed() {
                    956:     // Determine new choice
                    957:     var newvalue = "d_" + $first.value;
                    958:     // update select2
                    959:     var values     = select2data[newvalue].values;
                    960:     var texts      = select2data[newvalue].texts;
                    961:     var select2def = select2data[newvalue].def;
                    962:     var i;
                    963:     // out with the old
                    964:     for (i = 0; i < $second.options.length; i++) {
                    965:         $second.options[i] = null;
                    966:     }
                    967:     // in with the nuclear
                    968:     for (i=0;i<values.length; i++) {
                    969:         $second.options[i] = new Option(values[i]);
1.143     matthew   970:         $second.options[i].value = values[i];
1.36      matthew   971:         $second.options[i].text = texts[i];
                    972:         if (values[i] == select2def) {
                    973:             $second.options[i].selected = true;
                    974:         }
                    975:     }
                    976: }
1.824     bisitz    977: // ]]>
1.36      matthew   978: </script>
                    979: END
                    980:     # output the initial values for the selection lists
                    981:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   982:     my @order = sort(keys(%{$hashref}));
                    983:     if (ref($menuorder) eq 'ARRAY') {
                    984:         @order = @{$menuorder};
                    985:     }
                    986:     foreach my $value (@order) {
1.36      matthew   987:         $result.="    <option value=\"$value\" ";
1.253     albertel  988:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       989:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   990:     }
                    991:     $result .= "</select>\n";
                    992:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    993:     $result .= $middletext;
                    994:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    995:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   996:     
                    997:     my @secondorder = sort(keys(%select2));
                    998:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    999:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1000:     }
                   1001:     foreach my $value (@secondorder) {
1.36      matthew  1002:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1003:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1004:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1005:     }
                   1006:     $result .= "</select>\n";
                   1007:     #    return $debug;
                   1008:     return $result;
                   1009: }   #  end of sub linked_select_forms {
                   1010: 
1.45      matthew  1011: =pod
1.44      bowersj2 1012: 
1.648     raeburn  1013: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1014: 
1.112     bowersj2 1015: Returns a string corresponding to an HTML link to the given help
                   1016: $topic, where $topic corresponds to the name of a .tex file in
                   1017: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1018: spaces. 
                   1019: 
                   1020: $text will optionally be linked to the same topic, allowing you to
                   1021: link text in addition to the graphic. If you do not want to link
                   1022: text, but wish to specify one of the later parameters, pass an
                   1023: empty string. 
                   1024: 
                   1025: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1026: the link will not open a new window. If false, the link will open
                   1027: a new window using Javascript. (Default is false.) 
                   1028: 
                   1029: $width and $height are optional numerical parameters that will
                   1030: override the width and height of the popped up window, which may
                   1031: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1032: 
                   1033: =cut
                   1034: 
                   1035: sub help_open_topic {
1.48      bowersj2 1036:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1037:     $text = "" if (not defined $text);
1.44      bowersj2 1038:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1039:     $width = 350 if (not defined $width);
                   1040:     $height = 400 if (not defined $height);
                   1041:     my $filename = $topic;
                   1042:     $filename =~ s/ /_/g;
                   1043: 
1.48      bowersj2 1044:     my $template = "";
                   1045:     my $link;
1.572     banghart 1046:     
1.159     www      1047:     $topic=~s/\W/\_/g;
1.44      bowersj2 1048: 
1.572     banghart 1049:     if (!$stayOnPage) {
1.72      bowersj2 1050: 	$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 1051:     } else {
1.48      bowersj2 1052: 	$link = "/adm/help/${filename}.hlp";
                   1053:     }
                   1054: 
                   1055:     # Add the text
1.755     neumanie 1056:     if ($text ne "") {	
1.763     bisitz   1057: 	$template.='<span class="LC_help_open_topic">'
                   1058:                   .'<a target="_top" href="'.$link.'">'
                   1059:                   .$text.'</a>';
1.48      bowersj2 1060:     }
                   1061: 
1.763     bisitz   1062:     # (Always) Add the graphic
1.179     matthew  1063:     my $title = &mt('Online Help');
1.667     raeburn  1064:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1065:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1066:               .'<img src="'.$helpicon.'" border="0"'
                   1067:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1068:               .' title="'.$title.'"' 
1.763     bisitz   1069:               .' /></a>';
                   1070:     if ($text ne "") {	
                   1071:         $template.='</span>';
                   1072:     }
1.44      bowersj2 1073:     return $template;
                   1074: 
1.106     bowersj2 1075: }
                   1076: 
                   1077: # This is a quicky function for Latex cheatsheet editing, since it 
                   1078: # appears in at least four places
                   1079: sub helpLatexCheatsheet {
1.732     raeburn  1080:     my ($topic,$text,$not_author) = @_;
                   1081:     my $out;
1.106     bowersj2 1082:     my $addOther = '';
1.732     raeburn  1083:     if ($topic) {
1.763     bisitz   1084: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1085: 							       undef, undef, 600).
                   1086: 								   '</span> ';
                   1087:     }
                   1088:     $out = '<span>' # Start cheatsheet
                   1089: 	  .$addOther
                   1090:           .'<span>'
                   1091: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1092: 					       undef,undef,600)
                   1093: 	  .'</span> <span>'
                   1094: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1095: 					       undef,undef,600)
                   1096: 	  .'</span>';
1.732     raeburn  1097:     unless ($not_author) {
1.763     bisitz   1098:         $out .= ' <span>'
                   1099: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1100: 	                                            undef,undef,600)
                   1101: 	       .'</span>';
1.732     raeburn  1102:     }
1.763     bisitz   1103:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1104:     return $out;
1.172     www      1105: }
                   1106: 
1.430     albertel 1107: sub general_help {
                   1108:     my $helptopic='Student_Intro';
                   1109:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1110: 	$helptopic='Authoring_Intro';
                   1111:     } elsif ($env{'request.role'}=~/^cc/) {
                   1112: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1113:     } elsif ($env{'request.role'}=~/^dc/) {
                   1114:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1115:     }
                   1116:     return $helptopic;
                   1117: }
                   1118: 
                   1119: sub update_help_link {
                   1120:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1121:     my $origurl = $ENV{'REQUEST_URI'};
                   1122:     $origurl=~s|^/~|/priv/|;
                   1123:     my $timestamp = time;
                   1124:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1125:         $$datum = &escape($$datum);
                   1126:     }
                   1127: 
                   1128:     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";
                   1129:     my $output .= <<"ENDOUTPUT";
                   1130: <script type="text/javascript">
1.824     bisitz   1131: // <![CDATA[
1.430     albertel 1132: banner_link = '$banner_link';
1.824     bisitz   1133: // ]]>
1.430     albertel 1134: </script>
                   1135: ENDOUTPUT
                   1136:     return $output;
                   1137: }
                   1138: 
                   1139: # now just updates the help link and generates a blue icon
1.193     raeburn  1140: sub help_open_menu {
1.430     albertel 1141:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1142: 	= @_;    
1.430     albertel 1143:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1144:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1145:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1146:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1147:         $stayOnPage=1;
1.430     albertel 1148:     }
                   1149:     my $output;
                   1150:     if ($component_help) {
                   1151: 	if (!$text) {
                   1152: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1153: 				       $width,$height);
                   1154: 	} else {
                   1155: 	    my $help_text;
                   1156: 	    $help_text=&unescape($topic);
                   1157: 	    $output='<table><tr><td>'.
                   1158: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1159: 				 $width,$height).'</td></tr></table>';
                   1160: 	}
                   1161:     }
                   1162:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1163:     return $output.$banner_link;
                   1164: }
                   1165: 
                   1166: sub top_nav_help {
                   1167:     my ($text) = @_;
1.436     albertel 1168:     $text = &mt($text);
1.572     banghart 1169:     my $stay_on_page = 
1.798     tempelho 1170: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1171:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1172: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1173:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1174: 
1.201     raeburn  1175:     my $title = &mt('Get help');
1.436     albertel 1176: 
                   1177:     return <<"END";
                   1178: $banner_link
                   1179:  <a href="$link" title="$title">$text</a>
                   1180: END
                   1181: }
                   1182: 
                   1183: sub help_menu_js {
                   1184:     my ($text) = @_;
                   1185: 
                   1186:     my $stayOnPage = 
1.798     tempelho 1187: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1188: 
                   1189:     my $width = 620;
                   1190:     my $height = 600;
1.430     albertel 1191:     my $helptopic=&general_help();
                   1192:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1193:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1194:     my $start_page =
                   1195:         &Apache::loncommon::start_page('Help Menu', undef,
                   1196: 				       {'frameset'    => 1,
                   1197: 					'js_ready'    => 1,
                   1198: 					'add_entries' => {
                   1199: 					    'border' => '0',
1.579     raeburn  1200: 					    'rows'   => "110,*",},});
1.331     albertel 1201:     my $end_page =
                   1202:         &Apache::loncommon::end_page({'frameset' => 1,
                   1203: 				      'js_ready' => 1,});
                   1204: 
1.436     albertel 1205:     my $template .= <<"ENDTEMPLATE";
                   1206: <script type="text/javascript">
1.877     bisitz   1207: // <![CDATA[
1.253     albertel 1208: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1209: var banner_link = '';
1.243     raeburn  1210: function helpMenu(target) {
                   1211:     var caller = this;
                   1212:     if (target == 'open') {
                   1213:         var newWindow = null;
                   1214:         try {
1.262     albertel 1215:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1216:         }
                   1217:         catch(error) {
                   1218:             writeHelp(caller);
                   1219:             return;
                   1220:         }
                   1221:         if (newWindow) {
                   1222:             caller = newWindow;
                   1223:         }
1.193     raeburn  1224:     }
1.243     raeburn  1225:     writeHelp(caller);
                   1226:     return;
                   1227: }
                   1228: function writeHelp(caller) {
1.430     albertel 1229:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1230:     caller.document.close()
                   1231:     caller.focus()
1.193     raeburn  1232: }
1.877     bisitz   1233: // END LON-CAPA Internal -->
1.253     albertel 1234: // ]]>
1.436     albertel 1235: </script>
1.193     raeburn  1236: ENDTEMPLATE
                   1237:     return $template;
                   1238: }
                   1239: 
1.172     www      1240: sub help_open_bug {
                   1241:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1242:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1243:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1244:     $text = "" if (not defined $text);
                   1245:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1246:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1247: 	$stayOnPage=1;
                   1248:     }
1.184     albertel 1249:     $width = 600 if (not defined $width);
                   1250:     $height = 600 if (not defined $height);
1.172     www      1251: 
                   1252:     $topic=~s/\W+/\+/g;
                   1253:     my $link='';
                   1254:     my $template='';
1.379     albertel 1255:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1256: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1257:     if (!$stayOnPage)
                   1258:     {
                   1259: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1260:     }
                   1261:     else
                   1262:     {
                   1263: 	$link = $url;
                   1264:     }
                   1265:     # Add the text
                   1266:     if ($text ne "")
                   1267:     {
                   1268: 	$template .= 
                   1269:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1270:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1271:     }
                   1272: 
                   1273:     # Add the graphic
1.179     matthew  1274:     my $title = &mt('Report a Bug');
1.215     albertel 1275:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1276:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1277:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1278: ENDTEMPLATE
                   1279:     if ($text ne '') { $template.='</td></tr></table>' };
                   1280:     return $template;
                   1281: 
                   1282: }
                   1283: 
                   1284: sub help_open_faq {
                   1285:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1286:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1287:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1288:     $text = "" if (not defined $text);
                   1289:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1290:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1291: 	$stayOnPage=1;
                   1292:     }
                   1293:     $width = 350 if (not defined $width);
                   1294:     $height = 400 if (not defined $height);
                   1295: 
                   1296:     $topic=~s/\W+/\+/g;
                   1297:     my $link='';
                   1298:     my $template='';
                   1299:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1300:     if (!$stayOnPage)
                   1301:     {
                   1302: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1303:     }
                   1304:     else
                   1305:     {
                   1306: 	$link = $url;
                   1307:     }
                   1308: 
                   1309:     # Add the text
                   1310:     if ($text ne "")
                   1311:     {
                   1312: 	$template .= 
1.173     www      1313:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1314:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1315:     }
                   1316: 
                   1317:     # Add the graphic
1.179     matthew  1318:     my $title = &mt('View the FAQ');
1.215     albertel 1319:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1320:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1321:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1322: ENDTEMPLATE
                   1323:     if ($text ne '') { $template.='</td></tr></table>' };
                   1324:     return $template;
                   1325: 
1.44      bowersj2 1326: }
1.37      matthew  1327: 
1.180     matthew  1328: ###############################################################
                   1329: ###############################################################
                   1330: 
1.45      matthew  1331: =pod
                   1332: 
1.648     raeburn  1333: =item * &change_content_javascript():
1.256     matthew  1334: 
                   1335: This and the next function allow you to create small sections of an
                   1336: otherwise static HTML page that you can update on the fly with
                   1337: Javascript, even in Netscape 4.
                   1338: 
                   1339: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1340: must be written to the HTML page once. It will prove the Javascript
                   1341: function "change(name, content)". Calling the change function with the
                   1342: name of the section 
                   1343: you want to update, matching the name passed to C<changable_area>, and
                   1344: the new content you want to put in there, will put the content into
                   1345: that area.
                   1346: 
                   1347: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1348: to contain room for the original contents. You need to "make space"
                   1349: for whatever changes you wish to make, and be B<sure> to check your
                   1350: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1351: it's adequate for updating a one-line status display, but little more.
                   1352: This script will set the space to 100% width, so you only need to
                   1353: worry about height in Netscape 4.
                   1354: 
                   1355: Modern browsers are much less limiting, and if you can commit to the
                   1356: user not using Netscape 4, this feature may be used freely with
                   1357: pretty much any HTML.
                   1358: 
                   1359: =cut
                   1360: 
                   1361: sub change_content_javascript {
                   1362:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1363:     if ($env{'browser.type'} eq 'netscape' &&
                   1364: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1365: 	return (<<NETSCAPE4);
                   1366: 	function change(name, content) {
                   1367: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1368: 	    doc.open();
                   1369: 	    doc.write(content);
                   1370: 	    doc.close();
                   1371: 	}
                   1372: NETSCAPE4
                   1373:     } else {
                   1374: 	# Otherwise, we need to use semi-standards-compliant code
                   1375: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1376: 	# is really scary, and every useful browser supports it
                   1377: 	return (<<DOMBASED);
                   1378: 	function change(name, content) {
                   1379: 	    element = document.getElementById(name);
                   1380: 	    element.innerHTML = content;
                   1381: 	}
                   1382: DOMBASED
                   1383:     }
                   1384: }
                   1385: 
                   1386: =pod
                   1387: 
1.648     raeburn  1388: =item * &changable_area($name,$origContent):
1.256     matthew  1389: 
                   1390: This provides a "changable area" that can be modified on the fly via
                   1391: the Javascript code provided in C<change_content_javascript>. $name is
                   1392: the name you will use to reference the area later; do not repeat the
                   1393: same name on a given HTML page more then once. $origContent is what
                   1394: the area will originally contain, which can be left blank.
                   1395: 
                   1396: =cut
                   1397: 
                   1398: sub changable_area {
                   1399:     my ($name, $origContent) = @_;
                   1400: 
1.258     albertel 1401:     if ($env{'browser.type'} eq 'netscape' &&
                   1402: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1403: 	# If this is netscape 4, we need to use the Layer tag
                   1404: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1405:     } else {
                   1406: 	return "<span id='$name'>$origContent</span>";
                   1407:     }
                   1408: }
                   1409: 
                   1410: =pod
                   1411: 
1.648     raeburn  1412: =item * &viewport_geometry_js 
1.590     raeburn  1413: 
                   1414: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1415: 
                   1416: =cut
                   1417: 
                   1418: 
                   1419: sub viewport_geometry_js { 
                   1420:     return <<"GEOMETRY";
                   1421: var Geometry = {};
                   1422: function init_geometry() {
                   1423:     if (Geometry.init) { return };
                   1424:     Geometry.init=1;
                   1425:     if (window.innerHeight) {
                   1426:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1427:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1428:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1429:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1430:     }
                   1431:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1432:         Geometry.getViewportHeight =
                   1433:             function() { return document.documentElement.clientHeight; };
                   1434:         Geometry.getViewportWidth =
                   1435:             function() { return document.documentElement.clientWidth; };
                   1436: 
                   1437:         Geometry.getHorizontalScroll =
                   1438:             function() { return document.documentElement.scrollLeft; };
                   1439:         Geometry.getVerticalScroll =
                   1440:             function() { return document.documentElement.scrollTop; };
                   1441:     }
                   1442:     else if (document.body.clientHeight) {
                   1443:         Geometry.getViewportHeight =
                   1444:             function() { return document.body.clientHeight; };
                   1445:         Geometry.getViewportWidth =
                   1446:             function() { return document.body.clientWidth; };
                   1447:         Geometry.getHorizontalScroll =
                   1448:             function() { return document.body.scrollLeft; };
                   1449:         Geometry.getVerticalScroll =
                   1450:             function() { return document.body.scrollTop; };
                   1451:     }
                   1452: }
                   1453: 
                   1454: GEOMETRY
                   1455: }
                   1456: 
                   1457: =pod
                   1458: 
1.648     raeburn  1459: =item * &viewport_size_js()
1.590     raeburn  1460: 
                   1461: 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. 
                   1462: 
                   1463: =cut
                   1464: 
                   1465: sub viewport_size_js {
                   1466:     my $geometry = &viewport_geometry_js();
                   1467:     return <<"DIMS";
                   1468: 
                   1469: $geometry
                   1470: 
                   1471: function getViewportDims(width,height) {
                   1472:     init_geometry();
                   1473:     width.value = Geometry.getViewportWidth();
                   1474:     height.value = Geometry.getViewportHeight();
                   1475:     return;
                   1476: }
                   1477: 
                   1478: DIMS
                   1479: }
                   1480: 
                   1481: =pod
                   1482: 
1.648     raeburn  1483: =item * &resize_textarea_js()
1.565     albertel 1484: 
                   1485: emits the needed javascript to resize a textarea to be as big as possible
                   1486: 
                   1487: creates a function resize_textrea that takes two IDs first should be
                   1488: the id of the element to resize, second should be the id of a div that
                   1489: surrounds everything that comes after the textarea, this routine needs
                   1490: to be attached to the <body> for the onload and onresize events.
                   1491: 
1.648     raeburn  1492: =back
1.565     albertel 1493: 
                   1494: =cut
                   1495: 
                   1496: sub resize_textarea_js {
1.590     raeburn  1497:     my $geometry = &viewport_geometry_js();
1.565     albertel 1498:     return <<"RESIZE";
                   1499:     <script type="text/javascript">
1.824     bisitz   1500: // <![CDATA[
1.590     raeburn  1501: $geometry
1.565     albertel 1502: 
1.588     albertel 1503: function getX(element) {
                   1504:     var x = 0;
                   1505:     while (element) {
                   1506: 	x += element.offsetLeft;
                   1507: 	element = element.offsetParent;
                   1508:     }
                   1509:     return x;
                   1510: }
                   1511: function getY(element) {
                   1512:     var y = 0;
                   1513:     while (element) {
                   1514: 	y += element.offsetTop;
                   1515: 	element = element.offsetParent;
                   1516:     }
                   1517:     return y;
                   1518: }
                   1519: 
                   1520: 
1.565     albertel 1521: function resize_textarea(textarea_id,bottom_id) {
                   1522:     init_geometry();
                   1523:     var textarea        = document.getElementById(textarea_id);
                   1524:     //alert(textarea);
                   1525: 
1.588     albertel 1526:     var textarea_top    = getY(textarea);
1.565     albertel 1527:     var textarea_height = textarea.offsetHeight;
                   1528:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1529:     var bottom_top      = getY(bottom);
1.565     albertel 1530:     var bottom_height   = bottom.offsetHeight;
                   1531:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1532:     var fudge           = 23;
1.565     albertel 1533:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1534:     if (new_height < 300) {
                   1535: 	new_height = 300;
                   1536:     }
                   1537:     textarea.style.height=new_height+'px';
                   1538: }
1.824     bisitz   1539: // ]]>
1.565     albertel 1540: </script>
                   1541: RESIZE
                   1542: 
                   1543: }
                   1544: 
                   1545: =pod
                   1546: 
1.256     matthew  1547: =head1 Excel and CSV file utility routines
                   1548: 
                   1549: =over 4
                   1550: 
                   1551: =cut
                   1552: 
                   1553: ###############################################################
                   1554: ###############################################################
                   1555: 
                   1556: =pod
                   1557: 
1.648     raeburn  1558: =item * &csv_translate($text) 
1.37      matthew  1559: 
1.185     www      1560: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1561: format.
                   1562: 
                   1563: =cut
                   1564: 
1.180     matthew  1565: ###############################################################
                   1566: ###############################################################
1.37      matthew  1567: sub csv_translate {
                   1568:     my $text = shift;
                   1569:     $text =~ s/\"/\"\"/g;
1.209     albertel 1570:     $text =~ s/\n/ /g;
1.37      matthew  1571:     return $text;
                   1572: }
1.180     matthew  1573: 
                   1574: ###############################################################
                   1575: ###############################################################
                   1576: 
                   1577: =pod
                   1578: 
1.648     raeburn  1579: =item * &define_excel_formats()
1.180     matthew  1580: 
                   1581: Define some commonly used Excel cell formats.
                   1582: 
                   1583: Currently supported formats:
                   1584: 
                   1585: =over 4
                   1586: 
                   1587: =item header
                   1588: 
                   1589: =item bold
                   1590: 
                   1591: =item h1
                   1592: 
                   1593: =item h2
                   1594: 
                   1595: =item h3
                   1596: 
1.256     matthew  1597: =item h4
                   1598: 
                   1599: =item i
                   1600: 
1.180     matthew  1601: =item date
                   1602: 
                   1603: =back
                   1604: 
                   1605: Inputs: $workbook
                   1606: 
                   1607: Returns: $format, a hash reference.
                   1608: 
                   1609: =cut
                   1610: 
                   1611: ###############################################################
                   1612: ###############################################################
                   1613: sub define_excel_formats {
                   1614:     my ($workbook) = @_;
                   1615:     my $format;
                   1616:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1617:                                                 bottom    => 1,
                   1618:                                                 align     => 'center');
                   1619:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1620:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1621:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1622:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1623:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1624:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1625:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1626:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1627:     return $format;
                   1628: }
                   1629: 
                   1630: ###############################################################
                   1631: ###############################################################
1.113     bowersj2 1632: 
                   1633: =pod
                   1634: 
1.648     raeburn  1635: =item * &create_workbook()
1.255     matthew  1636: 
                   1637: Create an Excel worksheet.  If it fails, output message on the
                   1638: request object and return undefs.
                   1639: 
                   1640: Inputs: Apache request object
                   1641: 
                   1642: Returns (undef) on failure, 
                   1643:     Excel worksheet object, scalar with filename, and formats 
                   1644:     from &Apache::loncommon::define_excel_formats on success
                   1645: 
                   1646: =cut
                   1647: 
                   1648: ###############################################################
                   1649: ###############################################################
                   1650: sub create_workbook {
                   1651:     my ($r) = @_;
                   1652:         #
                   1653:     # Create the excel spreadsheet
                   1654:     my $filename = '/prtspool/'.
1.258     albertel 1655:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1656:         time.'_'.rand(1000000000).'.xls';
                   1657:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1658:     if (! defined($workbook)) {
                   1659:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1660:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1661:                             "This error has been logged.  ".
                   1662:                             "Please alert your LON-CAPA administrator").
                   1663:                   '</p>');
                   1664:         return (undef);
                   1665:     }
                   1666:     #
                   1667:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1668:     #
                   1669:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1670:     return ($workbook,$filename,$format);
                   1671: }
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: 
                   1676: =pod
                   1677: 
1.648     raeburn  1678: =item * &create_text_file()
1.113     bowersj2 1679: 
1.542     raeburn  1680: Create a file to write to and eventually make available to the user.
1.256     matthew  1681: If file creation fails, outputs an error message on the request object and 
                   1682: return undefs.
1.113     bowersj2 1683: 
1.256     matthew  1684: Inputs: Apache request object, and file suffix
1.113     bowersj2 1685: 
1.256     matthew  1686: Returns (undef) on failure, 
                   1687:     Filehandle and filename on success.
1.113     bowersj2 1688: 
                   1689: =cut
                   1690: 
1.256     matthew  1691: ###############################################################
                   1692: ###############################################################
                   1693: sub create_text_file {
                   1694:     my ($r,$suffix) = @_;
                   1695:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1696:     my $fh;
                   1697:     my $filename = '/prtspool/'.
1.258     albertel 1698:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1699:         time.'_'.rand(1000000000).'.'.$suffix;
                   1700:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1701:     if (! defined($fh)) {
                   1702:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1703:         $r->print(&mt('Problems occurred in creating the output file. '
                   1704:                      .'This error has been logged. '
                   1705:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1706:     }
1.256     matthew  1707:     return ($fh,$filename)
1.113     bowersj2 1708: }
                   1709: 
                   1710: 
1.256     matthew  1711: =pod 
1.113     bowersj2 1712: 
                   1713: =back
                   1714: 
                   1715: =cut
1.37      matthew  1716: 
                   1717: ###############################################################
1.33      matthew  1718: ##        Home server <option> list generating code          ##
                   1719: ###############################################################
1.35      matthew  1720: 
1.169     www      1721: # ------------------------------------------
                   1722: 
                   1723: sub domain_select {
                   1724:     my ($name,$value,$multiple)=@_;
                   1725:     my %domains=map { 
1.514     albertel 1726: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1727:     } &Apache::lonnet::all_domains();
1.169     www      1728:     if ($multiple) {
                   1729: 	$domains{''}=&mt('Any domain');
1.550     albertel 1730: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1731: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1732:     } else {
1.550     albertel 1733: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1734: 	return &select_form($name,$value,%domains);
                   1735:     }
                   1736: }
                   1737: 
1.282     albertel 1738: #-------------------------------------------
                   1739: 
                   1740: =pod
                   1741: 
1.519     raeburn  1742: =head1 Routines for form select boxes
                   1743: 
                   1744: =over 4
                   1745: 
1.648     raeburn  1746: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1747: 
                   1748: Returns a string containing a <select> element int multiple mode
                   1749: 
                   1750: 
                   1751: Args:
                   1752:   $name - name of the <select> element
1.506     raeburn  1753:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1754:   $size - number of rows long the select element is
1.283     albertel 1755:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1756:           (shown text should already have been &mt())
1.506     raeburn  1757:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1758: 
1.282     albertel 1759: =cut
                   1760: 
                   1761: #-------------------------------------------
1.169     www      1762: sub multiple_select_form {
1.284     albertel 1763:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1764:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1765:     my $output='';
1.191     matthew  1766:     if (! defined($size)) {
                   1767:         $size = 4;
1.283     albertel 1768:         if (scalar(keys(%$hash))<4) {
                   1769:             $size = scalar(keys(%$hash));
1.191     matthew  1770:         }
                   1771:     }
1.734     bisitz   1772:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1773:     my @order;
1.506     raeburn  1774:     if (ref($order) eq 'ARRAY')  {
                   1775:         @order = @{$order};
                   1776:     } else {
                   1777:         @order = sort(keys(%$hash));
1.501     banghart 1778:     }
                   1779:     if (exists($$hash{'select_form_order'})) {
                   1780:         @order = @{$$hash{'select_form_order'}};
                   1781:     }
                   1782:         
1.284     albertel 1783:     foreach my $key (@order) {
1.356     albertel 1784:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1785:         $output.='selected="selected" ' if ($selected{$key});
                   1786:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1787:     }
                   1788:     $output.="</select>\n";
                   1789:     return $output;
                   1790: }
                   1791: 
1.88      www      1792: #-------------------------------------------
                   1793: 
                   1794: =pod
                   1795: 
1.648     raeburn  1796: =item * &select_form($defdom,$name,%hash)
1.88      www      1797: 
                   1798: Returns a string containing a <select name='$name' size='1'> form to 
                   1799: allow a user to select options from a hash option_name => displayed text.  
                   1800: See lonrights.pm for an example invocation and use.
                   1801: 
                   1802: =cut
                   1803: 
                   1804: #-------------------------------------------
                   1805: sub select_form {
                   1806:     my ($def,$name,%hash) = @_;
                   1807:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1808:     my @keys;
                   1809:     if (exists($hash{'select_form_order'})) {
                   1810: 	@keys=@{$hash{'select_form_order'}};
                   1811:     } else {
                   1812: 	@keys=sort(keys(%hash));
                   1813:     }
1.356     albertel 1814:     foreach my $key (@keys) {
                   1815:         $selectform.=
                   1816: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1817:             ($key eq $def ? 'selected="selected" ' : '').
                   1818:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1819:     }
                   1820:     $selectform.="</select>";
                   1821:     return $selectform;
                   1822: }
                   1823: 
1.475     www      1824: # For display filters
                   1825: 
                   1826: sub display_filter {
                   1827:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1828:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1829:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1830: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1831: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1832: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1833:            &mt('Filter [_1]',
1.477     www      1834: 	   &select_form($env{'form.displayfilter'},
                   1835: 			'displayfilter',
                   1836: 			('currentfolder' => 'Current folder/page',
                   1837: 			 'containing' => 'Containing phrase',
                   1838: 			 'none' => 'None'))).
1.714     bisitz   1839: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1840: }
                   1841: 
1.167     www      1842: sub gradeleveldescription {
                   1843:     my $gradelevel=shift;
                   1844:     my %gradelevels=(0 => 'Not specified',
                   1845: 		     1 => 'Grade 1',
                   1846: 		     2 => 'Grade 2',
                   1847: 		     3 => 'Grade 3',
                   1848: 		     4 => 'Grade 4',
                   1849: 		     5 => 'Grade 5',
                   1850: 		     6 => 'Grade 6',
                   1851: 		     7 => 'Grade 7',
                   1852: 		     8 => 'Grade 8',
                   1853: 		     9 => 'Grade 9',
                   1854: 		     10 => 'Grade 10',
                   1855: 		     11 => 'Grade 11',
                   1856: 		     12 => 'Grade 12',
                   1857: 		     13 => 'Grade 13',
                   1858: 		     14 => '100 Level',
                   1859: 		     15 => '200 Level',
                   1860: 		     16 => '300 Level',
                   1861: 		     17 => '400 Level',
                   1862: 		     18 => 'Graduate Level');
                   1863:     return &mt($gradelevels{$gradelevel});
                   1864: }
                   1865: 
1.163     www      1866: sub select_level_form {
                   1867:     my ($deflevel,$name)=@_;
                   1868:     unless ($deflevel) { $deflevel=0; }
1.167     www      1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1870:     for (my $i=0; $i<=18; $i++) {
                   1871:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1872:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1873:                 ">".&gradeleveldescription($i)."</option>\n";
                   1874:     }
                   1875:     $selectform.="</select>";
                   1876:     return $selectform;
1.163     www      1877: }
1.167     www      1878: 
1.35      matthew  1879: #-------------------------------------------
                   1880: 
1.45      matthew  1881: =pod
                   1882: 
1.873     raeburn  1883: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange)
1.35      matthew  1884: 
                   1885: Returns a string containing a <select name='$name' size='1'> form to 
                   1886: allow a user to select the domain to preform an operation in.  
                   1887: See loncreateuser.pm for an example invocation and use.
                   1888: 
1.90      www      1889: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1890: selected");
                   1891: 
1.743     raeburn  1892: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1893: 
1.872     raeburn  1894: The optional $onchange argumnet specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.  
1.563     raeburn  1895: 
1.35      matthew  1896: =cut
                   1897: 
                   1898: #-------------------------------------------
1.34      matthew  1899: sub select_dom_form {
1.872     raeburn  1900:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange) = @_;
                   1901:     if ($onchange) {
1.874     raeburn  1902:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1903:     }
1.550     albertel 1904:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1905:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1906:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1907:     foreach my $dom (@domains) {
                   1908:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1909:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1910:         if ($showdomdesc) {
                   1911:             if ($dom ne '') {
                   1912:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1913:                 if ($domdesc ne '') {
                   1914:                     $selectdomain .= ' ('.$domdesc.')';
                   1915:                 }
                   1916:             } 
                   1917:         }
                   1918:         $selectdomain .= "</option>\n";
1.34      matthew  1919:     }
                   1920:     $selectdomain.="</select>";
                   1921:     return $selectdomain;
                   1922: }
                   1923: 
1.35      matthew  1924: #-------------------------------------------
                   1925: 
1.45      matthew  1926: =pod
                   1927: 
1.648     raeburn  1928: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1929: 
1.586     raeburn  1930: input: 4 arguments (two required, two optional) - 
                   1931:     $domain - domain of new user
                   1932:     $name - name of form element
                   1933:     $default - Value of 'default' causes a default item to be first 
                   1934:                             option, and selected by default. 
                   1935:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1936:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1937: output: returns 2 items: 
1.586     raeburn  1938: (a) form element which contains either:
                   1939:    (i) <select name="$name">
                   1940:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1941:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1942:        </select>
                   1943:        form item if there are multiple library servers in $domain, or
                   1944:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1945:        if there is only one library server in $domain.
                   1946: 
                   1947: (b) number of library servers found.
                   1948: 
                   1949: See loncreateuser.pm for example of use.
1.35      matthew  1950: 
                   1951: =cut
                   1952: 
                   1953: #-------------------------------------------
1.586     raeburn  1954: sub home_server_form_item {
                   1955:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1956:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1957:     my $result;
                   1958:     my $numlib = keys(%servers);
                   1959:     if ($numlib > 1) {
                   1960:         $result .= '<select name="'.$name.'" />'."\n";
                   1961:         if ($default) {
1.804     bisitz   1962:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1963:                        '</option>'."\n";
                   1964:         }
                   1965:         foreach my $hostid (sort(keys(%servers))) {
                   1966:             $result.= '<option value="'.$hostid.'">'.
                   1967: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1968:         }
                   1969:         $result .= '</select>'."\n";
                   1970:     } elsif ($numlib == 1) {
                   1971:         my $hostid;
                   1972:         foreach my $item (keys(%servers)) {
                   1973:             $hostid = $item;
                   1974:         }
                   1975:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1976:                    $hostid.'" />';
                   1977:                    if (!$hide) {
                   1978:                        $result .= $hostid.' '.$servers{$hostid};
                   1979:                    }
                   1980:                    $result .= "\n";
                   1981:     } elsif ($default) {
                   1982:         $result .= '<input type="hidden" name="'.$name.
                   1983:                    '" value="default" />';
                   1984:                    if (!$hide) {
                   1985:                        $result .= &mt('default');
                   1986:                    }
                   1987:                    $result .= "\n";
1.33      matthew  1988:     }
1.586     raeburn  1989:     return ($result,$numlib);
1.33      matthew  1990: }
1.112     bowersj2 1991: 
                   1992: =pod
                   1993: 
1.534     albertel 1994: =back 
                   1995: 
1.112     bowersj2 1996: =cut
1.87      matthew  1997: 
                   1998: ###############################################################
1.112     bowersj2 1999: ##                  Decoding User Agent                      ##
1.87      matthew  2000: ###############################################################
                   2001: 
                   2002: =pod
                   2003: 
1.112     bowersj2 2004: =head1 Decoding the User Agent
                   2005: 
                   2006: =over 4
                   2007: 
                   2008: =item * &decode_user_agent()
1.87      matthew  2009: 
                   2010: Inputs: $r
                   2011: 
                   2012: Outputs:
                   2013: 
                   2014: =over 4
                   2015: 
1.112     bowersj2 2016: =item * $httpbrowser
1.87      matthew  2017: 
1.112     bowersj2 2018: =item * $clientbrowser
1.87      matthew  2019: 
1.112     bowersj2 2020: =item * $clientversion
1.87      matthew  2021: 
1.112     bowersj2 2022: =item * $clientmathml
1.87      matthew  2023: 
1.112     bowersj2 2024: =item * $clientunicode
1.87      matthew  2025: 
1.112     bowersj2 2026: =item * $clientos
1.87      matthew  2027: 
                   2028: =back
                   2029: 
1.157     matthew  2030: =back 
                   2031: 
1.87      matthew  2032: =cut
                   2033: 
                   2034: ###############################################################
                   2035: ###############################################################
                   2036: sub decode_user_agent {
1.247     albertel 2037:     my ($r)=@_;
1.87      matthew  2038:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2039:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2040:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2041:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2042:     my $clientbrowser='unknown';
                   2043:     my $clientversion='0';
                   2044:     my $clientmathml='';
                   2045:     my $clientunicode='0';
                   2046:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2047:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2048: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2049: 	    $clientbrowser=$bname;
                   2050:             $httpbrowser=~/$vreg/i;
                   2051: 	    $clientversion=$1;
                   2052:             $clientmathml=($clientversion>=$minv);
                   2053:             $clientunicode=($clientversion>=$univ);
                   2054: 	}
                   2055:     }
                   2056:     my $clientos='unknown';
                   2057:     if (($httpbrowser=~/linux/i) ||
                   2058:         ($httpbrowser=~/unix/i) ||
                   2059:         ($httpbrowser=~/ux/i) ||
                   2060:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2061:     if (($httpbrowser=~/vax/i) ||
                   2062:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2063:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2064:     if (($httpbrowser=~/mac/i) ||
                   2065:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2066:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2067:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2068:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2069:             $clientunicode,$clientos,);
                   2070: }
                   2071: 
1.32      matthew  2072: ###############################################################
                   2073: ##    Authentication changing form generation subroutines    ##
                   2074: ###############################################################
                   2075: ##
                   2076: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2077: ## hash, and have reasonable default values.
                   2078: ##
                   2079: ##    formname = the name given in the <form> tag.
1.35      matthew  2080: #-------------------------------------------
                   2081: 
1.45      matthew  2082: =pod
                   2083: 
1.112     bowersj2 2084: =head1 Authentication Routines
                   2085: 
                   2086: =over 4
                   2087: 
1.648     raeburn  2088: =item * &authform_xxxxxx()
1.35      matthew  2089: 
                   2090: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2091: handle some of the conveniences required for authentication forms.  
                   2092: This is not an optimal method, but it works.  
                   2093: 
                   2094: =over 4
                   2095: 
1.112     bowersj2 2096: =item * authform_header
1.35      matthew  2097: 
1.112     bowersj2 2098: =item * authform_authorwarning
1.35      matthew  2099: 
1.112     bowersj2 2100: =item * authform_nochange
1.35      matthew  2101: 
1.112     bowersj2 2102: =item * authform_kerberos
1.35      matthew  2103: 
1.112     bowersj2 2104: =item * authform_internal
1.35      matthew  2105: 
1.112     bowersj2 2106: =item * authform_filesystem
1.35      matthew  2107: 
                   2108: =back
                   2109: 
1.648     raeburn  2110: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2111: 
1.35      matthew  2112: =cut
                   2113: 
                   2114: #-------------------------------------------
1.32      matthew  2115: sub authform_header{  
                   2116:     my %in = (
                   2117:         formname => 'cu',
1.80      albertel 2118:         kerb_def_dom => '',
1.32      matthew  2119:         @_,
                   2120:     );
                   2121:     $in{'formname'} = 'document.' . $in{'formname'};
                   2122:     my $result='';
1.80      albertel 2123: 
                   2124: #---------------------------------------------- Code for upper case translation
                   2125:     my $Javascript_toUpperCase;
                   2126:     unless ($in{kerb_def_dom}) {
                   2127:         $Javascript_toUpperCase =<<"END";
                   2128:         switch (choice) {
                   2129:            case 'krb': currentform.elements[choicearg].value =
                   2130:                currentform.elements[choicearg].value.toUpperCase();
                   2131:                break;
                   2132:            default:
                   2133:         }
                   2134: END
                   2135:     } else {
                   2136:         $Javascript_toUpperCase = "";
                   2137:     }
                   2138: 
1.165     raeburn  2139:     my $radioval = "'nochange'";
1.591     raeburn  2140:     if (defined($in{'curr_authtype'})) {
                   2141:         if ($in{'curr_authtype'} ne '') {
                   2142:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2143:         }
1.174     matthew  2144:     }
1.165     raeburn  2145:     my $argfield = 'null';
1.591     raeburn  2146:     if (defined($in{'mode'})) {
1.165     raeburn  2147:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2148:             if (defined($in{'curr_autharg'})) {
                   2149:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2150:                     $argfield = "'$in{'curr_autharg'}'";
                   2151:                 }
                   2152:             }
                   2153:         }
                   2154:     }
                   2155: 
1.32      matthew  2156:     $result.=<<"END";
                   2157: var current = new Object();
1.165     raeburn  2158: current.radiovalue = $radioval;
                   2159: current.argfield = $argfield;
1.32      matthew  2160: 
                   2161: function changed_radio(choice,currentform) {
                   2162:     var choicearg = choice + 'arg';
                   2163:     // If a radio button in changed, we need to change the argfield
                   2164:     if (current.radiovalue != choice) {
                   2165:         current.radiovalue = choice;
                   2166:         if (current.argfield != null) {
                   2167:             currentform.elements[current.argfield].value = '';
                   2168:         }
                   2169:         if (choice == 'nochange') {
                   2170:             current.argfield = null;
                   2171:         } else {
                   2172:             current.argfield = choicearg;
                   2173:             switch(choice) {
                   2174:                 case 'krb': 
                   2175:                     currentform.elements[current.argfield].value = 
                   2176:                         "$in{'kerb_def_dom'}";
                   2177:                 break;
                   2178:               default:
                   2179:                 break;
                   2180:             }
                   2181:         }
                   2182:     }
                   2183:     return;
                   2184: }
1.22      www      2185: 
1.32      matthew  2186: function changed_text(choice,currentform) {
                   2187:     var choicearg = choice + 'arg';
                   2188:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2189:         $Javascript_toUpperCase
1.32      matthew  2190:         // clear old field
                   2191:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2192:             currentform.elements[current.argfield].value = '';
                   2193:         }
                   2194:         current.argfield = choicearg;
                   2195:     }
                   2196:     set_auth_radio_buttons(choice,currentform);
                   2197:     return;
1.20      www      2198: }
1.32      matthew  2199: 
                   2200: function set_auth_radio_buttons(newvalue,currentform) {
                   2201:     var i=0;
                   2202:     while (i < currentform.login.length) {
                   2203:         if (currentform.login[i].value == newvalue) { break; }
                   2204:         i++;
                   2205:     }
                   2206:     if (i == currentform.login.length) {
                   2207:         return;
                   2208:     }
                   2209:     current.radiovalue = newvalue;
                   2210:     currentform.login[i].checked = true;
                   2211:     return;
                   2212: }
                   2213: END
                   2214:     return $result;
                   2215: }
                   2216: 
                   2217: sub authform_authorwarning{
                   2218:     my $result='';
1.144     matthew  2219:     $result='<i>'.
                   2220:         &mt('As a general rule, only authors or co-authors should be '.
                   2221:             'filesystem authenticated '.
                   2222:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2223:     return $result;
                   2224: }
                   2225: 
                   2226: sub authform_nochange{  
                   2227:     my %in = (
                   2228:               formname => 'document.cu',
                   2229:               kerb_def_dom => 'MSU.EDU',
                   2230:               @_,
                   2231:           );
1.586     raeburn  2232:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2233:     my $result;
                   2234:     if (keys(%can_assign) == 0) {
                   2235:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2236:     } else {
                   2237:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2238:                   '<input type="radio" name="login" value="nochange" '.
                   2239:                   'checked="checked" onclick="'.
1.281     albertel 2240:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2241: 	    '</label>';
1.586     raeburn  2242:     }
1.32      matthew  2243:     return $result;
                   2244: }
                   2245: 
1.591     raeburn  2246: sub authform_kerberos {
1.32      matthew  2247:     my %in = (
                   2248:               formname => 'document.cu',
                   2249:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2250:               kerb_def_auth => 'krb4',
1.32      matthew  2251:               @_,
                   2252:               );
1.586     raeburn  2253:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2254:         $autharg,$jscall);
                   2255:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2256:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2257:        $check5 = ' checked="checked"';
1.80      albertel 2258:     } else {
1.772     bisitz   2259:        $check4 = ' checked="checked"';
1.80      albertel 2260:     }
1.165     raeburn  2261:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2262:     if (defined($in{'curr_authtype'})) {
                   2263:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2264:             $krbcheck = ' checked="checked"';
1.623     raeburn  2265:             if (defined($in{'mode'})) {
                   2266:                 if ($in{'mode'} eq 'modifyuser') {
                   2267:                     $krbcheck = '';
                   2268:                 }
                   2269:             }
1.591     raeburn  2270:             if (defined($in{'curr_kerb_ver'})) {
                   2271:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2272:                     $check5 = ' checked="checked"';
1.591     raeburn  2273:                     $check4 = '';
                   2274:                 } else {
1.772     bisitz   2275:                     $check4 = ' checked="checked"';
1.591     raeburn  2276:                     $check5 = '';
                   2277:                 }
1.586     raeburn  2278:             }
1.591     raeburn  2279:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2280:                 $krbarg = $in{'curr_autharg'};
                   2281:             }
1.586     raeburn  2282:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2283:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2284:                     $result = 
                   2285:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2286:         $in{'curr_autharg'},$krbver);
                   2287:                 } else {
                   2288:                     $result =
                   2289:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2290:                 }
                   2291:                 return $result; 
                   2292:             }
                   2293:         }
                   2294:     } else {
                   2295:         if ($authnum == 1) {
1.784     bisitz   2296:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2297:         }
                   2298:     }
1.586     raeburn  2299:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2300:         return;
1.587     raeburn  2301:     } elsif ($authtype eq '') {
1.591     raeburn  2302:         if (defined($in{'mode'})) {
1.587     raeburn  2303:             if ($in{'mode'} eq 'modifycourse') {
                   2304:                 if ($authnum == 1) {
1.784     bisitz   2305:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2306:                 }
                   2307:             }
                   2308:         }
1.586     raeburn  2309:     }
                   2310:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2311:     if ($authtype eq '') {
                   2312:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2313:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2314:                     $krbcheck.' />';
                   2315:     }
                   2316:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2317:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2318:          $in{'curr_authtype'} eq 'krb5') ||
                   2319:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2320:          $in{'curr_authtype'} eq 'krb4')) {
                   2321:         $result .= &mt
1.144     matthew  2322:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2323:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2324:          '<label>'.$authtype,
1.281     albertel 2325:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2326:              'value="'.$krbarg.'" '.
1.144     matthew  2327:              'onchange="'.$jscall.'" />',
1.281     albertel 2328:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2329:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2330: 	 '</label>');
1.586     raeburn  2331:     } elsif ($can_assign{'krb4'}) {
                   2332:         $result .= &mt
                   2333:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2334:          '[_3] Version 4 [_4]',
                   2335:          '<label>'.$authtype,
                   2336:          '</label><input type="text" size="10" name="krbarg" '.
                   2337:              'value="'.$krbarg.'" '.
                   2338:              'onchange="'.$jscall.'" />',
                   2339:          '<label><input type="hidden" name="krbver" value="4" />',
                   2340:          '</label>');
                   2341:     } elsif ($can_assign{'krb5'}) {
                   2342:         $result .= &mt
                   2343:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2344:          '[_3] Version 5 [_4]',
                   2345:          '<label>'.$authtype,
                   2346:          '</label><input type="text" size="10" name="krbarg" '.
                   2347:              'value="'.$krbarg.'" '.
                   2348:              'onchange="'.$jscall.'" />',
                   2349:          '<label><input type="hidden" name="krbver" value="5" />',
                   2350:          '</label>');
                   2351:     }
1.32      matthew  2352:     return $result;
                   2353: }
                   2354: 
                   2355: sub authform_internal{  
1.586     raeburn  2356:     my %in = (
1.32      matthew  2357:                 formname => 'document.cu',
                   2358:                 kerb_def_dom => 'MSU.EDU',
                   2359:                 @_,
                   2360:                 );
1.586     raeburn  2361:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2362:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2363:     if (defined($in{'curr_authtype'})) {
                   2364:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2365:             if ($can_assign{'int'}) {
1.772     bisitz   2366:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2367:                 if (defined($in{'mode'})) {
                   2368:                     if ($in{'mode'} eq 'modifyuser') {
                   2369:                         $intcheck = '';
                   2370:                     }
                   2371:                 }
1.591     raeburn  2372:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2373:                     $intarg = $in{'curr_autharg'};
                   2374:                 }
                   2375:             } else {
                   2376:                 $result = &mt('Currently internally authenticated.');
                   2377:                 return $result;
1.165     raeburn  2378:             }
                   2379:         }
1.586     raeburn  2380:     } else {
                   2381:         if ($authnum == 1) {
1.784     bisitz   2382:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2383:         }
                   2384:     }
                   2385:     if (!$can_assign{'int'}) {
                   2386:         return;
1.587     raeburn  2387:     } elsif ($authtype eq '') {
1.591     raeburn  2388:         if (defined($in{'mode'})) {
1.587     raeburn  2389:             if ($in{'mode'} eq 'modifycourse') {
                   2390:                 if ($authnum == 1) {
1.784     bisitz   2391:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2392:                 }
                   2393:             }
                   2394:         }
1.165     raeburn  2395:     }
1.586     raeburn  2396:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2397:     if ($authtype eq '') {
                   2398:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2399:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2400:     }
1.605     bisitz   2401:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2402:                $intarg.'" onchange="'.$jscall.'" />';
                   2403:     $result = &mt
1.144     matthew  2404:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2405:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2406:     $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  2407:     return $result;
                   2408: }
                   2409: 
                   2410: sub authform_local{  
                   2411:     my %in = (
                   2412:               formname => 'document.cu',
                   2413:               kerb_def_dom => 'MSU.EDU',
                   2414:               @_,
                   2415:               );
1.586     raeburn  2416:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2417:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2418:     if (defined($in{'curr_authtype'})) {
                   2419:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2420:             if ($can_assign{'loc'}) {
1.772     bisitz   2421:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2422:                 if (defined($in{'mode'})) {
                   2423:                     if ($in{'mode'} eq 'modifyuser') {
                   2424:                         $loccheck = '';
                   2425:                     }
                   2426:                 }
1.591     raeburn  2427:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2428:                     $locarg = $in{'curr_autharg'};
                   2429:                 }
                   2430:             } else {
                   2431:                 $result = &mt('Currently using local (institutional) authentication.');
                   2432:                 return $result;
1.165     raeburn  2433:             }
                   2434:         }
1.586     raeburn  2435:     } else {
                   2436:         if ($authnum == 1) {
1.784     bisitz   2437:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2438:         }
                   2439:     }
                   2440:     if (!$can_assign{'loc'}) {
                   2441:         return;
1.587     raeburn  2442:     } elsif ($authtype eq '') {
1.591     raeburn  2443:         if (defined($in{'mode'})) {
1.587     raeburn  2444:             if ($in{'mode'} eq 'modifycourse') {
                   2445:                 if ($authnum == 1) {
1.784     bisitz   2446:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2447:                 }
                   2448:             }
                   2449:         }
1.165     raeburn  2450:     }
1.586     raeburn  2451:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2452:     if ($authtype eq '') {
                   2453:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2454:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2455:                     $jscall.'" />';
                   2456:     }
                   2457:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2458:                $locarg.'" onchange="'.$jscall.'" />';
                   2459:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2460:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2461:     return $result;
                   2462: }
                   2463: 
                   2464: sub authform_filesystem{  
                   2465:     my %in = (
                   2466:               formname => 'document.cu',
                   2467:               kerb_def_dom => 'MSU.EDU',
                   2468:               @_,
                   2469:               );
1.586     raeburn  2470:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2471:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2472:     if (defined($in{'curr_authtype'})) {
                   2473:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2474:             if ($can_assign{'fsys'}) {
1.772     bisitz   2475:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2476:                 if (defined($in{'mode'})) {
                   2477:                     if ($in{'mode'} eq 'modifyuser') {
                   2478:                         $fsyscheck = '';
                   2479:                     }
                   2480:                 }
1.586     raeburn  2481:             } else {
                   2482:                 $result = &mt('Currently Filesystem Authenticated.');
                   2483:                 return $result;
                   2484:             }           
                   2485:         }
                   2486:     } else {
                   2487:         if ($authnum == 1) {
1.784     bisitz   2488:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2489:         }
                   2490:     }
                   2491:     if (!$can_assign{'fsys'}) {
                   2492:         return;
1.587     raeburn  2493:     } elsif ($authtype eq '') {
1.591     raeburn  2494:         if (defined($in{'mode'})) {
1.587     raeburn  2495:             if ($in{'mode'} eq 'modifycourse') {
                   2496:                 if ($authnum == 1) {
1.784     bisitz   2497:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2498:                 }
                   2499:             }
                   2500:         }
1.586     raeburn  2501:     }
                   2502:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2503:     if ($authtype eq '') {
                   2504:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2505:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2506:                     $jscall.'" />';
                   2507:     }
                   2508:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2509:                ' onchange="'.$jscall.'" />';
                   2510:     $result = &mt
1.144     matthew  2511:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2512:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2513:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2514:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2515:                   'onchange="'.$jscall.'" />');
1.32      matthew  2516:     return $result;
                   2517: }
                   2518: 
1.586     raeburn  2519: sub get_assignable_auth {
                   2520:     my ($dom) = @_;
                   2521:     if ($dom eq '') {
                   2522:         $dom = $env{'request.role.domain'};
                   2523:     }
                   2524:     my %can_assign = (
                   2525:                           krb4 => 1,
                   2526:                           krb5 => 1,
                   2527:                           int  => 1,
                   2528:                           loc  => 1,
                   2529:                      );
                   2530:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2531:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2532:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2533:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2534:             my $context;
                   2535:             if ($env{'request.role'} =~ /^au/) {
                   2536:                 $context = 'author';
                   2537:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2538:                 $context = 'domain';
                   2539:             } elsif ($env{'request.course.id'}) {
                   2540:                 $context = 'course';
                   2541:             }
                   2542:             if ($context) {
                   2543:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2544:                    %can_assign = %{$authhash->{$context}}; 
                   2545:                 }
                   2546:             }
                   2547:         }
                   2548:     }
                   2549:     my $authnum = 0;
                   2550:     foreach my $key (keys(%can_assign)) {
                   2551:         if ($can_assign{$key}) {
                   2552:             $authnum ++;
                   2553:         }
                   2554:     }
                   2555:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2556:         $authnum --;
                   2557:     }
                   2558:     return ($authnum,%can_assign);
                   2559: }
                   2560: 
1.80      albertel 2561: ###############################################################
                   2562: ##    Get Kerberos Defaults for Domain                 ##
                   2563: ###############################################################
                   2564: ##
                   2565: ## Returns default kerberos version and an associated argument
                   2566: ## as listed in file domain.tab. If not listed, provides
                   2567: ## appropriate default domain and kerberos version.
                   2568: ##
                   2569: #-------------------------------------------
                   2570: 
                   2571: =pod
                   2572: 
1.648     raeburn  2573: =item * &get_kerberos_defaults()
1.80      albertel 2574: 
                   2575: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2576: version and domain. If not found, it defaults to version 4 and the 
                   2577: domain of the server.
1.80      albertel 2578: 
1.648     raeburn  2579: =over 4
                   2580: 
1.80      albertel 2581: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2582: 
1.648     raeburn  2583: =back
                   2584: 
                   2585: =back
                   2586: 
1.80      albertel 2587: =cut
                   2588: 
                   2589: #-------------------------------------------
                   2590: sub get_kerberos_defaults {
                   2591:     my $domain=shift;
1.641     raeburn  2592:     my ($krbdef,$krbdefdom);
                   2593:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2594:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2595:         $krbdef = $domdefaults{'auth_def'};
                   2596:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2597:     } else {
1.80      albertel 2598:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2599:         my $krbdefdom=$1;
                   2600:         $krbdefdom=~tr/a-z/A-Z/;
                   2601:         $krbdef = "krb4";
                   2602:     }
                   2603:     return ($krbdef,$krbdefdom);
                   2604: }
1.112     bowersj2 2605: 
1.32      matthew  2606: 
1.46      matthew  2607: ###############################################################
                   2608: ##                Thesaurus Functions                        ##
                   2609: ###############################################################
1.20      www      2610: 
1.46      matthew  2611: =pod
1.20      www      2612: 
1.112     bowersj2 2613: =head1 Thesaurus Functions
                   2614: 
                   2615: =over 4
                   2616: 
1.648     raeburn  2617: =item * &initialize_keywords()
1.46      matthew  2618: 
                   2619: Initializes the package variable %Keywords if it is empty.  Uses the
                   2620: package variable $thesaurus_db_file.
                   2621: 
                   2622: =cut
                   2623: 
                   2624: ###################################################
                   2625: 
                   2626: sub initialize_keywords {
                   2627:     return 1 if (scalar keys(%Keywords));
                   2628:     # If we are here, %Keywords is empty, so fill it up
                   2629:     #   Make sure the file we need exists...
                   2630:     if (! -e $thesaurus_db_file) {
                   2631:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2632:                                  " failed because it does not exist");
                   2633:         return 0;
                   2634:     }
                   2635:     #   Set up the hash as a database
                   2636:     my %thesaurus_db;
                   2637:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2638:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2639:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2640:                                  $thesaurus_db_file);
                   2641:         return 0;
                   2642:     } 
                   2643:     #  Get the average number of appearances of a word.
                   2644:     my $avecount = $thesaurus_db{'average.count'};
                   2645:     #  Put keywords (those that appear > average) into %Keywords
                   2646:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2647:         my ($count,undef) = split /:/,$data;
                   2648:         $Keywords{$word}++ if ($count > $avecount);
                   2649:     }
                   2650:     untie %thesaurus_db;
                   2651:     # Remove special values from %Keywords.
1.356     albertel 2652:     foreach my $value ('total.count','average.count') {
                   2653:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2654:   }
1.46      matthew  2655:     return 1;
                   2656: }
                   2657: 
                   2658: ###################################################
                   2659: 
                   2660: =pod
                   2661: 
1.648     raeburn  2662: =item * &keyword($word)
1.46      matthew  2663: 
                   2664: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2665: than the average number of times in the thesaurus database.  Calls 
                   2666: &initialize_keywords
                   2667: 
                   2668: =cut
                   2669: 
                   2670: ###################################################
1.20      www      2671: 
                   2672: sub keyword {
1.46      matthew  2673:     return if (!&initialize_keywords());
                   2674:     my $word=lc(shift());
                   2675:     $word=~s/\W//g;
                   2676:     return exists($Keywords{$word});
1.20      www      2677: }
1.46      matthew  2678: 
                   2679: ###############################################################
                   2680: 
                   2681: =pod 
1.20      www      2682: 
1.648     raeburn  2683: =item * &get_related_words()
1.46      matthew  2684: 
1.160     matthew  2685: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2686: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2687: will be returned.  The order of the words returned is determined by the
                   2688: database which holds them.
                   2689: 
                   2690: Uses global $thesaurus_db_file.
                   2691: 
                   2692: =cut
                   2693: 
                   2694: ###############################################################
                   2695: sub get_related_words {
                   2696:     my $keyword = shift;
                   2697:     my %thesaurus_db;
                   2698:     if (! -e $thesaurus_db_file) {
                   2699:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2700:                                  "failed because the file does not exist");
                   2701:         return ();
                   2702:     }
                   2703:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2704:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2705:         return ();
                   2706:     } 
                   2707:     my @Words=();
1.429     www      2708:     my $count=0;
1.46      matthew  2709:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2710: 	# The first element is the number of times
                   2711: 	# the word appears.  We do not need it now.
1.429     www      2712: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2713: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2714: 	my $threshold=$mostfrequentcount/10;
                   2715:         foreach my $possibleword (@RelatedWords) {
                   2716:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2717:             if ($wordcount>$threshold) {
                   2718: 		push(@Words,$word);
                   2719:                 $count++;
                   2720:                 if ($count>10) { last; }
                   2721: 	    }
1.20      www      2722:         }
                   2723:     }
1.46      matthew  2724:     untie %thesaurus_db;
                   2725:     return @Words;
1.14      harris41 2726: }
1.46      matthew  2727: 
1.112     bowersj2 2728: =pod
                   2729: 
                   2730: =back
                   2731: 
                   2732: =cut
1.61      www      2733: 
                   2734: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2735: =pod
                   2736: 
1.112     bowersj2 2737: =head1 User Name Functions
                   2738: 
                   2739: =over 4
                   2740: 
1.648     raeburn  2741: =item * &plainname($uname,$udom,$first)
1.81      albertel 2742: 
1.112     bowersj2 2743: Takes a users logon name and returns it as a string in
1.226     albertel 2744: "first middle last generation" form 
                   2745: if $first is set to 'lastname' then it returns it as
                   2746: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2747: 
                   2748: =cut
1.61      www      2749: 
1.295     www      2750: 
1.81      albertel 2751: ###############################################################
1.61      www      2752: sub plainname {
1.226     albertel 2753:     my ($uname,$udom,$first)=@_;
1.537     albertel 2754:     return if (!defined($uname) || !defined($udom));
1.295     www      2755:     my %names=&getnames($uname,$udom);
1.226     albertel 2756:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2757: 					  $names{'middlename'},
                   2758: 					  $names{'lastname'},
                   2759: 					  $names{'generation'},$first);
                   2760:     $name=~s/^\s+//;
1.62      www      2761:     $name=~s/\s+$//;
                   2762:     $name=~s/\s+/ /g;
1.353     albertel 2763:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2764:     return $name;
1.61      www      2765: }
1.66      www      2766: 
                   2767: # -------------------------------------------------------------------- Nickname
1.81      albertel 2768: =pod
                   2769: 
1.648     raeburn  2770: =item * &nickname($uname,$udom)
1.81      albertel 2771: 
                   2772: Gets a users name and returns it as a string as
                   2773: 
                   2774: "&quot;nickname&quot;"
1.66      www      2775: 
1.81      albertel 2776: if the user has a nickname or
                   2777: 
                   2778: "first middle last generation"
                   2779: 
                   2780: if the user does not
                   2781: 
                   2782: =cut
1.66      www      2783: 
                   2784: sub nickname {
                   2785:     my ($uname,$udom)=@_;
1.537     albertel 2786:     return if (!defined($uname) || !defined($udom));
1.295     www      2787:     my %names=&getnames($uname,$udom);
1.68      albertel 2788:     my $name=$names{'nickname'};
1.66      www      2789:     if ($name) {
                   2790:        $name='&quot;'.$name.'&quot;'; 
                   2791:     } else {
                   2792:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2793: 	     $names{'lastname'}.' '.$names{'generation'};
                   2794:        $name=~s/\s+$//;
                   2795:        $name=~s/\s+/ /g;
                   2796:     }
                   2797:     return $name;
                   2798: }
                   2799: 
1.295     www      2800: sub getnames {
                   2801:     my ($uname,$udom)=@_;
1.537     albertel 2802:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2803:     if ($udom eq 'public' && $uname eq 'public') {
                   2804: 	return ('lastname' => &mt('Public'));
                   2805:     }
1.295     www      2806:     my $id=$uname.':'.$udom;
                   2807:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2808:     if ($cached) {
                   2809: 	return %{$names};
                   2810:     } else {
                   2811: 	my %loadnames=&Apache::lonnet::get('environment',
                   2812:                     ['firstname','middlename','lastname','generation','nickname'],
                   2813: 					 $udom,$uname);
                   2814: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2815: 	return %loadnames;
                   2816:     }
                   2817: }
1.61      www      2818: 
1.542     raeburn  2819: # -------------------------------------------------------------------- getemails
1.648     raeburn  2820: 
1.542     raeburn  2821: =pod
                   2822: 
1.648     raeburn  2823: =item * &getemails($uname,$udom)
1.542     raeburn  2824: 
                   2825: Gets a user's email information and returns it as a hash with keys:
                   2826: notification, critnotification, permanentemail
                   2827: 
                   2828: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2829: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2830:  
1.648     raeburn  2831: 
1.542     raeburn  2832: =cut
                   2833: 
1.648     raeburn  2834: 
1.466     albertel 2835: sub getemails {
                   2836:     my ($uname,$udom)=@_;
                   2837:     if ($udom eq 'public' && $uname eq 'public') {
                   2838: 	return;
                   2839:     }
1.467     www      2840:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2841:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2842:     my $id=$uname.':'.$udom;
                   2843:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2844:     if ($cached) {
                   2845: 	return %{$names};
                   2846:     } else {
                   2847: 	my %loadnames=&Apache::lonnet::get('environment',
                   2848:                     			   ['notification','critnotification',
                   2849: 					    'permanentemail'],
                   2850: 					   $udom,$uname);
                   2851: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2852: 	return %loadnames;
                   2853:     }
                   2854: }
                   2855: 
1.551     albertel 2856: sub flush_email_cache {
                   2857:     my ($uname,$udom)=@_;
                   2858:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2859:     if (!$uname) { $uname=$env{'user.name'};   }
                   2860:     return if ($udom eq 'public' && $uname eq 'public');
                   2861:     my $id=$uname.':'.$udom;
                   2862:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2863: }
                   2864: 
1.728     raeburn  2865: # -------------------------------------------------------------------- getlangs
                   2866: 
                   2867: =pod
                   2868: 
                   2869: =item * &getlangs($uname,$udom)
                   2870: 
                   2871: Gets a user's language preference and returns it as a hash with key:
                   2872: language.
                   2873: 
                   2874: =cut
                   2875: 
                   2876: 
                   2877: sub getlangs {
                   2878:     my ($uname,$udom) = @_;
                   2879:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2880:     if (!$uname) { $uname=$env{'user.name'};   }
                   2881:     my $id=$uname.':'.$udom;
                   2882:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2883:     if ($cached) {
                   2884:         return %{$langs};
                   2885:     } else {
                   2886:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2887:                                            $udom,$uname);
                   2888:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2889:         return %loadlangs;
                   2890:     }
                   2891: }
                   2892: 
                   2893: sub flush_langs_cache {
                   2894:     my ($uname,$udom)=@_;
                   2895:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2896:     if (!$uname) { $uname=$env{'user.name'};   }
                   2897:     return if ($udom eq 'public' && $uname eq 'public');
                   2898:     my $id=$uname.':'.$udom;
                   2899:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2900: }
                   2901: 
1.61      www      2902: # ------------------------------------------------------------------ Screenname
1.81      albertel 2903: 
                   2904: =pod
                   2905: 
1.648     raeburn  2906: =item * &screenname($uname,$udom)
1.81      albertel 2907: 
                   2908: Gets a users screenname and returns it as a string
                   2909: 
                   2910: =cut
1.61      www      2911: 
                   2912: sub screenname {
                   2913:     my ($uname,$udom)=@_;
1.258     albertel 2914:     if ($uname eq $env{'user.name'} &&
                   2915: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2916:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2917:     return $names{'screenname'};
1.62      www      2918: }
                   2919: 
1.212     albertel 2920: 
1.802     bisitz   2921: # ------------------------------------------------------------- Confirm Wrapper
                   2922: =pod
                   2923: 
                   2924: =item confirmwrapper
                   2925: 
                   2926: Wrap messages about completion of operation in box
                   2927: 
                   2928: =cut
                   2929: 
                   2930: sub confirmwrapper {
                   2931:     my ($message)=@_;
                   2932:     if ($message) {
                   2933:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2934:                .$message."\n"
                   2935:                .'</div>'."\n";
                   2936:     } else {
                   2937:         return $message;
                   2938:     }
                   2939: }
                   2940: 
1.62      www      2941: # ------------------------------------------------------------- Message Wrapper
                   2942: 
                   2943: sub messagewrapper {
1.369     www      2944:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2945:     return 
1.441     albertel 2946:         '<a href="/adm/email?compose=individual&amp;'.
                   2947:         'recname='.$username.'&amp;recdom='.$domain.
                   2948: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2949:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2950: }
1.802     bisitz   2951: 
1.74      www      2952: # --------------------------------------------------------------- Notes Wrapper
                   2953: 
                   2954: sub noteswrapper {
                   2955:     my ($link,$un,$do)=@_;
                   2956:     return 
                   2957: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2958: }
1.802     bisitz   2959: 
1.62      www      2960: # ------------------------------------------------------------- Aboutme Wrapper
                   2961: 
                   2962: sub aboutmewrapper {
1.166     www      2963:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2964:     if (!defined($username)  && !defined($domain)) {
                   2965:         return;
                   2966:     }
1.892   ! amueller 2967:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  2968: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2969: }
                   2970: 
                   2971: # ------------------------------------------------------------ Syllabus Wrapper
                   2972: 
                   2973: sub syllabuswrapper {
1.707     bisitz   2974:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2975:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2976: }
1.14      harris41 2977: 
1.802     bisitz   2978: # -----------------------------------------------------------------------------
                   2979: 
1.208     matthew  2980: sub track_student_link {
1.887     raeburn  2981:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 2982:     my $link ="/adm/trackstudent?";
1.208     matthew  2983:     my $title = 'View recent activity';
                   2984:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2985:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2986:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2987:         $title .= ' of this student';
1.268     albertel 2988:     } 
1.208     matthew  2989:     if (defined($target) && $target !~ /^\s*$/) {
                   2990:         $target = qq{target="$target"};
                   2991:     } else {
                   2992:         $target = '';
                   2993:     }
1.268     albertel 2994:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  2995:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 2996:     $title = &mt($title);
                   2997:     $linktext = &mt($linktext);
1.448     albertel 2998:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2999: 	&help_open_topic('View_recent_activity');
1.208     matthew  3000: }
                   3001: 
1.781     raeburn  3002: sub slot_reservations_link {
                   3003:     my ($linktext,$sname,$sdom,$target) = @_;
                   3004:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3005:     my $title = 'View slot reservation history';
                   3006:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3007:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3008:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3009:         $title .= ' of this student';
                   3010:     }
                   3011:     if (defined($target) && $target !~ /^\s*$/) {
                   3012:         $target = qq{target="$target"};
                   3013:     } else {
                   3014:         $target = '';
                   3015:     }
                   3016:     $title = &mt($title);
                   3017:     $linktext = &mt($linktext);
                   3018:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3019: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3020: 
                   3021: }
                   3022: 
1.508     www      3023: # ===================================================== Display a student photo
                   3024: 
                   3025: 
1.509     albertel 3026: sub student_image_tag {
1.508     www      3027:     my ($domain,$user)=@_;
                   3028:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3029:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3030: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3031:     } else {
                   3032: 	return '';
                   3033:     }
                   3034: }
                   3035: 
1.112     bowersj2 3036: =pod
                   3037: 
                   3038: =back
                   3039: 
                   3040: =head1 Access .tab File Data
                   3041: 
                   3042: =over 4
                   3043: 
1.648     raeburn  3044: =item * &languageids() 
1.112     bowersj2 3045: 
                   3046: returns list of all language ids
                   3047: 
                   3048: =cut
                   3049: 
1.14      harris41 3050: sub languageids {
1.16      harris41 3051:     return sort(keys(%language));
1.14      harris41 3052: }
                   3053: 
1.112     bowersj2 3054: =pod
                   3055: 
1.648     raeburn  3056: =item * &languagedescription() 
1.112     bowersj2 3057: 
                   3058: returns description of a specified language id
                   3059: 
                   3060: =cut
                   3061: 
1.14      harris41 3062: sub languagedescription {
1.125     www      3063:     my $code=shift;
                   3064:     return  ($supported_language{$code}?'* ':'').
                   3065:             $language{$code}.
1.126     www      3066: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3067: }
                   3068: 
                   3069: sub plainlanguagedescription {
                   3070:     my $code=shift;
                   3071:     return $language{$code};
                   3072: }
                   3073: 
                   3074: sub supportedlanguagecode {
                   3075:     my $code=shift;
                   3076:     return $supported_language{$code};
1.97      www      3077: }
                   3078: 
1.112     bowersj2 3079: =pod
                   3080: 
1.648     raeburn  3081: =item * &copyrightids() 
1.112     bowersj2 3082: 
                   3083: returns list of all copyrights
                   3084: 
                   3085: =cut
                   3086: 
                   3087: sub copyrightids {
                   3088:     return sort(keys(%cprtag));
                   3089: }
                   3090: 
                   3091: =pod
                   3092: 
1.648     raeburn  3093: =item * &copyrightdescription() 
1.112     bowersj2 3094: 
                   3095: returns description of a specified copyright id
                   3096: 
                   3097: =cut
                   3098: 
                   3099: sub copyrightdescription {
1.166     www      3100:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3101: }
1.197     matthew  3102: 
                   3103: =pod
                   3104: 
1.648     raeburn  3105: =item * &source_copyrightids() 
1.192     taceyjo1 3106: 
                   3107: returns list of all source copyrights
                   3108: 
                   3109: =cut
                   3110: 
                   3111: sub source_copyrightids {
                   3112:     return sort(keys(%scprtag));
                   3113: }
                   3114: 
                   3115: =pod
                   3116: 
1.648     raeburn  3117: =item * &source_copyrightdescription() 
1.192     taceyjo1 3118: 
                   3119: returns description of a specified source copyright id
                   3120: 
                   3121: =cut
                   3122: 
                   3123: sub source_copyrightdescription {
                   3124:     return &mt($scprtag{shift(@_)});
                   3125: }
1.112     bowersj2 3126: 
                   3127: =pod
                   3128: 
1.648     raeburn  3129: =item * &filecategories() 
1.112     bowersj2 3130: 
                   3131: returns list of all file categories
                   3132: 
                   3133: =cut
                   3134: 
                   3135: sub filecategories {
                   3136:     return sort(keys(%category_extensions));
                   3137: }
                   3138: 
                   3139: =pod
                   3140: 
1.648     raeburn  3141: =item * &filecategorytypes() 
1.112     bowersj2 3142: 
                   3143: returns list of file types belonging to a given file
                   3144: category
                   3145: 
                   3146: =cut
                   3147: 
                   3148: sub filecategorytypes {
1.356     albertel 3149:     my ($cat) = @_;
                   3150:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3151: }
                   3152: 
                   3153: =pod
                   3154: 
1.648     raeburn  3155: =item * &fileembstyle() 
1.112     bowersj2 3156: 
                   3157: returns embedding style for a specified file type
                   3158: 
                   3159: =cut
                   3160: 
                   3161: sub fileembstyle {
                   3162:     return $fe{lc(shift(@_))};
1.169     www      3163: }
                   3164: 
1.351     www      3165: sub filemimetype {
                   3166:     return $fm{lc(shift(@_))};
                   3167: }
                   3168: 
1.169     www      3169: 
                   3170: sub filecategoryselect {
                   3171:     my ($name,$value)=@_;
1.189     matthew  3172:     return &select_form($value,$name,
1.169     www      3173: 			'' => &mt('Any category'),
                   3174: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3175: }
                   3176: 
                   3177: =pod
                   3178: 
1.648     raeburn  3179: =item * &filedescription() 
1.112     bowersj2 3180: 
                   3181: returns description for a specified file type
                   3182: 
                   3183: =cut
                   3184: 
                   3185: sub filedescription {
1.188     matthew  3186:     my $file_description = $fd{lc(shift())};
                   3187:     $file_description =~ s:([\[\]]):~$1:g;
                   3188:     return &mt($file_description);
1.112     bowersj2 3189: }
                   3190: 
                   3191: =pod
                   3192: 
1.648     raeburn  3193: =item * &filedescriptionex() 
1.112     bowersj2 3194: 
                   3195: returns description for a specified file type with
                   3196: extra formatting
                   3197: 
                   3198: =cut
                   3199: 
                   3200: sub filedescriptionex {
                   3201:     my $ex=shift;
1.188     matthew  3202:     my $file_description = $fd{lc($ex)};
                   3203:     $file_description =~ s:([\[\]]):~$1:g;
                   3204:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3205: }
                   3206: 
                   3207: # End of .tab access
                   3208: =pod
                   3209: 
                   3210: =back
                   3211: 
                   3212: =cut
                   3213: 
                   3214: # ------------------------------------------------------------------ File Types
                   3215: sub fileextensions {
                   3216:     return sort(keys(%fe));
                   3217: }
                   3218: 
1.97      www      3219: # ----------------------------------------------------------- Display Languages
                   3220: # returns a hash with all desired display languages
                   3221: #
                   3222: 
                   3223: sub display_languages {
                   3224:     my %languages=();
1.695     raeburn  3225:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3226: 	$languages{$lang}=1;
1.97      www      3227:     }
                   3228:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3229:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3230: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3231: 	    $languages{$lang}=1;
1.97      www      3232:         }
                   3233:     }
                   3234:     return %languages;
1.14      harris41 3235: }
                   3236: 
1.582     albertel 3237: sub languages {
                   3238:     my ($possible_langs) = @_;
1.695     raeburn  3239:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3240:     if (!ref($possible_langs)) {
                   3241: 	if( wantarray ) {
                   3242: 	    return @preferred_langs;
                   3243: 	} else {
                   3244: 	    return $preferred_langs[0];
                   3245: 	}
                   3246:     }
                   3247:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3248:     my @preferred_possibilities;
                   3249:     foreach my $preferred_lang (@preferred_langs) {
                   3250: 	if (exists($possibilities{$preferred_lang})) {
                   3251: 	    push(@preferred_possibilities, $preferred_lang);
                   3252: 	}
                   3253:     }
                   3254:     if( wantarray ) {
                   3255: 	return @preferred_possibilities;
                   3256:     }
                   3257:     return $preferred_possibilities[0];
                   3258: }
                   3259: 
1.742     raeburn  3260: sub user_lang {
                   3261:     my ($touname,$toudom,$fromcid) = @_;
                   3262:     my @userlangs;
                   3263:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3264:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3265:                     $env{'course.'.$fromcid.'.languages'}));
                   3266:     } else {
                   3267:         my %langhash = &getlangs($touname,$toudom);
                   3268:         if ($langhash{'languages'} ne '') {
                   3269:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3270:         } else {
                   3271:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3272:             if ($domdefs{'lang_def'} ne '') {
                   3273:                 @userlangs = ($domdefs{'lang_def'});
                   3274:             }
                   3275:         }
                   3276:     }
                   3277:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3278:     my $user_lh = Apache::localize->get_handle(@languages);
                   3279:     return $user_lh;
                   3280: }
                   3281: 
                   3282: 
1.112     bowersj2 3283: ###############################################################
                   3284: ##               Student Answer Attempts                     ##
                   3285: ###############################################################
                   3286: 
                   3287: =pod
                   3288: 
                   3289: =head1 Alternate Problem Views
                   3290: 
                   3291: =over 4
                   3292: 
1.648     raeburn  3293: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3294:     $getattempt, $regexp, $gradesub)
                   3295: 
                   3296: Return string with previous attempt on problem. Arguments:
                   3297: 
                   3298: =over 4
                   3299: 
                   3300: =item * $symb: Problem, including path
                   3301: 
                   3302: =item * $username: username of the desired student
                   3303: 
                   3304: =item * $domain: domain of the desired student
1.14      harris41 3305: 
1.112     bowersj2 3306: =item * $course: Course ID
1.14      harris41 3307: 
1.112     bowersj2 3308: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3309:     something
1.14      harris41 3310: 
1.112     bowersj2 3311: =item * $regexp: if string matches this regexp, the string will be
                   3312:     sent to $gradesub
1.14      harris41 3313: 
1.112     bowersj2 3314: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3315: 
1.112     bowersj2 3316: =back
1.14      harris41 3317: 
1.112     bowersj2 3318: The output string is a table containing all desired attempts, if any.
1.16      harris41 3319: 
1.112     bowersj2 3320: =cut
1.1       albertel 3321: 
                   3322: sub get_previous_attempt {
1.43      ng       3323:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3324:   my $prevattempts='';
1.43      ng       3325:   no strict 'refs';
1.1       albertel 3326:   if ($symb) {
1.3       albertel 3327:     my (%returnhash)=
                   3328:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3329:     if ($returnhash{'version'}) {
                   3330:       my %lasthash=();
                   3331:       my $version;
                   3332:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3333:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3334: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3335:         }
1.1       albertel 3336:       }
1.596     albertel 3337:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3338:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3339:       foreach my $key (sort(keys(%lasthash))) {
                   3340: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3341: 	if ($#parts > 0) {
1.31      albertel 3342: 	  my $data=$parts[-1];
                   3343: 	  pop(@parts);
1.596     albertel 3344: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3345: 	} else {
1.41      ng       3346: 	  if ($#parts == 0) {
                   3347: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3348: 	  } else {
                   3349: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3350: 	  }
1.31      albertel 3351: 	}
1.16      harris41 3352:       }
1.596     albertel 3353:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3354:       if ($getattempt eq '') {
                   3355: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3356: 	  $prevattempts.=&start_data_table_row().
                   3357: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3358: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3359: 		my $value = &format_previous_attempt_value($key,
                   3360: 							   $returnhash{$version.':'.$key});
                   3361: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3362: 	    }
1.596     albertel 3363: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3364: 	 }
1.1       albertel 3365:       }
1.596     albertel 3366:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3367:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3368: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3369: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3370: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3371:       }
1.596     albertel 3372:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3373:     } else {
1.596     albertel 3374:       $prevattempts=
                   3375: 	  &start_data_table().&start_data_table_row().
                   3376: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3377: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3378:     }
                   3379:   } else {
1.596     albertel 3380:     $prevattempts=
                   3381: 	  &start_data_table().&start_data_table_row().
                   3382: 	  '<td>'.&mt('No data.').'</td>'.
                   3383: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3384:   }
1.10      albertel 3385: }
                   3386: 
1.581     albertel 3387: sub format_previous_attempt_value {
                   3388:     my ($key,$value) = @_;
                   3389:     if ($key =~ /timestamp/) {
                   3390: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3391:     } elsif (ref($value) eq 'ARRAY') {
                   3392: 	$value = '('.join(', ', @{ $value }).')';
                   3393:     } else {
                   3394: 	$value = &unescape($value);
                   3395:     }
                   3396:     return $value;
                   3397: }
                   3398: 
                   3399: 
1.107     albertel 3400: sub relative_to_absolute {
                   3401:     my ($url,$output)=@_;
                   3402:     my $parser=HTML::TokeParser->new(\$output);
                   3403:     my $token;
                   3404:     my $thisdir=$url;
                   3405:     my @rlinks=();
                   3406:     while ($token=$parser->get_token) {
                   3407: 	if ($token->[0] eq 'S') {
                   3408: 	    if ($token->[1] eq 'a') {
                   3409: 		if ($token->[2]->{'href'}) {
                   3410: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3411: 		}
                   3412: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3413: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3414: 	    } elsif ($token->[1] eq 'base') {
                   3415: 		$thisdir=$token->[2]->{'href'};
                   3416: 	    }
                   3417: 	}
                   3418:     }
                   3419:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3420:     foreach my $link (@rlinks) {
1.726     raeburn  3421: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3422: 		($link=~/^\//) ||
                   3423: 		($link=~/^javascript:/i) ||
                   3424: 		($link=~/^mailto:/i) ||
                   3425: 		($link=~/^\#/)) {
                   3426: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3427: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3428: 	}
                   3429:     }
                   3430: # -------------------------------------------------- Deal with Applet codebases
                   3431:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3432:     return $output;
                   3433: }
                   3434: 
1.112     bowersj2 3435: =pod
                   3436: 
1.648     raeburn  3437: =item * &get_student_view()
1.112     bowersj2 3438: 
                   3439: show a snapshot of what student was looking at
                   3440: 
                   3441: =cut
                   3442: 
1.10      albertel 3443: sub get_student_view {
1.186     albertel 3444:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3445:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3446:   my (%form);
1.10      albertel 3447:   my @elements=('symb','courseid','domain','username');
                   3448:   foreach my $element (@elements) {
1.186     albertel 3449:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3450:   }
1.186     albertel 3451:   if (defined($moreenv)) {
                   3452:       %form=(%form,%{$moreenv});
                   3453:   }
1.236     albertel 3454:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3455:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3456:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3457:   $userview=~s/\<body[^\>]*\>//gi;
                   3458:   $userview=~s/\<\/body\>//gi;
                   3459:   $userview=~s/\<html\>//gi;
                   3460:   $userview=~s/\<\/html\>//gi;
                   3461:   $userview=~s/\<head\>//gi;
                   3462:   $userview=~s/\<\/head\>//gi;
                   3463:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3464:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3465:   if (wantarray) {
                   3466:      return ($userview,$response);
                   3467:   } else {
                   3468:      return $userview;
                   3469:   }
                   3470: }
                   3471: 
                   3472: sub get_student_view_with_retries {
                   3473:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3474: 
                   3475:     my $ok = 0;                 # True if we got a good response.
                   3476:     my $content;
                   3477:     my $response;
                   3478: 
                   3479:     # Try to get the student_view done. within the retries count:
                   3480:     
                   3481:     do {
                   3482:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3483:          $ok      = $response->is_success;
                   3484:          if (!$ok) {
                   3485:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3486:          }
                   3487:          $retries--;
                   3488:     } while (!$ok && ($retries > 0));
                   3489:     
                   3490:     if (!$ok) {
                   3491:        $content = '';          # On error return an empty content.
                   3492:     }
1.651     www      3493:     if (wantarray) {
                   3494:        return ($content, $response);
                   3495:     } else {
                   3496:        return $content;
                   3497:     }
1.11      albertel 3498: }
                   3499: 
1.112     bowersj2 3500: =pod
                   3501: 
1.648     raeburn  3502: =item * &get_student_answers() 
1.112     bowersj2 3503: 
                   3504: show a snapshot of how student was answering problem
                   3505: 
                   3506: =cut
                   3507: 
1.11      albertel 3508: sub get_student_answers {
1.100     sakharuk 3509:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3510:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3511:   my (%moreenv);
1.11      albertel 3512:   my @elements=('symb','courseid','domain','username');
                   3513:   foreach my $element (@elements) {
1.186     albertel 3514:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3515:   }
1.186     albertel 3516:   $moreenv{'grade_target'}='answer';
                   3517:   %moreenv=(%form,%moreenv);
1.497     raeburn  3518:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3519:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3520:   return $userview;
1.1       albertel 3521: }
1.116     albertel 3522: 
                   3523: =pod
                   3524: 
                   3525: =item * &submlink()
                   3526: 
1.242     albertel 3527: Inputs: $text $uname $udom $symb $target
1.116     albertel 3528: 
                   3529: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3530: 
                   3531: =cut
                   3532: 
                   3533: ###############################################
                   3534: sub submlink {
1.242     albertel 3535:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3536:     if (!($uname && $udom)) {
                   3537: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3538: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3539: 	if (!$symb) { $symb=$cursymb; }
                   3540:     }
1.254     matthew  3541:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3542:     $symb=&escape($symb);
1.242     albertel 3543:     if ($target) { $target="target=\"$target\""; }
                   3544:     return '<a href="/adm/grades?&command=submission&'.
                   3545: 	'symb='.$symb.'&student='.$uname.
                   3546: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3547: }
                   3548: ##############################################
                   3549: 
                   3550: =pod
                   3551: 
                   3552: =item * &pgrdlink()
                   3553: 
                   3554: Inputs: $text $uname $udom $symb $target
                   3555: 
                   3556: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3557: 
                   3558: =cut
                   3559: 
                   3560: ###############################################
                   3561: sub pgrdlink {
                   3562:     my $link=&submlink(@_);
                   3563:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3564:     return $link;
                   3565: }
                   3566: ##############################################
                   3567: 
                   3568: =pod
                   3569: 
                   3570: =item * &pprmlink()
                   3571: 
                   3572: Inputs: $text $uname $udom $symb $target
                   3573: 
                   3574: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3575: student and a specific resource
1.242     albertel 3576: 
                   3577: =cut
                   3578: 
                   3579: ###############################################
                   3580: sub pprmlink {
                   3581:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3582:     if (!($uname && $udom)) {
                   3583: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3584: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3585: 	if (!$symb) { $symb=$cursymb; }
                   3586:     }
1.254     matthew  3587:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3588:     $symb=&escape($symb);
1.242     albertel 3589:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3590:     return '<a href="/adm/parmset?command=set&amp;'.
                   3591: 	'symb='.$symb.'&amp;uname='.$uname.
                   3592: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3593: }
                   3594: ##############################################
1.37      matthew  3595: 
1.112     bowersj2 3596: =pod
                   3597: 
                   3598: =back
                   3599: 
                   3600: =cut
                   3601: 
1.37      matthew  3602: ###############################################
1.51      www      3603: 
                   3604: 
                   3605: sub timehash {
1.687     raeburn  3606:     my ($thistime) = @_;
                   3607:     my $timezone = &Apache::lonlocal::gettimezone();
                   3608:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3609:                      ->set_time_zone($timezone);
                   3610:     my $wday = $dt->day_of_week();
                   3611:     if ($wday == 7) { $wday = 0; }
                   3612:     return ( 'second' => $dt->second(),
                   3613:              'minute' => $dt->minute(),
                   3614:              'hour'   => $dt->hour(),
                   3615:              'day'     => $dt->day_of_month(),
                   3616:              'month'   => $dt->month(),
                   3617:              'year'    => $dt->year(),
                   3618:              'weekday' => $wday,
                   3619:              'dayyear' => $dt->day_of_year(),
                   3620:              'dlsav'   => $dt->is_dst() );
1.51      www      3621: }
                   3622: 
1.370     www      3623: sub utc_string {
                   3624:     my ($date)=@_;
1.371     www      3625:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3626: }
                   3627: 
1.51      www      3628: sub maketime {
                   3629:     my %th=@_;
1.687     raeburn  3630:     my ($epoch_time,$timezone,$dt);
                   3631:     $timezone = &Apache::lonlocal::gettimezone();
                   3632:     eval {
                   3633:         $dt = DateTime->new( year   => $th{'year'},
                   3634:                              month  => $th{'month'},
                   3635:                              day    => $th{'day'},
                   3636:                              hour   => $th{'hour'},
                   3637:                              minute => $th{'minute'},
                   3638:                              second => $th{'second'},
                   3639:                              time_zone => $timezone,
                   3640:                          );
                   3641:     };
                   3642:     if (!$@) {
                   3643:         $epoch_time = $dt->epoch;
                   3644:         if ($epoch_time) {
                   3645:             return $epoch_time;
                   3646:         }
                   3647:     }
1.51      www      3648:     return POSIX::mktime(
                   3649:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3650:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3651: }
                   3652: 
                   3653: #########################################
1.51      www      3654: 
                   3655: sub findallcourses {
1.482     raeburn  3656:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3657:     my %roles;
                   3658:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3659:     my %courses;
1.51      www      3660:     my $now=time;
1.482     raeburn  3661:     if (!defined($uname)) {
                   3662:         $uname = $env{'user.name'};
                   3663:     }
                   3664:     if (!defined($udom)) {
                   3665:         $udom = $env{'user.domain'};
                   3666:     }
                   3667:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3668:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3669:         if (!%roles) {
                   3670:             %roles = (
                   3671:                        cc => 1,
                   3672:                        in => 1,
                   3673:                        ep => 1,
                   3674:                        ta => 1,
                   3675:                        cr => 1,
                   3676:                        st => 1,
                   3677:              );
                   3678:         }
                   3679:         foreach my $entry (keys(%roleshash)) {
                   3680:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3681:             if ($trole =~ /^cr/) { 
                   3682:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3683:             } else {
                   3684:                 next if (!exists($roles{$trole}));
                   3685:             }
                   3686:             if ($tend) {
                   3687:                 next if ($tend < $now);
                   3688:             }
                   3689:             if ($tstart) {
                   3690:                 next if ($tstart > $now);
                   3691:             }
                   3692:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3693:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3694:             if ($secpart eq '') {
                   3695:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3696:                 $sec = 'none';
                   3697:                 $realsec = '';
                   3698:             } else {
                   3699:                 $cnum = $cnumpart;
                   3700:                 ($sec,$role) = split(/_/,$secpart);
                   3701:                 $realsec = $sec;
1.490     raeburn  3702:             }
1.482     raeburn  3703:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3704:         }
                   3705:     } else {
                   3706:         foreach my $key (keys(%env)) {
1.483     albertel 3707: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3708:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3709: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3710: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3711: 	        next if (%roles && !exists($roles{$role}));
                   3712: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3713:                 my $active=1;
                   3714:                 if ($starttime) {
                   3715: 		    if ($now<$starttime) { $active=0; }
                   3716:                 }
                   3717:                 if ($endtime) {
                   3718:                     if ($now>$endtime) { $active=0; }
                   3719:                 }
                   3720:                 if ($active) {
                   3721:                     if ($sec eq '') {
                   3722:                         $sec = 'none';
                   3723:                     }
                   3724:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3725:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3726:                 }
                   3727:             }
1.51      www      3728:         }
                   3729:     }
1.474     raeburn  3730:     return %courses;
1.51      www      3731: }
1.37      matthew  3732: 
1.54      www      3733: ###############################################
1.474     raeburn  3734: 
                   3735: sub blockcheck {
1.482     raeburn  3736:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3737: 
                   3738:     if (!defined($udom)) {
                   3739:         $udom = $env{'user.domain'};
                   3740:     }
                   3741:     if (!defined($uname)) {
                   3742:         $uname = $env{'user.name'};
                   3743:     }
                   3744: 
                   3745:     # If uname and udom are for a course, check for blocks in the course.
                   3746: 
                   3747:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3748:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3749:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3750:         return ($startblock,$endblock);
                   3751:     }
1.474     raeburn  3752: 
1.502     raeburn  3753:     my $startblock = 0;
                   3754:     my $endblock = 0;
1.482     raeburn  3755:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3756: 
1.490     raeburn  3757:     # If uname is for a user, and activity is course-specific, i.e.,
                   3758:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3759: 
1.490     raeburn  3760:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3761:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3762:         foreach my $key (keys(%live_courses)) {
                   3763:             if ($key ne $env{'request.course.id'}) {
                   3764:                 delete($live_courses{$key});
                   3765:             }
                   3766:         }
                   3767:     }
                   3768: 
                   3769:     my $otheruser = 0;
                   3770:     my %own_courses;
                   3771:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3772:         # Resource belongs to user other than current user.
                   3773:         $otheruser = 1;
                   3774:         # Gather courses for current user
                   3775:         %own_courses = 
                   3776:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3777:     }
                   3778: 
                   3779:     # Gather active course roles - course coordinator, instructor, 
                   3780:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3781: 
                   3782:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3783:         my ($cdom,$cnum);
                   3784:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3785:             $cdom = $env{'course.'.$course.'.domain'};
                   3786:             $cnum = $env{'course.'.$course.'.num'};
                   3787:         } else {
1.490     raeburn  3788:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3789:         }
                   3790:         my $no_ownblock = 0;
                   3791:         my $no_userblock = 0;
1.533     raeburn  3792:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3793:             # Check if current user has 'evb' priv for this
                   3794:             if (defined($own_courses{$course})) {
                   3795:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3796:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3797:                     if ($sec ne 'none') {
                   3798:                         $checkrole .= '/'.$sec;
                   3799:                     }
                   3800:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3801:                         $no_ownblock = 1;
                   3802:                         last;
                   3803:                     }
                   3804:                 }
                   3805:             }
                   3806:             # if they have 'evb' priv and are currently not playing student
                   3807:             next if (($no_ownblock) &&
                   3808:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3809:         }
1.474     raeburn  3810:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3811:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3812:             if ($sec ne 'none') {
1.482     raeburn  3813:                 $checkrole .= '/'.$sec;
1.474     raeburn  3814:             }
1.490     raeburn  3815:             if ($otheruser) {
                   3816:                 # Resource belongs to user other than current user.
                   3817:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3818:                 my ($trole,$tdom,$tnum,$tsec);
                   3819:                 my $entry = $live_courses{$course}{$sec};
                   3820:                 if ($entry =~ /^cr/) {
                   3821:                     ($trole,$tdom,$tnum,$tsec) = 
                   3822:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3823:                 } else {
                   3824:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3825:                 }
                   3826:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3827:                 $area = '/'.$tdom.'/'.$tnum;
                   3828:                 $trest = $tnum;
                   3829:                 if ($tsec ne '') {
                   3830:                     $area .= '/'.$tsec;
                   3831:                     $trest .= '/'.$tsec;
                   3832:                 }
                   3833:                 $spec = $trole.'.'.$area;
                   3834:                 if ($trole =~ /^cr/) {
                   3835:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3836:                                                       $tdom,$spec,$trest,$area);
                   3837:                 } else {
                   3838:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3839:                                                        $tdom,$spec,$trest,$area);
                   3840:                 }
                   3841:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3842:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3843:                     if ($1) {
                   3844:                         $no_userblock = 1;
                   3845:                         last;
                   3846:                     }
                   3847:                 }
1.490     raeburn  3848:             } else {
                   3849:                 # Resource belongs to current user
                   3850:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3851:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3852:                     $no_ownblock = 1;
                   3853:                     last;
                   3854:                 }
1.474     raeburn  3855:             }
                   3856:         }
                   3857:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3858:         next if (($no_ownblock) &&
1.491     albertel 3859:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3860:         next if ($no_userblock);
1.474     raeburn  3861: 
1.866     kalberla 3862:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3863:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3864:         
                   3865:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3866:         if (($start != 0) && 
                   3867:             (($startblock == 0) || ($startblock > $start))) {
                   3868:             $startblock = $start;
                   3869:         }
                   3870:         if (($end != 0)  &&
                   3871:             (($endblock == 0) || ($endblock < $end))) {
                   3872:             $endblock = $end;
                   3873:         }
1.490     raeburn  3874:     }
                   3875:     return ($startblock,$endblock);
                   3876: }
                   3877: 
                   3878: sub get_blocks {
                   3879:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3880:     my $startblock = 0;
                   3881:     my $endblock = 0;
                   3882:     my $course = $cdom.'_'.$cnum;
                   3883:     $setters->{$course} = {};
                   3884:     $setters->{$course}{'staff'} = [];
                   3885:     $setters->{$course}{'times'} = [];
                   3886:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3887:     foreach my $record (keys(%records)) {
                   3888:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3889:         if ($start <= time && $end >= time) {
                   3890:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3891:                 &parse_block_record($records{$record});
                   3892:             if ($blocks->{$activity} eq 'on') {
                   3893:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3894:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3895:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3896:                     $startblock = $start;
1.490     raeburn  3897:                 }
1.491     albertel 3898:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3899:                     $endblock = $end;
1.474     raeburn  3900:                 }
                   3901:             }
                   3902:         }
                   3903:     }
                   3904:     return ($startblock,$endblock);
                   3905: }
                   3906: 
                   3907: sub parse_block_record {
                   3908:     my ($record) = @_;
                   3909:     my ($setuname,$setudom,$title,$blocks);
                   3910:     if (ref($record) eq 'HASH') {
                   3911:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3912:         $title = &unescape($record->{'event'});
                   3913:         $blocks = $record->{'blocks'};
                   3914:     } else {
                   3915:         my @data = split(/:/,$record,3);
                   3916:         if (scalar(@data) eq 2) {
                   3917:             $title = $data[1];
                   3918:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3919:         } else {
                   3920:             ($setuname,$setudom,$title) = @data;
                   3921:         }
                   3922:         $blocks = { 'com' => 'on' };
                   3923:     }
                   3924:     return ($setuname,$setudom,$title,$blocks);
                   3925: }
                   3926: 
1.854     kalberla 3927: sub blocking_status {
                   3928:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3929:   my %setters;
1.890     droeschl 3930: 
                   3931:   # check for active blocking
1.867     kalberla 3932:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 3933: 
1.890     droeschl 3934:   my $blocked = $startblock && $endblock ? 1 : 0;
                   3935: 
                   3936:   # caller just wants to know whether a block is active
                   3937:   if (!wantarray) { return $blocked; }
                   3938: 
                   3939:   # build a link to a popup window containing the details
                   3940:   my $querystring  = "?activity=$activity";
                   3941:   # $uname and $udom decide whose portfolio the user is trying to look at
                   3942:      $querystring .= "&amp;udom=$udom"      if $udom;
                   3943:      $querystring .= "&amp;uname=$uname"    if $uname;
                   3944: 
                   3945:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 3946:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   3947:         var options = "width=" + w + ",height=" + h + ",";
                   3948:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   3949:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   3950:         var newWin = window.open(url, wdwName, options);
                   3951:         newWin.focus();
                   3952:     }
1.890     droeschl 3953: END_MYBLOCK
1.854     kalberla 3954: 
1.890     droeschl 3955:   $output = Apache::lonhtmlcommon::scripttag($output);
                   3956:   
1.854     kalberla 3957:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 3958:   my $text = mt('Communication Blocked');
                   3959: 
1.867     kalberla 3960:   $output .= <<"END_BLOCK";
                   3961: <div class='LC_comblock'>
1.869     kalberla 3962:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 3963:   title='$text'>
                   3964:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 3965:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 3966:   title='$text'>$text</a>
1.867     kalberla 3967: </div>
                   3968: 
                   3969: END_BLOCK
1.474     raeburn  3970: 
1.854     kalberla 3971:   return ($blocked, $output);
                   3972: }
1.490     raeburn  3973: 
1.60      matthew  3974: ###############################################
                   3975: 
1.682     raeburn  3976: sub check_ip_acc {
                   3977:     my ($acc)=@_;
                   3978:     &Apache::lonxml::debug("acc is $acc");
                   3979:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3980:         return 1;
                   3981:     }
                   3982:     my $allowed=0;
                   3983:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3984: 
                   3985:     my $name;
                   3986:     foreach my $pattern (split(',',$acc)) {
                   3987:         $pattern =~ s/^\s*//;
                   3988:         $pattern =~ s/\s*$//;
                   3989:         if ($pattern =~ /\*$/) {
                   3990:             #35.8.*
                   3991:             $pattern=~s/\*//;
                   3992:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3993:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3994:             #35.8.3.[34-56]
                   3995:             my $low=$2;
                   3996:             my $high=$3;
                   3997:             $pattern=$1;
                   3998:             if ($ip =~ /^\Q$pattern\E/) {
                   3999:                 my $last=(split(/\./,$ip))[3];
                   4000:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4001:             }
                   4002:         } elsif ($pattern =~ /^\*/) {
                   4003:             #*.msu.edu
                   4004:             $pattern=~s/\*//;
                   4005:             if (!defined($name)) {
                   4006:                 use Socket;
                   4007:                 my $netaddr=inet_aton($ip);
                   4008:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4009:             }
                   4010:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4011:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4012:             #127.0.0.1
                   4013:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4014:         } else {
                   4015:             #some.name.com
                   4016:             if (!defined($name)) {
                   4017:                 use Socket;
                   4018:                 my $netaddr=inet_aton($ip);
                   4019:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4020:             }
                   4021:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4022:         }
                   4023:         if ($allowed) { last; }
                   4024:     }
                   4025:     return $allowed;
                   4026: }
                   4027: 
                   4028: ###############################################
                   4029: 
1.60      matthew  4030: =pod
                   4031: 
1.112     bowersj2 4032: =head1 Domain Template Functions
                   4033: 
                   4034: =over 4
                   4035: 
                   4036: =item * &determinedomain()
1.60      matthew  4037: 
                   4038: Inputs: $domain (usually will be undef)
                   4039: 
1.63      www      4040: Returns: Determines which domain should be used for designs
1.60      matthew  4041: 
                   4042: =cut
1.54      www      4043: 
1.60      matthew  4044: ###############################################
1.63      www      4045: sub determinedomain {
                   4046:     my $domain=shift;
1.531     albertel 4047:     if (! $domain) {
1.60      matthew  4048:         # Determine domain if we have not been given one
                   4049:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 4050:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4051:         if ($env{'request.role.domain'}) { 
                   4052:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4053:         }
                   4054:     }
1.63      www      4055:     return $domain;
                   4056: }
                   4057: ###############################################
1.517     raeburn  4058: 
1.518     albertel 4059: sub devalidate_domconfig_cache {
                   4060:     my ($udom)=@_;
                   4061:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4062: }
                   4063: 
                   4064: # ---------------------- Get domain configuration for a domain
                   4065: sub get_domainconf {
                   4066:     my ($udom) = @_;
                   4067:     my $cachetime=1800;
                   4068:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4069:     if (defined($cached)) { return %{$result}; }
                   4070: 
                   4071:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4072: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4073:     my (%designhash,%legacy);
1.518     albertel 4074:     if (keys(%domconfig) > 0) {
                   4075:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4076:             if (keys(%{$domconfig{'login'}})) {
                   4077:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4078:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4079:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4080:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4081:                                 $domconfig{'login'}{$key}{$img};
                   4082:                         }
                   4083:                     } else {
                   4084:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4085:                     }
1.632     raeburn  4086:                 }
                   4087:             } else {
                   4088:                 $legacy{'login'} = 1;
1.518     albertel 4089:             }
1.632     raeburn  4090:         } else {
                   4091:             $legacy{'login'} = 1;
1.518     albertel 4092:         }
                   4093:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4094:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4095:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4096:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4097:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4098:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4099:                         }
1.518     albertel 4100:                     }
                   4101:                 }
1.632     raeburn  4102:             } else {
                   4103:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4104:             }
1.632     raeburn  4105:         } else {
                   4106:             $legacy{'rolecolors'} = 1;
1.518     albertel 4107:         }
1.632     raeburn  4108:         if (keys(%legacy) > 0) {
                   4109:             my %legacyhash = &get_legacy_domconf($udom);
                   4110:             foreach my $item (keys(%legacyhash)) {
                   4111:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4112:                     if ($legacy{'login'}) { 
                   4113:                         $designhash{$item} = $legacyhash{$item};
                   4114:                     }
                   4115:                 } else {
                   4116:                     if ($legacy{'rolecolors'}) {
                   4117:                         $designhash{$item} = $legacyhash{$item};
                   4118:                     }
1.518     albertel 4119:                 }
                   4120:             }
                   4121:         }
1.632     raeburn  4122:     } else {
                   4123:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4124:     }
                   4125:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4126: 				  $cachetime);
                   4127:     return %designhash;
                   4128: }
                   4129: 
1.632     raeburn  4130: sub get_legacy_domconf {
                   4131:     my ($udom) = @_;
                   4132:     my %legacyhash;
                   4133:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4134:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4135:     if (-e $designfile) {
                   4136:         if ( open (my $fh,"<$designfile") ) {
                   4137:             while (my $line = <$fh>) {
                   4138:                 next if ($line =~ /^\#/);
                   4139:                 chomp($line);
                   4140:                 my ($key,$val)=(split(/\=/,$line));
                   4141:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4142:             }
                   4143:             close($fh);
                   4144:         }
                   4145:     }
                   4146:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4147:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4148:     }
                   4149:     return %legacyhash;
                   4150: }
                   4151: 
1.63      www      4152: =pod
                   4153: 
1.112     bowersj2 4154: =item * &domainlogo()
1.63      www      4155: 
                   4156: Inputs: $domain (usually will be undef)
                   4157: 
                   4158: Returns: A link to a domain logo, if the domain logo exists.
                   4159: If the domain logo does not exist, a description of the domain.
                   4160: 
                   4161: =cut
1.112     bowersj2 4162: 
1.63      www      4163: ###############################################
                   4164: sub domainlogo {
1.517     raeburn  4165:     my $domain = &determinedomain(shift);
1.518     albertel 4166:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4167:     # See if there is a logo
                   4168:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4169:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4170:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4171: 	    if ($imgsrc =~ m{^/res/}) {
                   4172: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4173: 		&Apache::lonnet::repcopy($local_name);
                   4174: 	    }
                   4175: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4176:         } 
                   4177:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4178:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4179:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4180:     } else {
1.60      matthew  4181:         return '';
1.59      www      4182:     }
                   4183: }
1.63      www      4184: ##############################################
                   4185: 
                   4186: =pod
                   4187: 
1.112     bowersj2 4188: =item * &designparm()
1.63      www      4189: 
                   4190: Inputs: $which parameter; $domain (usually will be undef)
                   4191: 
                   4192: Returns: value of designparamter $which
                   4193: 
                   4194: =cut
1.112     bowersj2 4195: 
1.397     albertel 4196: 
1.400     albertel 4197: ##############################################
1.397     albertel 4198: sub designparm {
                   4199:     my ($which,$domain)=@_;
                   4200:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4201:         return $env{'environment.color.'.$which};
1.96      www      4202:     }
1.63      www      4203:     $domain=&determinedomain($domain);
1.518     albertel 4204:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4205:     my $output;
1.517     raeburn  4206:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4207:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4208:     } else {
1.520     raeburn  4209:         $output = $defaultdesign{$which};
                   4210:     }
                   4211:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4212:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4213:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4214:             if ($output =~ m{^/res/}) {
                   4215:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4216:                 &Apache::lonnet::repcopy($local_name);
                   4217:             }
1.520     raeburn  4218:             $output = &lonhttpdurl($output);
                   4219:         }
1.63      www      4220:     }
1.520     raeburn  4221:     return $output;
1.63      www      4222: }
1.59      www      4223: 
1.822     bisitz   4224: ##############################################
                   4225: =pod
                   4226: 
1.832     bisitz   4227: =item * &authorspace()
                   4228: 
                   4229: Inputs: ./.
                   4230: 
                   4231: Returns: Path to the Construction Space of the current user's
                   4232:          accessed author space
                   4233:          The author space will be that of the current user
                   4234:          when accessing the own author space
                   4235:          and that of the co-author/assistent co-author
                   4236:          when accessing the co-author's/assistent co-author's
                   4237:          space
                   4238: 
                   4239: =cut
                   4240: 
                   4241: sub authorspace {
                   4242:     my $caname = '';
                   4243:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4244:         (undef,$caname) =
                   4245:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4246:     } else {
                   4247:         $caname = $env{'user.name'};
                   4248:     }
                   4249:     return '/priv/'.$caname.'/';
                   4250: }
                   4251: 
                   4252: ##############################################
                   4253: =pod
                   4254: 
1.822     bisitz   4255: =item * &head_subbox()
                   4256: 
                   4257: Inputs: $content (contains HTML code with page functions, etc.)
                   4258: 
                   4259: Returns: HTML div with $content
                   4260:          To be included in page header
                   4261: 
                   4262: =cut
                   4263: 
                   4264: sub head_subbox {
                   4265:     my ($content)=@_;
                   4266:     my $output =
1.844     bisitz   4267:         '<div id="LC_head_subbox">'
1.822     bisitz   4268:        .$content
                   4269:        .'</div>'
                   4270: }
                   4271: 
                   4272: ##############################################
                   4273: =pod
                   4274: 
                   4275: =item * &CSTR_pageheader()
                   4276: 
                   4277: Inputs: ./.
                   4278: 
                   4279: Returns: HTML div with CSTR path and recent box
                   4280:          To be included on Construction Space pages
                   4281: 
                   4282: =cut
                   4283: 
                   4284: sub CSTR_pageheader {
                   4285:     # this is for resources; directories have customtitle, and crumbs
                   4286:             # and select recent are created in lonpubdir.pm  
                   4287:     my ($uname,$thisdisfn)=
                   4288:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4289:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4290:     $formaction=~s/\/+/\//g;
                   4291: 
                   4292:     my $parentpath = '';
                   4293:     my $lastitem = '';
                   4294:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4295:         $parentpath = $1;
                   4296:         $lastitem = $2;
                   4297:     } else {
                   4298:         $lastitem = $thisdisfn;
                   4299:     }
                   4300:     return
                   4301:          '<div>'
                   4302:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4303:         .'<b>'.&mt('Construction Space:').'</b> '
                   4304:         .'<form name="dirs" method="post" action="'.$formaction
                   4305:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4306:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4307:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4308:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4309:         .'</form>'
                   4310:         .&Apache::lonmenu::constspaceform()
                   4311:         .'</div>';
                   4312: }
                   4313: 
1.60      matthew  4314: ###############################################
                   4315: ###############################################
                   4316: 
                   4317: =pod
                   4318: 
1.112     bowersj2 4319: =back
                   4320: 
1.549     albertel 4321: =head1 HTML Helpers
1.112     bowersj2 4322: 
                   4323: =over 4
                   4324: 
                   4325: =item * &bodytag()
1.60      matthew  4326: 
                   4327: Returns a uniform header for LON-CAPA web pages.
                   4328: 
                   4329: Inputs: 
                   4330: 
1.112     bowersj2 4331: =over 4
                   4332: 
                   4333: =item * $title, A title to be displayed on the page.
                   4334: 
                   4335: =item * $function, the current role (can be undef).
                   4336: 
                   4337: =item * $addentries, extra parameters for the <body> tag.
                   4338: 
                   4339: =item * $bodyonly, if defined, only return the <body> tag.
                   4340: 
                   4341: =item * $domain, if defined, force a given domain.
                   4342: 
                   4343: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4344:             text interface only)
1.60      matthew  4345: 
1.814     bisitz   4346: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4347:                      navigational links
1.317     albertel 4348: 
1.338     albertel 4349: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4350: 
1.361     albertel 4351: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4352:          'Switch To Inline Menu' link
                   4353: 
1.460     albertel 4354: =item * $args, optional argument valid values are
                   4355:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4356:             inherit_jsmath -> when creating popup window in a page,
                   4357:                               should it have jsmath forced on by the
                   4358:                               current page
1.460     albertel 4359: 
1.112     bowersj2 4360: =back
                   4361: 
1.60      matthew  4362: Returns: A uniform header for LON-CAPA web pages.  
                   4363: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4364: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4365: other decorations will be returned.
                   4366: 
                   4367: =cut
                   4368: 
1.54      www      4369: sub bodytag {
1.831     bisitz   4370:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4371:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4372: 
1.460     albertel 4373:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4374: 
1.183     matthew  4375:     $function = &get_users_function() if (!$function);
1.339     albertel 4376:     my $img =    &designparm($function.'.img',$domain);
                   4377:     my $font =   &designparm($function.'.font',$domain);
                   4378:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4379: 
1.803     bisitz   4380:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4381: 		   'bgcolor' => $pgbg,
1.339     albertel 4382: 		   'text'    => $font,
                   4383:                    'alink'   => &designparm($function.'.alink',$domain),
                   4384: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4385: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4386:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4387: 
1.63      www      4388:  # role and realm
1.378     raeburn  4389:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4390:     if ($role  eq 'ca') {
1.479     albertel 4391:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4392:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4393:     } 
1.55      www      4394: # realm
1.258     albertel 4395:     if ($env{'request.course.id'}) {
1.378     raeburn  4396:         if ($env{'request.role'} !~ /^cr/) {
                   4397:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4398:         }
1.359     albertel 4399: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4400:     } else {
                   4401:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4402:     }
1.433     albertel 4403: 
1.359     albertel 4404:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4405: # Set messages
1.60      matthew  4406:     my $messages=&domainlogo($domain);
1.330     albertel 4407: 
1.438     albertel 4408:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4409: 
1.101     www      4410: # construct main body tag
1.359     albertel 4411:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4412: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4413: 
1.530     albertel 4414:     if ($bodyonly) {
1.60      matthew  4415:         return $bodytag;
1.798     tempelho 4416:     } 
1.359     albertel 4417: 
1.410     albertel 4418:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4419:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4420: 	undef($role);
1.434     albertel 4421:     } else {
                   4422: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4423:     }
1.359     albertel 4424:     
1.762     bisitz   4425:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4426:     #
                   4427:     # Extra info if you are the DC
                   4428:     my $dc_info = '';
                   4429:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4430:                         $env{'course.'.$env{'request.course.id'}.
                   4431:                                  '.domain'}.'/'})) {
                   4432:         my $cid = $env{'request.course.id'};
                   4433:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4434:         $dc_info =~ s/\s+$//;
1.359     albertel 4435:         $dc_info = '('.$dc_info.')';
                   4436:     }
                   4437: 
1.853     droeschl 4438:     $role = "($role)" if $role;
                   4439:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4440: 
1.837     bisitz   4441:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4442:         # No Remote
1.258     albertel 4443: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4444: 	    $forcereg=1;
                   4445: 	}
                   4446: 
1.836     bisitz   4447: #    if ($env{'request.state'} eq 'construct') {
                   4448: #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4449: #    }
1.359     albertel 4450: 
1.816     bisitz   4451:         my $titletable = '<table id="LC_title_bar">'
1.836     bisitz   4452:                         ."<tr><td> $titleinfo $dc_info</td>"
1.816     bisitz   4453:                         .'</tr></table>';
                   4454: 
1.814     bisitz   4455: 	if ($no_nav_bar) {
1.359     albertel 4456: 	    $bodytag .= $titletable;
                   4457: 	} else {
1.852     droeschl 4458:         $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4459:             <em>$realm</em> $dc_info</div>| unless $env{'form.inhibitmenu'};
                   4460: 
1.359     albertel 4461: 	    if ($env{'request.state'} eq 'construct') {
1.863     droeschl 4462:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$titletable);
1.272     raeburn  4463:             } else {
1.863     droeschl 4464:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg).$titletable;
1.272     raeburn  4465:             }
1.235     raeburn  4466:         }
                   4467:         return $bodytag;
1.94      www      4468:     }
1.95      www      4469: 
1.93      www      4470: #
1.95      www      4471: # Top frame rendering, Remote is up
1.93      www      4472: #
1.359     albertel 4473: 
1.517     raeburn  4474:     my $imgsrc = $img;
                   4475:     if ($img =~ /^\/adm/) {
1.575     albertel 4476:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4477:     }
                   4478:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4479: 
1.305     www      4480:     # Explicit link to get inline menu
1.361     albertel 4481:     my $menu= ($no_inline_link?''
1.883     droeschl 4482: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.853     droeschl 4483:     $bodytag .= qq|<div id="LC_nav_bar">$name $role
                   4484:             <em>$realm</em> $dc_info </div>
                   4485:             <ol class="LC_smallMenu LC_right">
                   4486:                 <li>$menu</li>
                   4487:             </ol>| unless $env{'form.inhibitmenu'};
1.245     matthew  4488:     #
1.94      www      4489:     return(<<ENDBODY);
1.60      matthew  4490: $bodytag
1.359     albertel 4491: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4492: <tr><td>$upperleft</td>
                   4493:     <td>$messages&nbsp;</td>
1.54      www      4494: </tr>
1.359     albertel 4495: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4496: </tr>
1.356     albertel 4497: </table>
1.54      www      4498: ENDBODY
1.182     matthew  4499: }
                   4500: 
1.330     albertel 4501: sub make_attr_string {
                   4502:     my ($register,$attr_ref) = @_;
                   4503: 
                   4504:     if ($attr_ref && !ref($attr_ref)) {
                   4505: 	die("addentries Must be a hash ref ".
                   4506: 	    join(':',caller(1))." ".
                   4507: 	    join(':',caller(0))." ");
                   4508:     }
                   4509: 
                   4510:     if ($register) {
1.339     albertel 4511: 	my ($on_load,$on_unload);
                   4512: 	foreach my $key (keys(%{$attr_ref})) {
                   4513: 	    if      (lc($key) eq 'onload') {
                   4514: 		$on_load.=$attr_ref->{$key}.';';
                   4515: 		delete($attr_ref->{$key});
                   4516: 
                   4517: 	    } elsif (lc($key) eq 'onunload') {
                   4518: 		$on_unload.=$attr_ref->{$key}.';';
                   4519: 		delete($attr_ref->{$key});
                   4520: 	    }
                   4521: 	}
                   4522: 	$attr_ref->{'onload'}  =
                   4523: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4524: 	$attr_ref->{'onunload'}=
                   4525: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4526:     }
                   4527: 
                   4528: # Accessibility font enhance
                   4529:     if ($env{'browser.fontenhance'} eq 'on') {
                   4530: 	my $style;
                   4531: 	foreach my $key (keys(%{$attr_ref})) {
                   4532: 	    if (lc($key) eq 'style') {
                   4533: 		$style.=$attr_ref->{$key}.';';
                   4534: 		delete($attr_ref->{$key});
                   4535: 	    }
                   4536: 	}
                   4537: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4538:     }
1.339     albertel 4539: 
1.330     albertel 4540:     my $attr_string;
                   4541:     foreach my $attr (keys(%$attr_ref)) {
                   4542: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4543:     }
                   4544:     return $attr_string;
                   4545: }
                   4546: 
                   4547: 
1.182     matthew  4548: ###############################################
1.251     albertel 4549: ###############################################
                   4550: 
                   4551: =pod
                   4552: 
                   4553: =item * &endbodytag()
                   4554: 
                   4555: Returns a uniform footer for LON-CAPA web pages.
                   4556: 
1.635     raeburn  4557: Inputs: 1 - optional reference to an args hash
                   4558: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4559: a 'Continue' link is not displayed if the page contains an
                   4560: internal redirect in the <head></head> section,
                   4561: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4562: 
                   4563: =cut
                   4564: 
                   4565: sub endbodytag {
1.635     raeburn  4566:     my ($args) = @_;
1.251     albertel 4567:     my $endbodytag='</body>';
1.269     albertel 4568:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4569:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4570:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4571: 	    $endbodytag=
                   4572: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4573: 	        &mt('Continue').'</a>'.
                   4574: 	        $endbodytag;
                   4575:         }
1.315     albertel 4576:     }
1.251     albertel 4577:     return $endbodytag;
                   4578: }
                   4579: 
1.352     albertel 4580: =pod
                   4581: 
                   4582: =item * &standard_css()
                   4583: 
                   4584: Returns a style sheet
                   4585: 
                   4586: Inputs: (all optional)
                   4587:             domain         -> force to color decorate a page for a specific
                   4588:                                domain
                   4589:             function       -> force usage of a specific rolish color scheme
                   4590:             bgcolor        -> override the default page bgcolor
                   4591: 
                   4592: =cut
                   4593: 
1.343     albertel 4594: sub standard_css {
1.345     albertel 4595:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4596:     $function  = &get_users_function() if (!$function);
                   4597:     my $img    = &designparm($function.'.img',   $domain);
                   4598:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4599:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4600:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4601: #second colour for later usage
1.345     albertel 4602:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4603:     my $pgbg_or_bgcolor =
                   4604: 	         $bgcolor ||
1.352     albertel 4605: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4606:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4607:     my $alink  = &designparm($function.'.alink', $domain);
                   4608:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4609:     my $link   = &designparm($function.'.link',  $domain);
                   4610: 
1.704     muellerd 4611:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4612:     my $bgcol = &designparm('login.bgcol',$domain);
                   4613:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4614: 
1.602     albertel 4615:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4616:     my $mono                 = 'monospace';
1.850     bisitz   4617:     my $data_table_head      = $sidebg;
                   4618:     my $data_table_light     = '#FAFAFA';
                   4619:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4620:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4621:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4622:     my $mail_new             = '#FFBB77';
                   4623:     my $mail_new_hover       = '#DD9955';
                   4624:     my $mail_read            = '#BBBB77';
                   4625:     my $mail_read_hover      = '#999944';
                   4626:     my $mail_replied         = '#AAAA88';
                   4627:     my $mail_replied_hover   = '#888855';
                   4628:     my $mail_other           = '#99BBBB';
                   4629:     my $mail_other_hover     = '#669999';
1.391     albertel 4630:     my $table_header         = '#DDDDDD';
1.489     raeburn  4631:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4632:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4633: 
1.608     albertel 4634:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4635: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4636: 	                                                 : '0 3px 0 4px';
1.448     albertel 4637: 
1.523     albertel 4638: 
1.343     albertel 4639:     return <<END;
1.795     www      4640: body {
                   4641:    font-family: $sans;
                   4642:    line-height:130%;
                   4643:    font-size:0.83em;
                   4644:    color:$font;
                   4645: }
                   4646: 
                   4647: a:link, a:visited { 
                   4648:   font-size:100%; 
                   4649: }
                   4650: 
                   4651: a:focus { 
                   4652:   color: red;
                   4653:   background: yellow 
                   4654: }
1.698     harmsja  4655: 
1.795     www      4656: form, .inline { 
                   4657:    display: inline; 
                   4658: }
1.721     harmsja  4659: 
1.795     www      4660: .LC_right {
                   4661:    text-align:right;
                   4662: }
                   4663: 
                   4664: .LC_middle {
                   4665:    vertical-align:middle;
                   4666: }
1.721     harmsja  4667: 
                   4668: /* just for tests */
1.754     droeschl 4669: .LC_400Box {width:400px; }
1.721     harmsja  4670: /* end */
                   4671: 
1.778     bisitz   4672: .LC_filename {
                   4673:   font-family: $mono;
                   4674:   white-space:pre;
                   4675: }
                   4676: 
                   4677: .LC_fileicon {
                   4678:   border: none;
                   4679:   height: 1.3em;
                   4680:   vertical-align: text-bottom;
                   4681:   margin-right: 0.3em;
                   4682:   text-decoration:none;
                   4683: }
                   4684: 
1.350     albertel 4685: .LC_error {
                   4686:   color: red;
                   4687:   font-size: larger;
                   4688: }
1.795     www      4689: 
1.457     albertel 4690: .LC_warning,
                   4691: .LC_diff_removed {
1.733     bisitz   4692:   color: red;
1.394     albertel 4693: }
1.532     albertel 4694: 
                   4695: .LC_info,
1.457     albertel 4696: .LC_success,
                   4697: .LC_diff_added {
1.350     albertel 4698:   color: green;
                   4699: }
1.795     www      4700: 
1.802     bisitz   4701: div.LC_confirm_box {
                   4702:   background-color: #FAFAFA;
                   4703:   border: 1px solid $lg_border_color;
                   4704:   margin-right: 0;
                   4705:   padding: 5px;
                   4706: }
                   4707: 
                   4708: div.LC_confirm_box .LC_error img,
                   4709: div.LC_confirm_box .LC_success img {
                   4710:   vertical-align: middle;
                   4711: }
                   4712: 
1.440     albertel 4713: .LC_icon {
1.771     droeschl 4714:   border: none;
1.790     droeschl 4715:   vertical-align: middle;
1.771     droeschl 4716: }
                   4717: 
1.543     albertel 4718: .LC_docs_spacer {
                   4719:   width: 25px;
                   4720:   height: 1px;
1.771     droeschl 4721:   border: none;
1.543     albertel 4722: }
1.346     albertel 4723: 
1.532     albertel 4724: .LC_internal_info {
1.735     bisitz   4725:   color: #999999;
1.532     albertel 4726: }
                   4727: 
1.794     www      4728: .LC_discussion {
                   4729:    background: $tabbg;
                   4730:    border: 1px solid black;
                   4731:    margin: 2px;
                   4732: }
                   4733: 
                   4734: .LC_disc_action_links_bar {
                   4735:    background: $tabbg;
1.803     bisitz   4736:    border: none;
1.795     www      4737:    margin: 4px;
1.794     www      4738: }
                   4739: 
                   4740: .LC_disc_action_left {
                   4741:    text-align: left;
                   4742: }
                   4743: 
                   4744: .LC_disc_action_right {
                   4745:    text-align: right;
                   4746: }
                   4747: 
                   4748: .LC_disc_new_item {
                   4749:    background: white;
                   4750:    border: 2px solid red;
                   4751:    margin: 2px;
                   4752: }
                   4753: 
                   4754: .LC_disc_old_item {
                   4755:    background: white;
                   4756:    border: 1px solid black;
                   4757:    margin: 2px;
                   4758: }
                   4759: 
1.458     albertel 4760: table.LC_pastsubmission {
                   4761:   border: 1px solid black;
                   4762:   margin: 2px;
                   4763: }
                   4764: 
1.795     www      4765: table#LC_top_nav,
                   4766: table#LC_menubuttons,
                   4767: table#LC_nav_location {
1.345     albertel 4768:   width: 100%;
                   4769:   background: $pgbg;
1.392     albertel 4770:   border: 2px;
1.402     albertel 4771:   border-collapse: separate;
1.803     bisitz   4772:   padding: 0;
1.345     albertel 4773: }
1.392     albertel 4774: 
1.801     tempelho 4775: table#LC_title_bar a {
                   4776:   color: $fontmenu;
                   4777: }
1.836     bisitz   4778: 
1.807     droeschl 4779: table#LC_title_bar {
1.819     tempelho 4780:   clear: both;
1.836     bisitz   4781:   display: none;
1.807     droeschl 4782: }
                   4783: 
1.795     www      4784: table#LC_title_bar,
                   4785: table.LC_breadcrumbs,
1.393     albertel 4786: table#LC_title_bar.LC_with_remote {
1.359     albertel 4787:   width: 100%;
1.392     albertel 4788:   border-color: $pgbg;
                   4789:   border-style: solid;
                   4790:   border-width: $border;
1.379     albertel 4791:   background: $pgbg;
1.801     tempelho 4792:   color: $fontmenu;
1.392     albertel 4793:   border-collapse: collapse;
1.803     bisitz   4794:   padding: 0;
1.819     tempelho 4795:   margin: 0;
1.359     albertel 4796: }
1.795     www      4797: 
1.359     albertel 4798: table#LC_title_bar td {
                   4799:   background: $tabbg;
                   4800: }
1.795     www      4801: 
1.706     harmsja  4802: table#LC_menubuttons img{
1.803     bisitz   4803:   border: none;
1.346     albertel 4804: }
1.795     www      4805: 
1.345     albertel 4806: table#LC_top_nav td {
                   4807:   background: $tabbg;
1.803     bisitz   4808:   border: none;
1.407     albertel 4809:   font-size: small;
1.706     harmsja  4810:   vertical-align:top;
                   4811:   padding:2px 5px 2px 5px;
1.345     albertel 4812: }
1.795     www      4813: 
                   4814: table#LC_top_nav td a,
                   4815: div#LC_top_nav a {
1.345     albertel 4816:   color: $font;
                   4817: }
1.795     www      4818: 
1.364     albertel 4819: table#LC_top_nav td.LC_top_nav_logo {
                   4820:   background: $tabbg;
1.432     albertel 4821:   text-align: left;
1.408     albertel 4822:   white-space: nowrap;
1.432     albertel 4823:   width: 31px;
1.408     albertel 4824: }
1.795     www      4825: 
1.408     albertel 4826: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4827:   border: none;
1.408     albertel 4828:   vertical-align: bottom;
1.364     albertel 4829: }
1.795     www      4830: 
1.777     tempelho 4831: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4832: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4833:   width: 2.0em;
                   4834: }
1.795     www      4835: 
1.442     albertel 4836: table#LC_top_nav td.LC_top_nav_login {
                   4837:   width: 4.0em;
                   4838:   text-align: center;
                   4839: }
1.795     www      4840: 
1.842     droeschl 4841: .LC_breadcrumbs_component {
                   4842:     float: right;
                   4843:     margin: 0 1em;
1.357     albertel 4844: }
1.842     droeschl 4845: .LC_breadcrumbs_component img {
                   4846:     vertical-align: middle;
1.777     tempelho 4847: }
1.795     www      4848: 
1.383     albertel 4849: td.LC_table_cell_checkbox {
                   4850:   text-align: center;
                   4851: }
1.795     www      4852: 
1.779     bisitz   4853: table#LC_mainmenu td.LC_mainmenu_column {
                   4854:     vertical-align: top;
1.777     tempelho 4855: }
1.522     albertel 4856: 
1.795     www      4857: .LC_fontsize_small {
1.705     tempelho 4858:  font-size: 70%;
                   4859: }
                   4860: 
1.844     bisitz   4861: #LC_breadcrumbs {
1.819     tempelho 4862:  clear:both;
                   4863:  background: $sidebg;
1.822     bisitz   4864:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4865:  line-height: 32px; 
1.822     bisitz   4866:  margin: 0;
1.819     tempelho 4867:  padding: 0;
                   4868: }
1.862     bisitz   4869: 
1.839     droeschl 4870: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   4871: #LC_remote #LC_breadcrumbs {
1.839     droeschl 4872:     display:none;
                   4873: }
1.819     tempelho 4874: 
1.844     bisitz   4875: #LC_head_subbox {
1.822     bisitz   4876:  clear:both;
                   4877:  background: #F8F8F8; /* $sidebg; */
                   4878:  border-bottom: 1px solid $lg_border_color;
                   4879:  margin: 0 0 10px 0;
                   4880:  padding: 5px;
                   4881: }
                   4882: 
1.795     www      4883: .LC_fontsize_medium {
1.705     tempelho 4884:  font-size: 85%;
                   4885: }
                   4886: 
1.795     www      4887: .LC_fontsize_large {
1.705     tempelho 4888:  font-size: 120%;
                   4889: }
                   4890: 
1.346     albertel 4891: .LC_menubuttons_inline_text {
                   4892:   color: $font;
1.698     harmsja  4893:   font-size: 90%;
1.701     harmsja  4894:   padding-left:3px;
1.346     albertel 4895: }
                   4896: 
1.526     www      4897: .LC_menubuttons_link {
                   4898:   text-decoration: none;
                   4899: }
1.795     www      4900: 
1.522     albertel 4901: .LC_menubuttons_category {
1.521     www      4902:   color: $font;
1.526     www      4903:   background: $pgbg;
1.521     www      4904:   font-size: larger;
                   4905:   font-weight: bold;
                   4906: }
                   4907: 
1.346     albertel 4908: td.LC_menubuttons_text {
1.779     bisitz   4909:  	color: $font;
1.346     albertel 4910: }
1.706     harmsja  4911: 
1.346     albertel 4912: .LC_current_location {
                   4913:   background: $tabbg;
                   4914: }
1.795     www      4915: 
1.346     albertel 4916: .LC_new_mail {
1.634     www      4917:   background: $tabbg;
1.346     albertel 4918:   font-weight: bold;
                   4919: }
1.347     albertel 4920: 
1.795     www      4921: table.LC_data_table,
                   4922: table.LC_mail_list {
1.347     albertel 4923:   border: 1px solid #000000;
1.402     albertel 4924:   border-collapse: separate;
1.426     albertel 4925:   border-spacing: 1px;
1.610     albertel 4926:   background: $pgbg;
1.347     albertel 4927: }
1.795     www      4928: 
1.422     albertel 4929: .LC_data_table_dense {
                   4930:   font-size: small;
                   4931: }
1.795     www      4932: 
1.507     raeburn  4933: table.LC_nested_outer {
                   4934:   border: 1px solid #000000;
1.589     raeburn  4935:   border-collapse: collapse;
1.803     bisitz   4936:   border-spacing: 0;
1.507     raeburn  4937:   width: 100%;
                   4938: }
1.795     www      4939: 
1.879     raeburn  4940: table.LC_innerpickbox,
1.507     raeburn  4941: table.LC_nested {
1.803     bisitz   4942:   border: none;
1.589     raeburn  4943:   border-collapse: collapse;
1.803     bisitz   4944:   border-spacing: 0;
1.507     raeburn  4945:   width: 100%;
                   4946: }
1.795     www      4947: 
                   4948: table.LC_data_table tr th, 
                   4949: table.LC_calendar tr th, 
                   4950: table.LC_mail_list tr th,
1.879     raeburn  4951: table.LC_prior_tries tr th,
                   4952: table.LC_innerpickbox tr th {
1.349     albertel 4953:   font-weight: bold;
                   4954:   background-color: $data_table_head;
1.801     tempelho 4955:   color:$fontmenu;
1.701     harmsja  4956:   font-size:90%;
1.347     albertel 4957: }
1.795     www      4958: 
1.879     raeburn  4959: table.LC_innerpickbox tr th,
                   4960: table.LC_innerpickbox tr td {
                   4961:   vertical-align: top;
                   4962: }
                   4963: 
1.711     raeburn  4964: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4965:   background-color: #CCCCCC;
1.711     raeburn  4966:   font-weight: bold;
                   4967:   text-align: left;
                   4968: }
1.795     www      4969: 
1.779     bisitz   4970: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4971: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4972:   background-color: $data_table_light;
1.425     albertel 4973:   padding: 2px;
1.347     albertel 4974: }
1.795     www      4975: 
1.610     albertel 4976: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4977: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4978:   background-color: $data_table_dark;
1.709     bisitz   4979:   padding: 2px;
1.347     albertel 4980: }
1.795     www      4981: 
1.425     albertel 4982: table.LC_data_table tr.LC_data_table_highlight td {
                   4983:   background-color: $data_table_darker;
                   4984: }
1.795     www      4985: 
1.639     raeburn  4986: table.LC_data_table tr td.LC_leftcol_header {
                   4987:   background-color: $data_table_head;
                   4988:   font-weight: bold;
                   4989: }
1.795     www      4990: 
1.451     albertel 4991: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4992: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4993:   background-color: #FFFFFF;
1.421     albertel 4994:   font-weight: bold;
                   4995:   font-style: italic;
                   4996:   text-align: center;
                   4997:   padding: 8px;
1.347     albertel 4998: }
1.795     www      4999: 
1.890     droeschl 5000: table.LC_caption {
                   5001: }
                   5002: 
1.507     raeburn  5003: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5004:   padding: 4ex
                   5005: }
1.795     www      5006: 
1.507     raeburn  5007: table.LC_nested_outer tr th {
                   5008:   font-weight: bold;
1.801     tempelho 5009:   color:$fontmenu;
1.507     raeburn  5010:   background-color: $data_table_head;
1.701     harmsja  5011:   font-size: small;
1.507     raeburn  5012:   border-bottom: 1px solid #000000;
                   5013: }
1.795     www      5014: 
1.507     raeburn  5015: table.LC_nested_outer tr td.LC_subheader {
                   5016:   background-color: $data_table_head;
                   5017:   font-weight: bold;
                   5018:   font-size: small;
                   5019:   border-bottom: 1px solid #000000;
                   5020:   text-align: right;
1.451     albertel 5021: }
1.795     www      5022: 
1.507     raeburn  5023: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5024:   background-color: #CCCCCC;
1.451     albertel 5025:   font-weight: bold;
                   5026:   font-size: small;
1.507     raeburn  5027:   text-align: center;
                   5028: }
1.795     www      5029: 
1.589     raeburn  5030: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5031: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5032:   text-align: left;
1.451     albertel 5033: }
1.795     www      5034: 
1.507     raeburn  5035: table.LC_nested td {
1.735     bisitz   5036:   background-color: #FFFFFF;
1.451     albertel 5037:   font-size: small;
1.507     raeburn  5038: }
1.795     www      5039: 
1.507     raeburn  5040: table.LC_nested_outer tr th.LC_right_item,
                   5041: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5042: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5043: table.LC_nested tr td.LC_right_item {
1.451     albertel 5044:   text-align: right;
                   5045: }
                   5046: 
1.507     raeburn  5047: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5048:   background-color: #EEEEEE;
1.451     albertel 5049: }
                   5050: 
1.473     raeburn  5051: table.LC_createuser {
                   5052: }
                   5053: 
                   5054: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5055:   font-size: small;
1.473     raeburn  5056: }
                   5057: 
                   5058: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5059:   background-color: #CCCCCC;
1.473     raeburn  5060:   font-weight: bold;
                   5061:   text-align: center;
                   5062: }
                   5063: 
1.349     albertel 5064: table.LC_calendar {
                   5065:   border: 1px solid #000000;
                   5066:   border-collapse: collapse;
                   5067: }
1.795     www      5068: 
1.349     albertel 5069: table.LC_calendar_pickdate {
                   5070:   font-size: xx-small;
                   5071: }
1.795     www      5072: 
1.349     albertel 5073: table.LC_calendar tr td {
                   5074:   border: 1px solid #000000;
                   5075:   vertical-align: top;
                   5076: }
1.795     www      5077: 
1.349     albertel 5078: table.LC_calendar tr td.LC_calendar_day_empty {
                   5079:   background-color: $data_table_dark;
                   5080: }
1.795     www      5081: 
1.779     bisitz   5082: table.LC_calendar tr td.LC_calendar_day_current {
                   5083:   background-color: $data_table_highlight;
1.777     tempelho 5084: }
1.795     www      5085: 
1.349     albertel 5086: table.LC_mail_list tr.LC_mail_new {
                   5087:   background-color: $mail_new;
                   5088: }
1.795     www      5089: 
1.349     albertel 5090: table.LC_mail_list tr.LC_mail_new:hover {
                   5091:   background-color: $mail_new_hover;
                   5092: }
1.795     www      5093: 
                   5094: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5095: }
1.795     www      5096: 
                   5097: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5098: }
1.795     www      5099: 
1.349     albertel 5100: table.LC_mail_list tr.LC_mail_read {
                   5101:   background-color: $mail_read;
                   5102: }
1.795     www      5103: 
1.349     albertel 5104: table.LC_mail_list tr.LC_mail_read:hover {
                   5105:   background-color: $mail_read_hover;
                   5106: }
1.795     www      5107: 
1.349     albertel 5108: table.LC_mail_list tr.LC_mail_replied {
                   5109:   background-color: $mail_replied;
                   5110: }
1.795     www      5111: 
1.349     albertel 5112: table.LC_mail_list tr.LC_mail_replied:hover {
                   5113:   background-color: $mail_replied_hover;
                   5114: }
1.795     www      5115: 
1.349     albertel 5116: table.LC_mail_list tr.LC_mail_other {
                   5117:   background-color: $mail_other;
                   5118: }
1.795     www      5119: 
1.349     albertel 5120: table.LC_mail_list tr.LC_mail_other:hover {
                   5121:   background-color: $mail_other_hover;
                   5122: }
1.494     raeburn  5123: 
1.777     tempelho 5124: table.LC_data_table tr > td.LC_browser_file,
                   5125: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5126:   background: #CCFF88;
                   5127: }
1.795     www      5128: 
1.777     tempelho 5129: table.LC_data_table tr > td.LC_browser_file_locked,
                   5130: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5131:   background: #FFAA99;
1.387     albertel 5132: }
1.795     www      5133: 
1.777     tempelho 5134: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5135:   background: #AAAAAA;
                   5136: }
1.795     www      5137: 
1.777     tempelho 5138: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5139: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5140:   background: #FFFF77;
1.777     tempelho 5141: }
1.795     www      5142: 
1.696     bisitz   5143: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5144:   background: #CCCCFF;
1.387     albertel 5145: }
1.696     bisitz   5146: 
1.707     bisitz   5147: table.LC_data_table tr > td.LC_roles_is {
                   5148: /*  background: #77FF77; */
                   5149: }
1.795     www      5150: 
1.707     bisitz   5151: table.LC_data_table tr > td.LC_roles_future {
                   5152:   background: #FFFF77;
                   5153: }
1.795     www      5154: 
1.707     bisitz   5155: table.LC_data_table tr > td.LC_roles_will {
                   5156:   background: #FFAA77;
                   5157: }
1.795     www      5158: 
1.707     bisitz   5159: table.LC_data_table tr > td.LC_roles_expired {
                   5160:   background: #FF7777;
                   5161: }
1.795     www      5162: 
1.707     bisitz   5163: table.LC_data_table tr > td.LC_roles_will_not {
                   5164:   background: #AAFF77;
                   5165: }
1.795     www      5166: 
1.707     bisitz   5167: table.LC_data_table tr > td.LC_roles_selected {
                   5168:   background: #11CC55;
                   5169: }
                   5170: 
1.388     albertel 5171: span.LC_current_location {
1.701     harmsja  5172:   font-size:larger;
1.388     albertel 5173:   background: $pgbg;
                   5174: }
1.387     albertel 5175: 
1.395     albertel 5176: span.LC_parm_menu_item {
                   5177:   font-size: larger;
                   5178: }
1.795     www      5179: 
1.395     albertel 5180: span.LC_parm_scope_all {
                   5181:   color: red;
                   5182: }
1.795     www      5183: 
1.395     albertel 5184: span.LC_parm_scope_folder {
                   5185:   color: green;
                   5186: }
1.795     www      5187: 
1.395     albertel 5188: span.LC_parm_scope_resource {
                   5189:   color: orange;
                   5190: }
1.795     www      5191: 
1.395     albertel 5192: span.LC_parm_part {
                   5193:   color: blue;
                   5194: }
1.795     www      5195: 
1.395     albertel 5196: span.LC_parm_folder, span.LC_parm_symb {
                   5197:   font-size: x-small;
                   5198:   font-family: $mono;
                   5199:   color: #AAAAAA;
                   5200: }
                   5201: 
1.795     www      5202: td.LC_parm_overview_level_menu,
                   5203: td.LC_parm_overview_map_menu,
                   5204: td.LC_parm_overview_parm_selectors,
                   5205: td.LC_parm_overview_restrictions  {
1.396     albertel 5206:   border: 1px solid black;
                   5207:   border-collapse: collapse;
                   5208: }
1.795     www      5209: 
1.396     albertel 5210: table.LC_parm_overview_restrictions td {
                   5211:   border-width: 1px 4px 1px 4px;
                   5212:   border-style: solid;
                   5213:   border-color: $pgbg;
                   5214:   text-align: center;
                   5215: }
1.795     www      5216: 
1.396     albertel 5217: table.LC_parm_overview_restrictions th {
                   5218:   background: $tabbg;
                   5219:   border-width: 1px 4px 1px 4px;
                   5220:   border-style: solid;
                   5221:   border-color: $pgbg;
                   5222: }
1.795     www      5223: 
1.398     albertel 5224: table#LC_helpmenu {
1.803     bisitz   5225:   border: none;
1.398     albertel 5226:   height: 55px;
1.803     bisitz   5227:   border-spacing: 0;
1.398     albertel 5228: }
                   5229: 
                   5230: table#LC_helpmenu fieldset legend {
                   5231:   font-size: larger;
                   5232: }
1.795     www      5233: 
1.397     albertel 5234: table#LC_helpmenu_links {
                   5235:   width: 100%;
                   5236:   border: 1px solid black;
                   5237:   background: $pgbg;
1.803     bisitz   5238:   padding: 0;
1.397     albertel 5239:   border-spacing: 1px;
                   5240: }
1.795     www      5241: 
1.397     albertel 5242: table#LC_helpmenu_links tr td {
                   5243:   padding: 1px;
                   5244:   background: $tabbg;
1.399     albertel 5245:   text-align: center;
                   5246:   font-weight: bold;
1.397     albertel 5247: }
1.396     albertel 5248: 
1.795     www      5249: table#LC_helpmenu_links a:link,
                   5250: table#LC_helpmenu_links a:visited,
1.397     albertel 5251: table#LC_helpmenu_links a:active {
                   5252:   text-decoration: none;
                   5253:   color: $font;
                   5254: }
1.795     www      5255: 
1.397     albertel 5256: table#LC_helpmenu_links a:hover {
                   5257:   text-decoration: underline;
                   5258:   color: $vlink;
                   5259: }
1.396     albertel 5260: 
1.417     albertel 5261: .LC_chrt_popup_exists {
                   5262:   border: 1px solid #339933;
                   5263:   margin: -1px;
                   5264: }
1.795     www      5265: 
1.417     albertel 5266: .LC_chrt_popup_up {
                   5267:   border: 1px solid yellow;
                   5268:   margin: -1px;
                   5269: }
1.795     www      5270: 
1.417     albertel 5271: .LC_chrt_popup {
                   5272:   border: 1px solid #8888FF;
                   5273:   background: #CCCCFF;
                   5274: }
1.795     www      5275: 
1.421     albertel 5276: table.LC_pick_box {
                   5277:   border-collapse: separate;
                   5278:   background: white;
                   5279:   border: 1px solid black;
                   5280:   border-spacing: 1px;
                   5281: }
1.795     www      5282: 
1.421     albertel 5283: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5284:   background: $sidebg;
1.421     albertel 5285:   font-weight: bold;
                   5286:   text-align: right;
1.740     bisitz   5287:   vertical-align: top;
1.421     albertel 5288:   width: 184px;
                   5289:   padding: 8px;
                   5290: }
1.795     www      5291: 
1.579     raeburn  5292: table.LC_pick_box td.LC_pick_box_value {
                   5293:   text-align: left;
                   5294:   padding: 8px;
                   5295: }
1.795     www      5296: 
1.579     raeburn  5297: table.LC_pick_box td.LC_pick_box_select {
                   5298:   text-align: left;
                   5299:   padding: 8px;
                   5300: }
1.795     www      5301: 
1.424     albertel 5302: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5303:   padding: 0;
1.421     albertel 5304:   height: 1px;
                   5305:   background: black;
                   5306: }
1.795     www      5307: 
1.421     albertel 5308: table.LC_pick_box td.LC_pick_box_submit {
                   5309:   text-align: right;
                   5310: }
1.795     www      5311: 
1.579     raeburn  5312: table.LC_pick_box td.LC_evenrow_value {
                   5313:   text-align: left;
                   5314:   padding: 8px;
                   5315:   background-color: $data_table_light;
                   5316: }
1.795     www      5317: 
1.579     raeburn  5318: table.LC_pick_box td.LC_oddrow_value {
                   5319:   text-align: left;
                   5320:   padding: 8px;
                   5321:   background-color: $data_table_light;
                   5322: }
1.795     www      5323: 
1.579     raeburn  5324: table.LC_helpform_receipt {
                   5325:   width: 620px;
                   5326:   border-collapse: separate;
                   5327:   background: white;
                   5328:   border: 1px solid black;
                   5329:   border-spacing: 1px;
                   5330: }
1.795     www      5331: 
1.579     raeburn  5332: table.LC_helpform_receipt td.LC_pick_box_title {
                   5333:   background: $tabbg;
                   5334:   font-weight: bold;
                   5335:   text-align: right;
                   5336:   width: 184px;
                   5337:   padding: 8px;
                   5338: }
1.795     www      5339: 
1.579     raeburn  5340: table.LC_helpform_receipt td.LC_evenrow_value {
                   5341:   text-align: left;
                   5342:   padding: 8px;
                   5343:   background-color: $data_table_light;
                   5344: }
1.795     www      5345: 
1.579     raeburn  5346: table.LC_helpform_receipt td.LC_oddrow_value {
                   5347:   text-align: left;
                   5348:   padding: 8px;
                   5349:   background-color: $data_table_light;
                   5350: }
1.795     www      5351: 
1.579     raeburn  5352: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5353:   padding: 0;
1.579     raeburn  5354:   height: 1px;
                   5355:   background: black;
                   5356: }
1.795     www      5357: 
1.579     raeburn  5358: span.LC_helpform_receipt_cat {
                   5359:   font-weight: bold;
                   5360: }
1.795     www      5361: 
1.424     albertel 5362: table.LC_group_priv_box {
                   5363:   background: white;
                   5364:   border: 1px solid black;
                   5365:   border-spacing: 1px;
                   5366: }
1.795     www      5367: 
1.424     albertel 5368: table.LC_group_priv_box td.LC_pick_box_title {
                   5369:   background: $tabbg;
                   5370:   font-weight: bold;
                   5371:   text-align: right;
                   5372:   width: 184px;
                   5373: }
1.795     www      5374: 
1.424     albertel 5375: table.LC_group_priv_box td.LC_groups_fixed {
                   5376:   background: $data_table_light;
                   5377:   text-align: center;
                   5378: }
1.795     www      5379: 
1.424     albertel 5380: table.LC_group_priv_box td.LC_groups_optional {
                   5381:   background: $data_table_dark;
                   5382:   text-align: center;
                   5383: }
1.795     www      5384: 
1.424     albertel 5385: table.LC_group_priv_box td.LC_groups_functionality {
                   5386:   background: $data_table_darker;
                   5387:   text-align: center;
                   5388:   font-weight: bold;
                   5389: }
1.795     www      5390: 
1.424     albertel 5391: table.LC_group_priv td {
                   5392:   text-align: left;
1.803     bisitz   5393:   padding: 0;
1.424     albertel 5394: }
                   5395: 
1.421     albertel 5396: table.LC_notify_front_page {
                   5397:   background: white;
                   5398:   border: 1px solid black;
                   5399:   padding: 8px;
                   5400: }
1.795     www      5401: 
1.421     albertel 5402: table.LC_notify_front_page td {
                   5403:   padding: 8px;
                   5404: }
1.795     www      5405: 
1.424     albertel 5406: .LC_navbuttons {
                   5407:   margin: 2ex 0ex 2ex 0ex;
                   5408: }
1.795     www      5409: 
1.423     albertel 5410: .LC_topic_bar {
                   5411:   font-weight: bold;
                   5412:   width: 100%;
                   5413:   background: $tabbg;
                   5414:   vertical-align: middle;
                   5415:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5416:   padding: 3px;
1.423     albertel 5417: }
1.795     www      5418: 
1.423     albertel 5419: .LC_topic_bar span {
                   5420:   vertical-align: middle;
                   5421: }
1.795     www      5422: 
1.423     albertel 5423: .LC_topic_bar img {
                   5424:   vertical-align: bottom;
                   5425: }
1.795     www      5426: 
1.423     albertel 5427: table.LC_course_group_status {
                   5428:   margin: 20px;
                   5429: }
1.795     www      5430: 
1.423     albertel 5431: table.LC_status_selector td {
                   5432:   vertical-align: top;
                   5433:   text-align: center;
1.424     albertel 5434:   padding: 4px;
                   5435: }
1.795     www      5436: 
1.599     albertel 5437: div.LC_feedback_link {
1.616     albertel 5438:   clear: both;
1.829     kalberla 5439:   background: $sidebg;
1.779     bisitz   5440:   width: 100%;
1.829     kalberla 5441:   padding-bottom: 10px;
                   5442:   border: 1px $tabbg solid;
1.833     kalberla 5443:   height: 22px;
                   5444:   line-height: 22px;
                   5445:   padding-top: 5px;
                   5446: }
                   5447: 
                   5448: div.LC_feedback_link img {
                   5449:   height: 22px;
1.867     kalberla 5450:   vertical-align:middle;
1.829     kalberla 5451: }
                   5452: 
                   5453: div.LC_feedback_link a{
                   5454:   text-decoration: none;
1.489     raeburn  5455: }
1.795     www      5456: 
1.867     kalberla 5457: div.LC_comblock {
                   5458:   display:inline; 
                   5459:   color:$font;
                   5460:   font-size:90%;
                   5461: }
                   5462: 
                   5463: div.LC_feedback_link div.LC_comblock {
                   5464:   padding-left:5px;
                   5465: }
                   5466: 
                   5467: div.LC_feedback_link div.LC_comblock a {
                   5468:   color:$font;
                   5469: }
                   5470: 
1.489     raeburn  5471: span.LC_feedback_link {
1.858     bisitz   5472:   /* background: $feedback_link_bg; */
1.599     albertel 5473:   font-size: larger;
                   5474: }
1.795     www      5475: 
1.599     albertel 5476: span.LC_message_link {
1.858     bisitz   5477:   /* background: $feedback_link_bg; */
1.599     albertel 5478:   font-size: larger;
                   5479:   position: absolute;
                   5480:   right: 1em;
1.489     raeburn  5481: }
1.421     albertel 5482: 
1.515     albertel 5483: table.LC_prior_tries {
1.524     albertel 5484:   border: 1px solid #000000;
                   5485:   border-collapse: separate;
                   5486:   border-spacing: 1px;
1.515     albertel 5487: }
1.523     albertel 5488: 
1.515     albertel 5489: table.LC_prior_tries td {
1.524     albertel 5490:   padding: 2px;
1.515     albertel 5491: }
1.523     albertel 5492: 
                   5493: .LC_answer_correct {
1.795     www      5494:   background: lightgreen;
                   5495:   color: darkgreen;
                   5496:   padding: 6px;
1.523     albertel 5497: }
1.795     www      5498: 
1.523     albertel 5499: .LC_answer_charged_try {
1.797     www      5500:   background: #FFAAAA;
1.795     www      5501:   color: darkred;
                   5502:   padding: 6px;
1.523     albertel 5503: }
1.795     www      5504: 
1.779     bisitz   5505: .LC_answer_not_charged_try,
1.523     albertel 5506: .LC_answer_no_grade,
                   5507: .LC_answer_late {
1.795     www      5508:   background: lightyellow;
1.523     albertel 5509:   color: black;
1.795     www      5510:   padding: 6px;
1.523     albertel 5511: }
1.795     www      5512: 
1.523     albertel 5513: .LC_answer_previous {
1.795     www      5514:   background: lightblue;
                   5515:   color: darkblue;
                   5516:   padding: 6px;
1.523     albertel 5517: }
1.795     www      5518: 
1.779     bisitz   5519: .LC_answer_no_message {
1.777     tempelho 5520:   background: #FFFFFF;
                   5521:   color: black;
1.795     www      5522:   padding: 6px;
1.779     bisitz   5523: }
1.795     www      5524: 
1.779     bisitz   5525: .LC_answer_unknown {
                   5526:   background: orange;
                   5527:   color: black;
1.795     www      5528:   padding: 6px;
1.777     tempelho 5529: }
1.795     www      5530: 
1.529     albertel 5531: span.LC_prior_numerical,
                   5532: span.LC_prior_string,
                   5533: span.LC_prior_custom,
                   5534: span.LC_prior_reaction,
                   5535: span.LC_prior_math {
1.523     albertel 5536:   font-family: monospace;
                   5537:   white-space: pre;
                   5538: }
                   5539: 
1.525     albertel 5540: span.LC_prior_string {
                   5541:   font-family: monospace;
                   5542:   white-space: pre;
                   5543: }
                   5544: 
1.523     albertel 5545: table.LC_prior_option {
                   5546:   width: 100%;
                   5547:   border-collapse: collapse;
                   5548: }
1.795     www      5549: 
                   5550: table.LC_prior_rank, 
                   5551: table.LC_prior_match {
1.528     albertel 5552:   border-collapse: collapse;
                   5553: }
1.795     www      5554: 
1.528     albertel 5555: table.LC_prior_option tr td,
                   5556: table.LC_prior_rank tr td,
                   5557: table.LC_prior_match tr td {
1.524     albertel 5558:   border: 1px solid #000000;
1.515     albertel 5559: }
                   5560: 
1.855     bisitz   5561: .LC_nobreak {
1.544     albertel 5562:   white-space: nowrap;
1.519     raeburn  5563: }
                   5564: 
1.576     raeburn  5565: span.LC_cusr_emph {
                   5566:   font-style: italic;
                   5567: }
                   5568: 
1.633     raeburn  5569: span.LC_cusr_subheading {
                   5570:   font-weight: normal;
                   5571:   font-size: 85%;
                   5572: }
                   5573: 
1.545     albertel 5574: table.LC_docs_documents {
                   5575:   background: #BBBBBB;
1.803     bisitz   5576:   border-width: 0;
1.545     albertel 5577:   border-collapse: collapse;
                   5578: }
1.795     www      5579: 
1.777     tempelho 5580: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5581:   border: 2px solid black;
                   5582:   padding: 4px;
1.777     tempelho 5583: }
1.795     www      5584: 
1.861     bisitz   5585: div.LC_docs_entry_move {
1.859     bisitz   5586:   border: 1px solid #BBBBBB;
1.545     albertel 5587:   background: #DDDDDD;
1.861     bisitz   5588:   width: 22px;
1.859     bisitz   5589:   padding: 1px;
                   5590:   margin: 0;
1.545     albertel 5591: }
                   5592: 
1.861     bisitz   5593: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5594: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5595:   background: #DDDDDD;
                   5596:   font-size: x-small;
                   5597: }
1.795     www      5598: 
1.861     bisitz   5599: .LC_docs_entry_parameter {
                   5600:   white-space: nowrap;
                   5601: }
                   5602: 
1.544     albertel 5603: .LC_docs_copy {
1.545     albertel 5604:   color: #000099;
1.544     albertel 5605: }
1.795     www      5606: 
1.544     albertel 5607: .LC_docs_cut {
1.545     albertel 5608:   color: #550044;
1.544     albertel 5609: }
1.795     www      5610: 
1.544     albertel 5611: .LC_docs_rename {
1.545     albertel 5612:   color: #009900;
1.544     albertel 5613: }
1.795     www      5614: 
1.544     albertel 5615: .LC_docs_remove {
1.545     albertel 5616:   color: #990000;
                   5617: }
                   5618: 
1.547     albertel 5619: .LC_docs_reinit_warn,
                   5620: .LC_docs_ext_edit {
                   5621:   font-size: x-small;
                   5622: }
                   5623: 
1.545     albertel 5624: table.LC_docs_adddocs td,
                   5625: table.LC_docs_adddocs th {
                   5626:   border: 1px solid #BBBBBB;
                   5627:   padding: 4px;
                   5628:   background: #DDDDDD;
1.543     albertel 5629: }
                   5630: 
1.584     albertel 5631: table.LC_sty_begin {
                   5632:   background: #BBFFBB;
                   5633: }
1.795     www      5634: 
1.584     albertel 5635: table.LC_sty_end {
                   5636:   background: #FFBBBB;
                   5637: }
                   5638: 
1.589     raeburn  5639: table.LC_double_column {
1.803     bisitz   5640:   border-width: 0;
1.589     raeburn  5641:   border-collapse: collapse;
                   5642:   width: 100%;
                   5643:   padding: 2px;
                   5644: }
                   5645: 
                   5646: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5647:   top: 2px;
1.589     raeburn  5648:   left: 2px;
                   5649:   width: 47%;
                   5650:   vertical-align: top;
                   5651: }
                   5652: 
                   5653: table.LC_double_column tr td.LC_right_col {
                   5654:   top: 2px;
1.779     bisitz   5655:   right: 2px;
1.589     raeburn  5656:   width: 47%;
                   5657:   vertical-align: top;
                   5658: }
                   5659: 
1.591     raeburn  5660: div.LC_left_float {
                   5661:   float: left;
                   5662:   padding-right: 5%;
1.597     albertel 5663:   padding-bottom: 4px;
1.591     raeburn  5664: }
                   5665: 
                   5666: div.LC_clear_float_header {
1.597     albertel 5667:   padding-bottom: 2px;
1.591     raeburn  5668: }
                   5669: 
                   5670: div.LC_clear_float_footer {
1.597     albertel 5671:   padding-top: 10px;
1.591     raeburn  5672:   clear: both;
                   5673: }
                   5674: 
1.597     albertel 5675: div.LC_grade_show_user {
                   5676:   margin-top: 20px;
                   5677:   border: 1px solid black;
                   5678: }
1.795     www      5679: 
1.597     albertel 5680: div.LC_grade_user_name {
                   5681:   background: #DDDDEE;
                   5682:   border-bottom: 1px solid black;
1.705     tempelho 5683:   font-weight: bold;
                   5684:   font-size: large;
1.597     albertel 5685: }
1.795     www      5686: 
1.597     albertel 5687: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5688:   background: #DDEEDD;
                   5689: }
                   5690: 
                   5691: div.LC_grade_show_problem,
                   5692: div.LC_grade_submissions,
                   5693: div.LC_grade_message_center,
                   5694: div.LC_grade_info_links,
                   5695: div.LC_grade_assign {
                   5696:   margin: 5px;
                   5697:   width: 99%;
                   5698:   background: #FFFFFF;
                   5699: }
1.795     www      5700: 
1.597     albertel 5701: div.LC_grade_show_problem_header,
                   5702: div.LC_grade_submissions_header,
                   5703: div.LC_grade_message_center_header,
                   5704: div.LC_grade_assign_header {
1.705     tempelho 5705:   font-weight: bold;
                   5706:   font-size: large;
1.597     albertel 5707: }
1.795     www      5708: 
1.597     albertel 5709: div.LC_grade_show_problem_problem,
                   5710: div.LC_grade_submissions_body,
                   5711: div.LC_grade_message_center_body,
                   5712: div.LC_grade_assign_body {
                   5713:   border: 1px solid black;
                   5714:   width: 99%;
                   5715:   background: #FFFFFF;
                   5716: }
1.795     www      5717: 
1.598     albertel 5718: span.LC_grade_check_note {
1.705     tempelho 5719:   font-weight: normal;
                   5720:   font-size: medium;
1.598     albertel 5721:   display: inline;
                   5722:   position: absolute;
                   5723:   right: 1em;
                   5724: }
1.597     albertel 5725: 
1.613     albertel 5726: table.LC_scantron_action {
                   5727:   width: 100%;
                   5728: }
1.795     www      5729: 
1.613     albertel 5730: table.LC_scantron_action tr th {
1.698     harmsja  5731:   font-weight:bold;
                   5732:   font-style:normal;
1.613     albertel 5733: }
1.795     www      5734: 
1.779     bisitz   5735: .LC_edit_problem_header,
1.614     albertel 5736: div.LC_edit_problem_footer {
1.705     tempelho 5737:   font-weight: normal;
                   5738:   font-size:  medium;
1.602     albertel 5739:   margin: 2px;
1.600     albertel 5740: }
1.795     www      5741: 
1.600     albertel 5742: div.LC_edit_problem_header,
1.602     albertel 5743: div.LC_edit_problem_header div,
1.614     albertel 5744: div.LC_edit_problem_footer,
                   5745: div.LC_edit_problem_footer div,
1.602     albertel 5746: div.LC_edit_problem_editxml_header,
                   5747: div.LC_edit_problem_editxml_header div {
1.600     albertel 5748:   margin-top: 5px;
                   5749: }
1.795     www      5750: 
1.600     albertel 5751: div.LC_edit_problem_header_title {
1.705     tempelho 5752:   font-weight: bold;
                   5753:   font-size: larger;
1.602     albertel 5754:   background: $tabbg;
                   5755:   padding: 3px;
                   5756: }
1.795     www      5757: 
1.602     albertel 5758: table.LC_edit_problem_header_title {
1.705     tempelho 5759:   font-size: larger;
                   5760:   font-weight:  bold;
1.602     albertel 5761:   width: 100%;
                   5762:   border-color: $pgbg;
                   5763:   border-style: solid;
                   5764:   border-width: $border;
1.600     albertel 5765:   background: $tabbg;
1.602     albertel 5766:   border-collapse: collapse;
1.803     bisitz   5767:   padding: 0;
1.602     albertel 5768: }
                   5769: 
                   5770: div.LC_edit_problem_discards {
                   5771:   float: left;
                   5772:   padding-bottom: 5px;
                   5773: }
1.795     www      5774: 
1.602     albertel 5775: div.LC_edit_problem_saves {
                   5776:   float: right;
                   5777:   padding-bottom: 5px;
1.600     albertel 5778: }
1.795     www      5779: 
1.679     riegler  5780: img.stift{
1.803     bisitz   5781:   border-width: 0;
                   5782:   vertical-align: middle;
1.677     riegler  5783: }
1.680     riegler  5784: 
1.681     riegler  5785: table#LC_mainmenu{
                   5786:  margin-top:10px;
                   5787:  width:80%;
                   5788: }
                   5789: 
1.680     riegler  5790: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5791:   vertical-align: top;
                   5792:   width: 45%;
                   5793: }
1.795     www      5794: 
1.779     bisitz   5795: .LC_mainmenu_fieldset_category {
                   5796:   color: $font;
                   5797:   background: $pgbg;
                   5798:   font-size: small;
                   5799:   font-weight: bold;
1.777     tempelho 5800: }
1.795     www      5801: 
1.716     raeburn  5802: div.LC_createcourse {
                   5803:     margin: 10px 10px 10px 10px;
                   5804: }
                   5805: 
1.693     droeschl 5806: /* ---- Remove when done ----
                   5807: # The following styles is part of the redesign of LON-CAPA and are
                   5808: # subject to change during this project.
                   5809: # Don't rely on their current functionality as they might be 
                   5810: # changed or removed.
                   5811: # --------------------------*/
                   5812: 
1.698     harmsja  5813: a:hover,
1.721     harmsja  5814: ol.LC_smallMenu a:hover,
                   5815: ol#LC_MenuBreadcrumbs a:hover,
                   5816: ol#LC_PathBreadcrumbs a:hover,
                   5817: ul#LC_TabMainMenuContent a:hover,
                   5818: .LC_FormSectionClearButton input:hover
1.795     www      5819: ul.LC_TabContent   li:hover a {
1.698     harmsja  5820: 	color:#BF2317;
                   5821:         text-decoration:none;
1.693     droeschl 5822: }
                   5823: 
1.779     bisitz   5824: h1 {
1.813     bisitz   5825: 	padding: 0;
1.693     droeschl 5826: 	line-height:130%;
                   5827: }
1.698     harmsja  5828: 
1.795     www      5829: h2,h3,h4,h5,h6 {
1.803     bisitz   5830: 	margin: 5px 0 5px 0;
                   5831: 	padding: 0;
1.721     harmsja  5832: 	line-height:130%;
1.693     droeschl 5833: }
1.795     www      5834: 
                   5835: .LC_hcell {
1.698     harmsja  5836:         padding:3px 15px 3px 15px;
1.803     bisitz   5837:         margin: 0;
1.703     harmsja  5838: 	background-color:$tabbg;
1.801     tempelho 5839: 	color:$fontmenu;
1.779     bisitz   5840: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5841: }
1.795     www      5842: 
1.840     bisitz   5843: .LC_Box > .LC_hcell {
1.847     tempelho 5844:     margin: 0 -10px 10px -10px;
1.835     bisitz   5845: }
                   5846: 
1.721     harmsja  5847: .LC_noBorder {
1.803     bisitz   5848:         border: 0;
1.698     harmsja  5849: }
1.693     droeschl 5850: 
1.761     tempelho 5851: .LC_Right {
                   5852:         float: right;
1.803     bisitz   5853:         margin: 0;
                   5854:         padding: 0;
1.761     tempelho 5855: }
                   5856: 
1.721     harmsja  5857: .LC_FormSectionClearButton input {
1.779     bisitz   5858:         background-color:transparent;
1.803     bisitz   5859:         border: none;
1.698     harmsja  5860:         cursor:pointer;
                   5861:         text-decoration:underline;
1.693     droeschl 5862: }
1.763     bisitz   5863: 
                   5864: .LC_help_open_topic {
                   5865:         color: #FFFFFF;
                   5866:         background-color: #EEEEFF;
                   5867:         margin: 1px;
                   5868:         padding: 4px;
                   5869:         border: 1px solid #000033;
                   5870:         white-space: nowrap;
1.783     amueller 5871: /*		vertical-align: middle; */
1.759     neumanie 5872: }
1.693     droeschl 5873: 
1.698     harmsja  5874: dl,ul,div,fieldset {
1.803     bisitz   5875: 	margin: 10px 10px 10px 0;
1.806     bisitz   5876: /*	overflow: hidden; */
1.693     droeschl 5877: }
1.795     www      5878: 
1.838     bisitz   5879: fieldset > legend {
                   5880:     font-weight: bold;
                   5881:     padding: 0 5px 0 5px;
                   5882: }
                   5883: 
1.813     bisitz   5884: #LC_nav_bar {
1.807     droeschl 5885:     float: left;
1.852     droeschl 5886:     margin: 0.2em 0 0 0;
1.807     droeschl 5887: }
                   5888: 
1.813     bisitz   5889: #LC_nav_bar em{
1.807     droeschl 5890:     font-weight: bold;
                   5891:     font-style: normal;
                   5892: }
                   5893: 
                   5894: ol.LC_smallMenu {
                   5895:     float: right;
1.852     droeschl 5896:     margin: 0.2em 0 0 0;
1.807     droeschl 5897: }
                   5898: 
1.852     droeschl 5899: ol#LC_PathBreadcrumbs {
1.803     bisitz   5900: 	margin: 0;
1.693     droeschl 5901: }
                   5902: 
1.721     harmsja  5903: ol.LC_smallMenu li {
1.693     droeschl 5904: 	display: inline;
1.803     bisitz   5905: 	padding: 5px 5px 0 10px;
1.693     droeschl 5906: 	vertical-align: top;
                   5907: }
                   5908: 
1.721     harmsja  5909: ol.LC_smallMenu li img {
1.693     droeschl 5910: 	vertical-align: bottom;
                   5911: }
                   5912: 
1.721     harmsja  5913: ol.LC_smallMenu a {
1.693     droeschl 5914: 	font-size: 90%;
                   5915: 	color: RGB(80, 80, 80);
                   5916: 	text-decoration: none;
                   5917: }
1.795     www      5918: 
1.808     droeschl 5919: ul#LC_TabMainMenuContent {
1.807     droeschl 5920:     clear: both;
1.808     droeschl 5921:     color: $fontmenu;
                   5922:     background: $tabbg;
                   5923:     list-style: none;
                   5924:     padding: 0;
                   5925:     margin: 0;
                   5926:     width: 100%;
                   5927: }
                   5928: 
                   5929: ul#LC_TabMainMenuContent li {
                   5930:     font-weight: bold;
                   5931:     line-height: 1.8em;
                   5932:     padding: 0 0.8em; 
                   5933:     border-right: 1px solid black;
                   5934:     display: inline;
                   5935:     vertical-align: middle;
1.807     droeschl 5936: }
                   5937: 
1.847     tempelho 5938: ul.LC_TabContent {
1.721     harmsja  5939: 	display:block;
1.847     tempelho 5940: 	background: $sidebg;
1.858     bisitz   5941: 	border-bottom: solid 1px $lg_border_color;
1.721     harmsja  5942: 	list-style:none;
1.870     tempelho 5943: 	margin: 0 -10px;
1.803     bisitz   5944: 	padding: 0;
1.693     droeschl 5945: }
                   5946: 
1.795     www      5947: ul.LC_TabContent li,
                   5948: ul.LC_TabContentBigger li {
1.741     harmsja  5949: 	float:left;
                   5950: }
1.795     www      5951: 
1.808     droeschl 5952: ul#LC_TabMainMenuContent li a {
                   5953:     color: $fontmenu;
1.693     droeschl 5954: 	text-decoration: none;
                   5955: }
1.795     www      5956: 
1.721     harmsja  5957: ul.LC_TabContent {
1.847     tempelho 5958: 	min-height:1.5em;
1.721     harmsja  5959: }
1.795     www      5960: 
                   5961: ul.LC_TabContent li {
1.741     harmsja  5962: 	vertical-align:middle;
1.803     bisitz   5963: 	padding: 0 10px 0 10px;
1.745     ehlerst  5964: 	background-color:$tabbg;
                   5965: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5966: }
1.795     www      5967: 
1.847     tempelho 5968: ul.LC_TabContent .right {
                   5969: 	float:right;
                   5970: }
                   5971: 
1.795     www      5972: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5973: 	color:rgb(47,47,47);
                   5974: 	text-decoration:none;
                   5975: 	font-size:95%;
                   5976: 	font-weight:bold;
1.761     tempelho 5977: 	padding-right: 16px;
1.721     harmsja  5978: }
1.795     www      5979: 
                   5980: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5981:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.841     tempelho 5982: 	border-bottom:solid 2px #FFFFFF;
1.761     tempelho 5983: 	padding-right: 16px;
1.744     ehlerst  5984: }
1.795     www      5985: 
1.870     tempelho 5986: #maincoursedoc {
                   5987: 	clear:both;
                   5988: }
                   5989: 
                   5990: ul.LC_TabContentBigger {
                   5991:         display:block;
                   5992:         list-style:none;
                   5993:         padding: 0;
                   5994: }
                   5995: 
1.795     www      5996: ul.LC_TabContentBigger li {
1.870     tempelho 5997:         vertical-align:bottom;
                   5998:         height: 30px;
                   5999:         font-size:110%;
                   6000:         font-weight:bold;
                   6001:         color: #737373;
1.841     tempelho 6002: }
                   6003: 
1.870     tempelho 6004: 
                   6005: ul.LC_TabContentBigger li a {
                   6006:         background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6007: 	height: 30px;
                   6008: 	line-height: 30px;
                   6009: 	text-align: center;
                   6010: 	display: block;
                   6011: 	text-decoration: none;
1.741     harmsja  6012: }
1.795     www      6013: 
1.870     tempelho 6014: ul.LC_TabContentBigger li:hover a, 
                   6015: ul.LC_TabContentBigger li.active a {
                   6016: 	background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
1.857     tempelho 6017: 	color:$font;
1.870     tempelho 6018: 	text-decoration: underline;
1.744     ehlerst  6019: }
1.795     www      6020: 
1.870     tempelho 6021: 
                   6022: ul.LC_TabContentBigger li b {
                   6023: 	background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6024: 	display: block;
                   6025: 	float: left;
                   6026: 	padding: 0 30px;
                   6027: }
                   6028: 
                   6029: ul.LC_TabContentBigger li:hover b,
                   6030: ul.LC_TabContentBigger li.active b {
                   6031:         background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6032:         color:$font;
                   6033: 	border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6034: }
1.693     droeschl 6035: 
1.870     tempelho 6036: 
1.862     bisitz   6037: ul.LC_CourseBreadcrumbs {
                   6038:   background: $sidebg;
                   6039:   line-height: 32px;
                   6040:   padding-left: 10px;
                   6041:   margin: 0 0 10px 0;
                   6042:   list-style-position: inside;
                   6043: 
                   6044: }
                   6045: 
1.795     www      6046: ol#LC_MenuBreadcrumbs, 
1.862     bisitz   6047: ol#LC_PathBreadcrumbs {
1.693     droeschl 6048: 	padding-left: 10px;
1.819     tempelho 6049: 	margin: 0;
1.693     droeschl 6050: 	list-style-position: inside;
                   6051: }
                   6052: 
1.795     www      6053: ol#LC_MenuBreadcrumbs li, 
                   6054: ol#LC_PathBreadcrumbs li, 
1.862     bisitz   6055: ul.LC_CourseBreadcrumbs li {
1.842     droeschl 6056:     display: inline;
                   6057:     white-space: nowrap;
1.693     droeschl 6058: }
                   6059: 
1.823     bisitz   6060: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6061: ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 6062: 	text-decoration: none;
                   6063: 	font-size:90%;
                   6064: }
1.795     www      6065: 
                   6066: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6067: 	text-decoration:none;
                   6068: 	font-size:100%;
                   6069: 	font-weight:bold;
1.693     droeschl 6070: }
1.795     www      6071: 
1.840     bisitz   6072: .LC_Box {
1.835     bisitz   6073:     border: solid 1px $lg_border_color;
                   6074:     padding: 0 10px 10px 10px;
1.746     neumanie 6075: }
1.795     www      6076: 
                   6077: .LC_AboutMe_Image {
1.747     neumanie 6078: 	float:left;
                   6079: 	margin-right:10px;
                   6080: }
1.795     www      6081: 
                   6082: .LC_Clear_AboutMe_Image {
1.747     neumanie 6083: 	clear:left;
                   6084: }
1.795     www      6085: 
1.721     harmsja  6086: dl.LC_ListStyleClean dt {
1.693     droeschl 6087: 	padding-right: 5px;
                   6088: 	display: table-header-group;
                   6089: }
                   6090: 
1.721     harmsja  6091: dl.LC_ListStyleClean dd {
1.693     droeschl 6092: 	display: table-row;
                   6093: }
                   6094: 
1.721     harmsja  6095: .LC_ListStyleClean,
                   6096: .LC_ListStyleSimple,
                   6097: .LC_ListStyleNormal,
1.777     tempelho 6098: .LC_ListStyle_Border,
1.795     www      6099: .LC_ListStyleSpecial {
1.693     droeschl 6100: 	/*display:block;	*/
                   6101: 	list-style-position: inside;
                   6102: 	list-style-type: none;
                   6103: 	overflow: hidden;
1.803     bisitz   6104: 	padding: 0;
1.693     droeschl 6105: }
                   6106: 
1.721     harmsja  6107: .LC_ListStyleSimple li,
                   6108: .LC_ListStyleSimple dd,
                   6109: .LC_ListStyleNormal li,
                   6110: .LC_ListStyleNormal dd,
                   6111: .LC_ListStyleSpecial li,
1.795     www      6112: .LC_ListStyleSpecial dd {
1.803     bisitz   6113: 	margin: 0;
1.693     droeschl 6114: 	padding: 5px 5px 5px 10px;
                   6115: 	clear: both;
                   6116: }
                   6117: 
1.721     harmsja  6118: .LC_ListStyleClean li,
                   6119: .LC_ListStyleClean dd {
1.803     bisitz   6120: 	padding-top: 0;
                   6121: 	padding-bottom: 0;
1.693     droeschl 6122: }
                   6123: 
1.721     harmsja  6124: .LC_ListStyleSimple dd,
1.795     www      6125: .LC_ListStyleSimple li {
1.698     harmsja  6126: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6127: }
                   6128: 
1.721     harmsja  6129: .LC_ListStyleSpecial li,
                   6130: .LC_ListStyleSpecial dd {
1.693     droeschl 6131: 	list-style-type: none;
                   6132: 	background-color: RGB(220, 220, 220);
                   6133: 	margin-bottom: 4px;
                   6134: }
                   6135: 
1.721     harmsja  6136: table.LC_SimpleTable {
1.698     harmsja  6137: 	margin:5px;
                   6138: 	border:solid 1px $lg_border_color;
1.795     www      6139: }
1.693     droeschl 6140: 
1.721     harmsja  6141: table.LC_SimpleTable tr {
1.803     bisitz   6142: 	padding: 0;
1.698     harmsja  6143: 	border:solid 1px $lg_border_color;
1.693     droeschl 6144: }
1.795     www      6145: 
                   6146: table.LC_SimpleTable thead {
1.698     harmsja  6147: 	 background:rgb(220,220,220);
1.693     droeschl 6148: }
                   6149: 
1.721     harmsja  6150: div.LC_columnSection {
1.693     droeschl 6151: 	display: block;
                   6152: 	clear: both;
                   6153: 	overflow: hidden;
1.803     bisitz   6154: 	margin: 0;
1.693     droeschl 6155: }
                   6156: 
1.721     harmsja  6157: div.LC_columnSection>* {
1.693     droeschl 6158: 	float: left;
1.803     bisitz   6159: 	margin: 10px 20px 10px 0;
1.747     neumanie 6160: 	overflow:hidden;
1.693     droeschl 6161: }
1.721     harmsja  6162: 
1.694     tempelho 6163: .LC_loginpage_container {
                   6164: 	text-align:left;
                   6165: 	margin : 0 auto;
1.785     tempelho 6166: 	width:90%;
1.694     tempelho 6167: 	padding: 10px;
                   6168: 	height: auto;
1.712     muellerd 6169: 	background-color:#FFFFFF;
1.694     tempelho 6170: 	border:1px solid #CCCCCC;
                   6171: }
                   6172: 
                   6173: 
                   6174: .LC_loginpage_loginContainer {
                   6175: 	float:left;
1.712     muellerd 6176: 	width: 182px;
1.785     tempelho 6177: 	padding: 2px;
1.712     muellerd 6178: 	border:1px solid #CCCCCC;
                   6179: 	background-color:$loginbg;
1.694     tempelho 6180: }
                   6181: 
1.795     www      6182: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6183: 	margin-top: 0;
1.712     muellerd 6184: 	display:block;
                   6185: 	background:$bgcol;
                   6186: 	color:$textcol;
                   6187: 	padding-left:5px;
                   6188: }
1.785     tempelho 6189: 
1.694     tempelho 6190: .LC_loginpage_loginInfo {
                   6191: 	float:left;
1.785     tempelho 6192: 	width:182px;
1.694     tempelho 6193: 	border:1px solid #CCCCCC;
1.785     tempelho 6194: 	padding:2px;
1.712     muellerd 6195: }
                   6196: 
1.694     tempelho 6197: .LC_loginpage_space {
1.754     droeschl 6198: 	clear: both;
                   6199: 	margin-bottom: 20px;
1.694     tempelho 6200: 	border-bottom: 1px solid #CCCCCC;
                   6201: }
                   6202: 
1.785     tempelho 6203: .LC_loginpage_floatLeft {
                   6204: 	float: left;
                   6205: 	width: 200px;
                   6206: 	margin: 0;
                   6207: }
                   6208: 
1.795     www      6209: table em {
1.754     droeschl 6210: 	font-weight: bold;
                   6211: 	font-style: normal;
1.748     schulted 6212: }
1.795     www      6213: 
1.779     bisitz   6214: table.LC_tableBrowseRes,
1.795     www      6215: table.LC_tableOfContent {
1.769     schulted 6216:         border:none;
1.858     bisitz   6217: 	border-spacing: 1px;
1.754     droeschl 6218: 	padding: 3px;
                   6219: 	background-color: #FFFFFF;
                   6220: 	font-size: 90%;
1.753     droeschl 6221: }
1.789     droeschl 6222: 
                   6223: table.LC_tableOfContent{
                   6224:     border-collapse: collapse;
                   6225: }
                   6226: 
1.771     droeschl 6227: table.LC_tableBrowseRes a,
1.768     schulted 6228: table.LC_tableOfContent a {
1.771     droeschl 6229:         background-color: transparent;
1.753     droeschl 6230: 	text-decoration: none;
                   6231: }
                   6232: 
1.771     droeschl 6233: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6234: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6235: 	background-color: #EEEEEE;
1.753     droeschl 6236: }
                   6237: 
1.795     www      6238: table.LC_tableOfContent img {
1.753     droeschl 6239: 	border: none;
                   6240: 	height: 1.3em;
                   6241: 	vertical-align: text-bottom;
                   6242: 	margin-right: 0.3em;
                   6243: }
1.757     schulted 6244: 
1.795     www      6245: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6246: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6247: }
                   6248: 
1.795     www      6249: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6250: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6251: }
                   6252: 
1.795     www      6253: a#LC_content_toolbar_closenav {
1.774     ehlerst  6254: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6255: }
                   6256: 
1.795     www      6257: a#LC_content_toolbar_everything {
1.774     ehlerst  6258: 	background-image:url(/res/adm/pages/show-all.gif);
                   6259: }
                   6260: 
1.795     www      6261: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6262: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6263: }
                   6264: 
1.795     www      6265: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6266: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6267: }
                   6268: 
1.795     www      6269: a#LC_content_toolbar_changefolder {
1.757     schulted 6270: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6271: }
                   6272: 
1.795     www      6273: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6274: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6275: }
                   6276: 
1.795     www      6277: ul#LC_toolbar li a:hover {
1.757     schulted 6278: 	background-position: bottom center;
                   6279: }
                   6280: 
1.795     www      6281: ul#LC_toolbar {
1.803     bisitz   6282: 	padding: 0;
1.757     schulted 6283: 	margin: 2px;
                   6284: 	list-style:none;
                   6285: 	position:relative;
                   6286: 	background-color:white;
                   6287: }
                   6288: 
1.795     www      6289: ul#LC_toolbar li {
1.757     schulted 6290: 	border:1px solid white;
1.803     bisitz   6291: 	padding: 0;
1.757     schulted 6292: 	margin: 0;
1.795     www      6293:         float: left;
1.767     droeschl 6294: 	display:inline;
1.757     schulted 6295: 	vertical-align:middle;
1.795     www      6296: } 
1.757     schulted 6297: 
1.783     amueller 6298: 
1.795     www      6299: a.LC_toolbarItem {
1.767     droeschl 6300: 	display:block;
1.803     bisitz   6301: 	padding: 0;
                   6302: 	margin: 0;
1.757     schulted 6303: 	height: 32px;
                   6304: 	width: 32px;
1.779     bisitz   6305: 	color:white;
1.803     bisitz   6306: 	border: none;
1.757     schulted 6307: 	background-repeat:no-repeat;
                   6308: 	background-color:transparent;
                   6309: }
                   6310: 
1.843     bisitz   6311: ul.LC_funclist li {
1.782     bisitz   6312:   float: left;
                   6313:   white-space: nowrap;
                   6314:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6315:   margin: 0 15px 15px 10px;
1.782     bisitz   6316: }
                   6317: 
1.757     schulted 6318: 
1.343     albertel 6319: END
                   6320: }
                   6321: 
1.306     albertel 6322: =pod
                   6323: 
                   6324: =item * &headtag()
                   6325: 
                   6326: Returns a uniform footer for LON-CAPA web pages.
                   6327: 
1.307     albertel 6328: Inputs: $title - optional title for the head
                   6329:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6330:         $args - optional arguments
1.319     albertel 6331:             force_register - if is true call registerurl so the remote is 
                   6332:                              informed
1.415     albertel 6333:             redirect       -> array ref of
                   6334:                                    1- seconds before redirect occurs
                   6335:                                    2- url to redirect to
                   6336:                                    3- whether the side effect should occur
1.315     albertel 6337:                            (side effect of setting 
                   6338:                                $env{'internal.head.redirect'} to the url 
                   6339:                                redirected too)
1.352     albertel 6340:             domain         -> force to color decorate a page for a specific
                   6341:                                domain
                   6342:             function       -> force usage of a specific rolish color scheme
                   6343:             bgcolor        -> override the default page bgcolor
1.460     albertel 6344:             no_auto_mt_title
                   6345:                            -> prevent &mt()ing the title arg
1.464     albertel 6346: 
1.306     albertel 6347: =cut
                   6348: 
                   6349: sub headtag {
1.313     albertel 6350:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6351:     
1.363     albertel 6352:     my $function = $args->{'function'} || &get_users_function();
                   6353:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6354:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6355:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6356: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6357: 		   #time(),
1.418     albertel 6358: 		   $env{'environment.color.timestamp'},
1.363     albertel 6359: 		   $function,$domain,$bgcolor);
                   6360: 
1.369     www      6361:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6362: 
1.308     albertel 6363:     my $result =
                   6364: 	'<head>'.
1.461     albertel 6365: 	&font_settings();
1.319     albertel 6366: 
1.461     albertel 6367:     if (!$args->{'frameset'}) {
                   6368: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6369:     }
1.319     albertel 6370:     if ($args->{'force_register'}) {
                   6371: 	$result .= &Apache::lonmenu::registerurl(1);
                   6372:     }
1.436     albertel 6373:     if (!$args->{'no_nav_bar'} 
                   6374: 	&& !$args->{'only_body'}
                   6375: 	&& !$args->{'frameset'}) {
                   6376: 	$result .= &help_menu_js();
                   6377:     }
1.319     albertel 6378: 
1.314     albertel 6379:     if (ref($args->{'redirect'})) {
1.414     albertel 6380: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6381: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6382: 	if (!$inhibit_continue) {
                   6383: 	    $env{'internal.head.redirect'} = $url;
                   6384: 	}
1.313     albertel 6385: 	$result.=<<ADDMETA
                   6386: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6387: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6388: ADDMETA
                   6389:     }
1.306     albertel 6390:     if (!defined($title)) {
                   6391: 	$title = 'The LearningOnline Network with CAPA';
                   6392:     }
1.460     albertel 6393:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6394:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6395: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6396: 	.$head_extra;
1.306     albertel 6397:     return $result;
                   6398: }
                   6399: 
                   6400: =pod
                   6401: 
1.340     albertel 6402: =item * &font_settings()
                   6403: 
                   6404: Returns neccessary <meta> to set the proper encoding
                   6405: 
                   6406: Inputs: none
                   6407: 
                   6408: =cut
                   6409: 
                   6410: sub font_settings {
                   6411:     my $headerstring='';
1.647     www      6412:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6413: 	$headerstring.=
                   6414: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6415:     }
                   6416:     return $headerstring;
                   6417: }
                   6418: 
1.341     albertel 6419: =pod
                   6420: 
                   6421: =item * &xml_begin()
                   6422: 
                   6423: Returns the needed doctype and <html>
                   6424: 
                   6425: Inputs: none
                   6426: 
                   6427: =cut
                   6428: 
                   6429: sub xml_begin {
                   6430:     my $output='';
                   6431: 
1.592     albertel 6432:     if ($env{'internal.start_page'}==1) {
                   6433: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6434:     }
1.342     albertel 6435: 
1.341     albertel 6436:     if ($env{'browser.mathml'}) {
                   6437: 	$output='<?xml version="1.0"?>'
                   6438:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6439: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6440:             
                   6441: #	    .'<!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">] >'
                   6442: 	    .'<!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">'
                   6443:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6444: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6445:     } else {
1.849     bisitz   6446: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6447:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6448:     }
                   6449:     return $output;
                   6450: }
1.340     albertel 6451: 
                   6452: =pod
                   6453: 
1.306     albertel 6454: =item * &endheadtag()
                   6455: 
                   6456: Returns a uniform </head> for LON-CAPA web pages.
                   6457: 
                   6458: Inputs: none
                   6459: 
                   6460: =cut
                   6461: 
                   6462: sub endheadtag {
                   6463:     return '</head>';
                   6464: }
                   6465: 
                   6466: =pod
                   6467: 
                   6468: =item * &head()
                   6469: 
                   6470: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6471: 
1.648     raeburn  6472: Inputs:
                   6473: 
                   6474: =over 4
                   6475: 
                   6476: $title - optional title for the page
                   6477: 
                   6478: $head_extra - optional extra HTML to put inside the <head>
                   6479: 
                   6480: =back
1.405     albertel 6481: 
1.306     albertel 6482: =cut
                   6483: 
                   6484: sub head {
1.325     albertel 6485:     my ($title,$head_extra,$args) = @_;
                   6486:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6487: }
                   6488: 
                   6489: =pod
                   6490: 
                   6491: =item * &start_page()
                   6492: 
                   6493: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6494: 
1.648     raeburn  6495: Inputs:
                   6496: 
                   6497: =over 4
                   6498: 
                   6499: $title - optional title for the page
                   6500: 
                   6501: $head_extra - optional extra HTML to incude inside the <head>
                   6502: 
                   6503: $args - additional optional args supported are:
                   6504: 
                   6505: =over 8
                   6506: 
                   6507:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6508:                                     arg on
1.814     bisitz   6509:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6510:              add_entries    -> additional attributes to add to the  <body>
                   6511:              domain         -> force to color decorate a page for a 
1.317     albertel 6512:                                     specific domain
1.648     raeburn  6513:              function       -> force usage of a specific rolish color
1.317     albertel 6514:                                     scheme
1.648     raeburn  6515:              redirect       -> see &headtag()
                   6516:              bgcolor        -> override the default page bg color
                   6517:              js_ready       -> return a string ready for being used in 
1.317     albertel 6518:                                     a javascript writeln
1.648     raeburn  6519:              html_encode    -> return a string ready for being used in 
1.320     albertel 6520:                                     a html attribute
1.648     raeburn  6521:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6522:                                     $forcereg arg
1.648     raeburn  6523:              frameset       -> if true will start with a <frameset>
1.330     albertel 6524:                                     rather than <body>
1.648     raeburn  6525:              skip_phases    -> hash ref of 
1.338     albertel 6526:                                     head -> skip the <html><head> generation
                   6527:                                     body -> skip all <body> generation
1.648     raeburn  6528:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6529:                                     'Switch To Inline Menu' link
1.648     raeburn  6530:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6531:              inherit_jsmath -> when creating popup window in a page,
                   6532:                                     should it have jsmath forced on by the
                   6533:                                     current page
1.867     kalberla 6534:              bread_crumbs ->             Array containing breadcrumbs
                   6535:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6536: 
1.648     raeburn  6537: =back
1.460     albertel 6538: 
1.648     raeburn  6539: =back
1.562     albertel 6540: 
1.306     albertel 6541: =cut
                   6542: 
                   6543: sub start_page {
1.309     albertel 6544:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6545:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6546:     my %head_args;
1.352     albertel 6547:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6548: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6549: 		     'no_auto_mt_title') {
1.319     albertel 6550: 	if (defined($args->{$arg})) {
1.324     raeburn  6551: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6552: 	}
1.313     albertel 6553:     }
1.319     albertel 6554: 
1.315     albertel 6555:     $env{'internal.start_page'}++;
1.338     albertel 6556:     my $result;
                   6557:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6558: 	$result.=
1.341     albertel 6559: 	    &xml_begin().
1.338     albertel 6560: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6561:     }
                   6562:     
                   6563:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6564: 	if ($args->{'frameset'}) {
                   6565: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6566: 						$args->{'add_entries'});
                   6567: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6568:         } else {
                   6569:             $result .=
                   6570:                 &bodytag($title, 
                   6571:                          $args->{'function'},       $args->{'add_entries'},
                   6572:                          $args->{'only_body'},      $args->{'domain'},
                   6573:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6574:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6575:                          $args);
                   6576:         }
1.330     albertel 6577:     }
1.338     albertel 6578: 
1.315     albertel 6579:     if ($args->{'js_ready'}) {
1.713     kaisler  6580: 		$result = &js_ready($result);
1.315     albertel 6581:     }
1.320     albertel 6582:     if ($args->{'html_encode'}) {
1.713     kaisler  6583: 		$result = &html_encode($result);
                   6584:     }
                   6585: 
1.813     bisitz   6586:     # Preparation for new and consistent functionlist at top of screen
                   6587:     # if ($args->{'functionlist'}) {
                   6588:     #            $result .= &build_functionlist();
                   6589:     #}
                   6590: 
                   6591:     # Don't add anything more if only_body wanted
                   6592:     return $result if $args->{'only_body'};
                   6593: 
                   6594:     #Breadcrumbs
1.758     kaisler  6595:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6596: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6597: 		#if any br links exists, add them to the breadcrumbs
                   6598: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6599: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6600: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6601: 			}
                   6602: 		}
                   6603: 
                   6604: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6605: 		if(exists($args->{'bread_crumbs_component'})){
                   6606: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6607: 		}else{
                   6608: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6609: 		}
1.320     albertel 6610:     }
1.315     albertel 6611:     return $result;
1.306     albertel 6612: }
                   6613: 
1.330     albertel 6614: 
1.306     albertel 6615: =pod
                   6616: 
                   6617: =item * &head()
                   6618: 
                   6619: Returns a complete </body></html> section for LON-CAPA web pages.
                   6620: 
1.315     albertel 6621: Inputs:         $args - additional optional args supported are:
                   6622:                  js_ready     -> return a string ready for being used in 
                   6623:                                  a javascript writeln
1.320     albertel 6624:                  html_encode  -> return a string ready for being used in 
                   6625:                                  a html attribute
1.330     albertel 6626:                  frameset     -> if true will start with a <frameset>
                   6627:                                  rather than <body>
1.493     albertel 6628:                  dicsussion   -> if true will get discussion from
                   6629:                                   lonxml::xmlend
                   6630:                                  (you can pass the target and parser arguments
                   6631:                                   through optional 'target' and 'parser' args
                   6632:                                   to this routine)
1.306     albertel 6633: 
                   6634: =cut
                   6635: 
                   6636: sub end_page {
1.315     albertel 6637:     my ($args) = @_;
                   6638:     $env{'internal.end_page'}++;
1.330     albertel 6639:     my $result;
1.335     albertel 6640:     if ($args->{'discussion'}) {
                   6641: 	my ($target,$parser);
                   6642: 	if (ref($args->{'discussion'})) {
                   6643: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6644: 				$args->{'discussion'}{'parser'});
                   6645: 	}
                   6646: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6647:     }
                   6648: 
1.330     albertel 6649:     if ($args->{'frameset'}) {
                   6650: 	$result .= '</frameset>';
                   6651:     } else {
1.635     raeburn  6652: 	$result .= &endbodytag($args);
1.330     albertel 6653:     }
                   6654:     $result .= "\n</html>";
                   6655: 
1.315     albertel 6656:     if ($args->{'js_ready'}) {
1.317     albertel 6657: 	$result = &js_ready($result);
1.315     albertel 6658:     }
1.335     albertel 6659: 
1.320     albertel 6660:     if ($args->{'html_encode'}) {
                   6661: 	$result = &html_encode($result);
                   6662:     }
1.335     albertel 6663: 
1.315     albertel 6664:     return $result;
                   6665: }
                   6666: 
1.320     albertel 6667: sub html_encode {
                   6668:     my ($result) = @_;
                   6669: 
1.322     albertel 6670:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6671:     
                   6672:     return $result;
                   6673: }
1.317     albertel 6674: sub js_ready {
                   6675:     my ($result) = @_;
                   6676: 
1.323     albertel 6677:     $result =~ s/[\n\r]/ /xmsg;
                   6678:     $result =~ s/\\/\\\\/xmsg;
                   6679:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6680:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6681:     
                   6682:     return $result;
                   6683: }
                   6684: 
1.315     albertel 6685: sub validate_page {
                   6686:     if (  exists($env{'internal.start_page'})
1.316     albertel 6687: 	  &&     $env{'internal.start_page'} > 1) {
                   6688: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6689: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6690: 				 $ENV{'request.filename'});
1.315     albertel 6691:     }
                   6692:     if (  exists($env{'internal.end_page'})
1.316     albertel 6693: 	  &&     $env{'internal.end_page'} > 1) {
                   6694: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6695: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6696: 				 $env{'request.filename'});
1.315     albertel 6697:     }
                   6698:     if (     exists($env{'internal.start_page'})
                   6699: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6700: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6701: 				 $env{'request.filename'});
1.315     albertel 6702:     }
                   6703:     if (   ! exists($env{'internal.start_page'})
                   6704: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6705: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6706: 				 $env{'request.filename'});
1.315     albertel 6707:     }
1.306     albertel 6708: }
1.315     albertel 6709: 
1.318     albertel 6710: sub simple_error_page {
                   6711:     my ($r,$title,$msg) = @_;
                   6712:     my $page =
                   6713: 	&Apache::loncommon::start_page($title).
                   6714: 	&mt($msg).
                   6715: 	&Apache::loncommon::end_page();
                   6716:     if (ref($r)) {
                   6717: 	$r->print($page);
1.327     albertel 6718: 	return;
1.318     albertel 6719:     }
                   6720:     return $page;
                   6721: }
1.347     albertel 6722: 
                   6723: {
1.610     albertel 6724:     my @row_count;
1.347     albertel 6725:     sub start_data_table {
1.422     albertel 6726: 	my ($add_class) = @_;
                   6727: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6728: 	unshift(@row_count,0);
1.422     albertel 6729: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6730:     }
                   6731: 
                   6732:     sub end_data_table {
1.610     albertel 6733: 	shift(@row_count);
1.389     albertel 6734: 	return '</table>'."\n";;
1.347     albertel 6735:     }
                   6736: 
                   6737:     sub start_data_table_row {
1.422     albertel 6738: 	my ($add_class) = @_;
1.610     albertel 6739: 	$row_count[0]++;
                   6740: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6741: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6742: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6743:     }
1.471     banghart 6744:     
                   6745:     sub continue_data_table_row {
                   6746: 	my ($add_class) = @_;
1.610     albertel 6747: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6748: 	$css_class = (join(' ',$css_class,$add_class));
                   6749: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6750:     }
1.347     albertel 6751: 
                   6752:     sub end_data_table_row {
1.389     albertel 6753: 	return '</tr>'."\n";;
1.347     albertel 6754:     }
1.367     www      6755: 
1.421     albertel 6756:     sub start_data_table_empty_row {
1.707     bisitz   6757: #	$row_count[0]++;
1.421     albertel 6758: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6759:     }
                   6760: 
                   6761:     sub end_data_table_empty_row {
                   6762: 	return '</tr>'."\n";;
                   6763:     }
                   6764: 
1.367     www      6765:     sub start_data_table_header_row {
1.389     albertel 6766: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6767:     }
                   6768: 
                   6769:     sub end_data_table_header_row {
1.389     albertel 6770: 	return '</tr>'."\n";;
1.367     www      6771:     }
1.890     droeschl 6772: 
                   6773:     sub data_table_caption {
                   6774:         my $caption = shift;
                   6775:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6776:     }
1.347     albertel 6777: }
                   6778: 
1.548     albertel 6779: =pod
                   6780: 
                   6781: =item * &inhibit_menu_check($arg)
                   6782: 
                   6783: Checks for a inhibitmenu state and generates output to preserve it
                   6784: 
                   6785: Inputs:         $arg - can be any of
                   6786:                      - undef - in which case the return value is a string 
                   6787:                                to add  into arguments list of a uri
                   6788:                      - 'input' - in which case the return value is a HTML
                   6789:                                  <form> <input> field of type hidden to
                   6790:                                  preserve the value
                   6791:                      - a url - in which case the return value is the url with
                   6792:                                the neccesary cgi args added to preserve the
                   6793:                                inhibitmenu state
                   6794:                      - a ref to a url - no return value, but the string is
                   6795:                                         updated to include the neccessary cgi
                   6796:                                         args to preserve the inhibitmenu state
                   6797: 
                   6798: =cut
                   6799: 
                   6800: sub inhibit_menu_check {
                   6801:     my ($arg) = @_;
                   6802:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6803:     if ($arg eq 'input') {
                   6804: 	if ($env{'form.inhibitmenu'}) {
                   6805: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6806: 	} else {
                   6807: 	    return
                   6808: 	}
                   6809:     }
                   6810:     if ($env{'form.inhibitmenu'}) {
                   6811: 	if (ref($arg)) {
                   6812: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6813: 	} elsif ($arg eq '') {
                   6814: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6815: 	} else {
                   6816: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6817: 	}
                   6818:     }
                   6819:     if (!ref($arg)) {
                   6820: 	return $arg;
                   6821:     }
                   6822: }
                   6823: 
1.251     albertel 6824: ###############################################
1.182     matthew  6825: 
                   6826: =pod
                   6827: 
1.549     albertel 6828: =back
                   6829: 
                   6830: =head1 User Information Routines
                   6831: 
                   6832: =over 4
                   6833: 
1.405     albertel 6834: =item * &get_users_function()
1.182     matthew  6835: 
                   6836: Used by &bodytag to determine the current users primary role.
                   6837: Returns either 'student','coordinator','admin', or 'author'.
                   6838: 
                   6839: =cut
                   6840: 
                   6841: ###############################################
                   6842: sub get_users_function {
1.815     tempelho 6843:     my $function = 'norole';
1.818     tempelho 6844:     if ($env{'request.role'}=~/^(st)/) {
                   6845:         $function='student';
                   6846:     }
1.258     albertel 6847:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6848:         $function='coordinator';
                   6849:     }
1.258     albertel 6850:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6851:         $function='admin';
                   6852:     }
1.826     bisitz   6853:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6854:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6855:         $function='author';
                   6856:     }
                   6857:     return $function;
1.54      www      6858: }
1.99      www      6859: 
                   6860: ###############################################
                   6861: 
1.233     raeburn  6862: =pod
                   6863: 
1.821     raeburn  6864: =item * &show_course()
                   6865: 
                   6866: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6867: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6868: 
                   6869: Inputs:
                   6870: None
                   6871: 
                   6872: Outputs:
                   6873: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6874: 
                   6875: =cut
                   6876: 
                   6877: ###############################################
                   6878: sub show_course {
                   6879:     my $course = !$env{'user.adv'};
                   6880:     if (!$env{'user.adv'}) {
                   6881:         foreach my $env (keys(%env)) {
                   6882:             next if ($env !~ m/^user\.priv\./);
                   6883:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6884:                 $course = 0;
                   6885:                 last;
                   6886:             }
                   6887:         }
                   6888:     }
                   6889:     return $course;
                   6890: }
                   6891: 
                   6892: ###############################################
                   6893: 
                   6894: =pod
                   6895: 
1.542     raeburn  6896: =item * &check_user_status()
1.274     raeburn  6897: 
                   6898: Determines current status of supplied role for a
                   6899: specific user. Roles can be active, previous or future.
                   6900: 
                   6901: Inputs: 
                   6902: user's domain, user's username, course's domain,
1.375     raeburn  6903: course's number, optional section ID.
1.274     raeburn  6904: 
                   6905: Outputs:
                   6906: role status: active, previous or future. 
                   6907: 
                   6908: =cut
                   6909: 
                   6910: sub check_user_status {
1.412     raeburn  6911:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6912:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6913:     my @uroles = keys %userinfo;
                   6914:     my $srchstr;
                   6915:     my $active_chk = 'none';
1.412     raeburn  6916:     my $now = time;
1.274     raeburn  6917:     if (@uroles > 0) {
1.412     raeburn  6918:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6919:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6920:         } else {
1.412     raeburn  6921:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6922:         }
                   6923:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6924:             my $role_end = 0;
                   6925:             my $role_start = 0;
                   6926:             $active_chk = 'active';
1.412     raeburn  6927:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6928:                 $role_end = $1;
                   6929:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6930:                     $role_start = $1;
1.274     raeburn  6931:                 }
                   6932:             }
                   6933:             if ($role_start > 0) {
1.412     raeburn  6934:                 if ($now < $role_start) {
1.274     raeburn  6935:                     $active_chk = 'future';
                   6936:                 }
                   6937:             }
                   6938:             if ($role_end > 0) {
1.412     raeburn  6939:                 if ($now > $role_end) {
1.274     raeburn  6940:                     $active_chk = 'previous';
                   6941:                 }
                   6942:             }
                   6943:         }
                   6944:     }
                   6945:     return $active_chk;
                   6946: }
                   6947: 
                   6948: ###############################################
                   6949: 
                   6950: =pod
                   6951: 
1.405     albertel 6952: =item * &get_sections()
1.233     raeburn  6953: 
                   6954: Determines all the sections for a course including
                   6955: sections with students and sections containing other roles.
1.419     raeburn  6956: Incoming parameters: 
                   6957: 
                   6958: 1. domain
                   6959: 2. course number 
                   6960: 3. reference to array containing roles for which sections should 
                   6961: be gathered (optional).
                   6962: 4. reference to array containing status types for which sections 
                   6963: should be gathered (optional).
                   6964: 
                   6965: If the third argument is undefined, sections are gathered for any role. 
                   6966: If the fourth argument is undefined, sections are gathered for any status.
                   6967: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6968:  
1.374     raeburn  6969: Returns section hash (keys are section IDs, values are
                   6970: number of users in each section), subject to the
1.419     raeburn  6971: optional roles filter, optional status filter 
1.233     raeburn  6972: 
                   6973: =cut
                   6974: 
                   6975: ###############################################
                   6976: sub get_sections {
1.419     raeburn  6977:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6978:     if (!defined($cdom) || !defined($cnum)) {
                   6979:         my $cid =  $env{'request.course.id'};
                   6980: 
                   6981: 	return if (!defined($cid));
                   6982: 
                   6983:         $cdom = $env{'course.'.$cid.'.domain'};
                   6984:         $cnum = $env{'course.'.$cid.'.num'};
                   6985:     }
                   6986: 
                   6987:     my %sectioncount;
1.419     raeburn  6988:     my $now = time;
1.240     albertel 6989: 
1.366     albertel 6990:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6991: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6992: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6993: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6994:         my $start_index = &Apache::loncoursedata::CL_START();
                   6995:         my $end_index = &Apache::loncoursedata::CL_END();
                   6996:         my $status;
1.366     albertel 6997: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6998: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6999: 				                     $data->[$status_index],
                   7000:                                                      $data->[$start_index],
                   7001:                                                      $data->[$end_index]);
                   7002:             if ($stu_status eq 'Active') {
                   7003:                 $status = 'active';
                   7004:             } elsif ($end < $now) {
                   7005:                 $status = 'previous';
                   7006:             } elsif ($start > $now) {
                   7007:                 $status = 'future';
                   7008:             } 
                   7009: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7010:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7011:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7012: 		    $sectioncount{$section}++;
                   7013:                 }
1.240     albertel 7014: 	    }
                   7015: 	}
                   7016:     }
                   7017:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7018:     foreach my $user (sort(keys(%courseroles))) {
                   7019: 	if ($user !~ /^(\w{2})/) { next; }
                   7020: 	my ($role) = ($user =~ /^(\w{2})/);
                   7021: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7022: 	my ($section,$status);
1.240     albertel 7023: 	if ($role eq 'cr' &&
                   7024: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7025: 	    $section=$1;
                   7026: 	}
                   7027: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7028: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7029:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7030:         if ($end == -1 && $start == -1) {
                   7031:             next; #deleted role
                   7032:         }
                   7033:         if (!defined($possible_status)) { 
                   7034:             $sectioncount{$section}++;
                   7035:         } else {
                   7036:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7037:                 $status = 'active';
                   7038:             } elsif ($end < $now) {
                   7039:                 $status = 'future';
                   7040:             } elsif ($start > $now) {
                   7041:                 $status = 'previous';
                   7042:             }
                   7043:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7044:                 $sectioncount{$section}++;
                   7045:             }
                   7046:         }
1.233     raeburn  7047:     }
1.366     albertel 7048:     return %sectioncount;
1.233     raeburn  7049: }
                   7050: 
1.274     raeburn  7051: ###############################################
1.294     raeburn  7052: 
                   7053: =pod
1.405     albertel 7054: 
                   7055: =item * &get_course_users()
                   7056: 
1.275     raeburn  7057: Retrieves usernames:domains for users in the specified course
                   7058: with specific role(s), and access status. 
                   7059: 
                   7060: Incoming parameters:
1.277     albertel 7061: 1. course domain
                   7062: 2. course number
                   7063: 3. access status: users must have - either active, 
1.275     raeburn  7064: previous, future, or all.
1.277     albertel 7065: 4. reference to array of permissible roles
1.288     raeburn  7066: 5. reference to array of section restrictions (optional)
                   7067: 6. reference to results object (hash of hashes).
                   7068: 7. reference to optional userdata hash
1.609     raeburn  7069: 8. reference to optional statushash
1.630     raeburn  7070: 9. flag if privileged users (except those set to unhide in
                   7071:    course settings) should be excluded    
1.609     raeburn  7072: Keys of top level results hash are roles.
1.275     raeburn  7073: Keys of inner hashes are username:domain, with 
                   7074: values set to access type.
1.288     raeburn  7075: Optional userdata hash returns an array with arguments in the 
                   7076: same order as loncoursedata::get_classlist() for student data.
                   7077: 
1.609     raeburn  7078: Optional statushash returns
                   7079: 
1.288     raeburn  7080: Entries for end, start, section and status are blank because
                   7081: of the possibility of multiple values for non-student roles.
                   7082: 
1.275     raeburn  7083: =cut
1.405     albertel 7084: 
1.275     raeburn  7085: ###############################################
1.405     albertel 7086: 
1.275     raeburn  7087: sub get_course_users {
1.630     raeburn  7088:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7089:     my %idx = ();
1.419     raeburn  7090:     my %seclists;
1.288     raeburn  7091: 
                   7092:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7093:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7094:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7095:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7096:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7097:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7098:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7099:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7100: 
1.290     albertel 7101:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7102:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7103:         my $now = time;
1.277     albertel 7104:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7105:             my $match = 0;
1.412     raeburn  7106:             my $secmatch = 0;
1.419     raeburn  7107:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7108:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7109:             if ($section eq '') {
                   7110:                 $section = 'none';
                   7111:             }
1.291     albertel 7112:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7113:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7114:                     $secmatch = 1;
                   7115:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7116:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7117:                         $secmatch = 1;
                   7118:                     }
                   7119:                 } else {  
1.419     raeburn  7120: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7121: 		        $secmatch = 1;
                   7122:                     }
1.290     albertel 7123: 		}
1.412     raeburn  7124:                 if (!$secmatch) {
                   7125:                     next;
                   7126:                 }
1.419     raeburn  7127:             }
1.275     raeburn  7128:             if (defined($$types{'active'})) {
1.288     raeburn  7129:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7130:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7131:                     $match = 1;
1.275     raeburn  7132:                 }
                   7133:             }
                   7134:             if (defined($$types{'previous'})) {
1.609     raeburn  7135:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7136:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7137:                     $match = 1;
1.275     raeburn  7138:                 }
                   7139:             }
                   7140:             if (defined($$types{'future'})) {
1.609     raeburn  7141:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7142:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7143:                     $match = 1;
1.275     raeburn  7144:                 }
                   7145:             }
1.609     raeburn  7146:             if ($match) {
                   7147:                 push(@{$seclists{$student}},$section);
                   7148:                 if (ref($userdata) eq 'HASH') {
                   7149:                     $$userdata{$student} = $$classlist{$student};
                   7150:                 }
                   7151:                 if (ref($statushash) eq 'HASH') {
                   7152:                     $statushash->{$student}{'st'}{$section} = $status;
                   7153:                 }
1.288     raeburn  7154:             }
1.275     raeburn  7155:         }
                   7156:     }
1.412     raeburn  7157:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7158:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7159:         my $now = time;
1.609     raeburn  7160:         my %displaystatus = ( previous => 'Expired',
                   7161:                               active   => 'Active',
                   7162:                               future   => 'Future',
                   7163:                             );
1.630     raeburn  7164:         my %nothide;
                   7165:         if ($hidepriv) {
                   7166:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7167:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7168:                 if ($user !~ /:/) {
                   7169:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7170:                 } else {
                   7171:                     $nothide{$user} = 1;
                   7172:                 }
                   7173:             }
                   7174:         }
1.439     raeburn  7175:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7176:             my $match = 0;
1.412     raeburn  7177:             my $secmatch = 0;
1.439     raeburn  7178:             my $status;
1.412     raeburn  7179:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7180:             $user =~ s/:$//;
1.439     raeburn  7181:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7182:             if ($end == -1 || $start == -1) {
                   7183:                 next;
                   7184:             }
                   7185:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7186:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7187:                 my ($uname,$udom) = split(/:/,$user);
                   7188:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7189:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7190:                         $secmatch = 1;
                   7191:                     } elsif ($usec eq '') {
1.420     albertel 7192:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7193:                             $secmatch = 1;
                   7194:                         }
                   7195:                     } else {
                   7196:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7197:                             $secmatch = 1;
                   7198:                         }
                   7199:                     }
                   7200:                     if (!$secmatch) {
                   7201:                         next;
                   7202:                     }
1.288     raeburn  7203:                 }
1.419     raeburn  7204:                 if ($usec eq '') {
                   7205:                     $usec = 'none';
                   7206:                 }
1.275     raeburn  7207:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7208:                     if ($hidepriv) {
                   7209:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7210:                             (!$nothide{$uname.':'.$udom})) {
                   7211:                             next;
                   7212:                         }
                   7213:                     }
1.503     raeburn  7214:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7215:                         $status = 'previous';
                   7216:                     } elsif ($start > $now) {
                   7217:                         $status = 'future';
                   7218:                     } else {
                   7219:                         $status = 'active';
                   7220:                     }
1.277     albertel 7221:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7222:                         if ($status eq $type) {
1.420     albertel 7223:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7224:                                 push(@{$$users{$role}{$user}},$type);
                   7225:                             }
1.288     raeburn  7226:                             $match = 1;
                   7227:                         }
                   7228:                     }
1.419     raeburn  7229:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7230:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7231: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7232:                         }
1.420     albertel 7233:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7234:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7235:                         }
1.609     raeburn  7236:                         if (ref($statushash) eq 'HASH') {
                   7237:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7238:                         }
1.275     raeburn  7239:                     }
                   7240:                 }
                   7241:             }
                   7242:         }
1.290     albertel 7243:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7244:             if ((defined($cdom)) && (defined($cnum))) {
                   7245:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7246:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7247:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7248:                     next if ($owner eq '');
                   7249:                     my ($ownername,$ownerdom);
                   7250:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7251:                         $ownername = $1;
                   7252:                         $ownerdom = $2;
                   7253:                     } else {
                   7254:                         $ownername = $owner;
                   7255:                         $ownerdom = $cdom;
                   7256:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7257:                     }
                   7258:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7259:                     if (defined($userdata) && 
1.609     raeburn  7260: 			!exists($$userdata{$owner})) {
                   7261: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7262:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7263:                             push(@{$seclists{$owner}},'none');
                   7264:                         }
                   7265:                         if (ref($statushash) eq 'HASH') {
                   7266:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7267:                         }
1.290     albertel 7268: 		    }
1.279     raeburn  7269:                 }
                   7270:             }
                   7271:         }
1.419     raeburn  7272:         foreach my $user (keys(%seclists)) {
                   7273:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7274:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7275:         }
1.275     raeburn  7276:     }
                   7277:     return;
                   7278: }
                   7279: 
1.288     raeburn  7280: sub get_user_info {
                   7281:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7282:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7283: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7284:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7285:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7286:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7287:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7288:     return;
                   7289: }
1.275     raeburn  7290: 
1.472     raeburn  7291: ###############################################
                   7292: 
                   7293: =pod
                   7294: 
                   7295: =item * &get_user_quota()
                   7296: 
                   7297: Retrieves quota assigned for storage of portfolio files for a user  
                   7298: 
                   7299: Incoming parameters:
                   7300: 1. user's username
                   7301: 2. user's domain
                   7302: 
                   7303: Returns:
1.536     raeburn  7304: 1. Disk quota (in Mb) assigned to student.
                   7305: 2. (Optional) Type of setting: custom or default
                   7306:    (individually assigned or default for user's 
                   7307:    institutional status).
                   7308: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7309:    or student - types as defined in localenroll::inst_usertypes 
                   7310:    for user's domain, which determines default quota for user.
                   7311: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7312: 
                   7313: If a value has been stored in the user's environment, 
1.536     raeburn  7314: it will return that, otherwise it returns the maximal default
                   7315: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7316: 
                   7317: =cut
                   7318: 
                   7319: ###############################################
                   7320: 
                   7321: 
                   7322: sub get_user_quota {
                   7323:     my ($uname,$udom) = @_;
1.536     raeburn  7324:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7325:     if (!defined($udom)) {
                   7326:         $udom = $env{'user.domain'};
                   7327:     }
                   7328:     if (!defined($uname)) {
                   7329:         $uname = $env{'user.name'};
                   7330:     }
                   7331:     if (($udom eq '' || $uname eq '') ||
                   7332:         ($udom eq 'public') && ($uname eq 'public')) {
                   7333:         $quota = 0;
1.536     raeburn  7334:         $quotatype = 'default';
                   7335:         $defquota = 0; 
1.472     raeburn  7336:     } else {
1.536     raeburn  7337:         my $inststatus;
1.472     raeburn  7338:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7339:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7340:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7341:         } else {
1.536     raeburn  7342:             my %userenv = 
                   7343:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7344:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7345:             my ($tmp) = keys(%userenv);
                   7346:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7347:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7348:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7349:             } else {
                   7350:                 undef(%userenv);
                   7351:             }
                   7352:         }
1.536     raeburn  7353:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7354:         if ($quota eq '') {
1.536     raeburn  7355:             $quota = $defquota;
                   7356:             $quotatype = 'default';
                   7357:         } else {
                   7358:             $quotatype = 'custom';
1.472     raeburn  7359:         }
                   7360:     }
1.536     raeburn  7361:     if (wantarray) {
                   7362:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7363:     } else {
                   7364:         return $quota;
                   7365:     }
1.472     raeburn  7366: }
                   7367: 
                   7368: ###############################################
                   7369: 
                   7370: =pod
                   7371: 
                   7372: =item * &default_quota()
                   7373: 
1.536     raeburn  7374: Retrieves default quota assigned for storage of user portfolio files,
                   7375: given an (optional) user's institutional status.
1.472     raeburn  7376: 
                   7377: Incoming parameters:
                   7378: 1. domain
1.536     raeburn  7379: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7380:    status types (e.g., faculty, staff, student etc.)
                   7381:    which apply to the user for whom the default is being retrieved.
                   7382:    If the institutional status string in undefined, the domain
                   7383:    default quota will be returned. 
1.472     raeburn  7384: 
                   7385: Returns:
                   7386: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7387: 2. (Optional) institutional type which determined the value of the
                   7388:    default quota.
1.472     raeburn  7389: 
                   7390: If a value has been stored in the domain's configuration db,
                   7391: it will return that, otherwise it returns 20 (for backwards 
                   7392: compatibility with domains which have not set up a configuration
                   7393: db file; the original statically defined portfolio quota was 20 Mb). 
                   7394: 
1.536     raeburn  7395: If the user's status includes multiple types (e.g., staff and student),
                   7396: the largest default quota which applies to the user determines the
                   7397: default quota returned.
                   7398: 
1.780     raeburn  7399: =back
                   7400: 
1.472     raeburn  7401: =cut
                   7402: 
                   7403: ###############################################
                   7404: 
                   7405: 
                   7406: sub default_quota {
1.536     raeburn  7407:     my ($udom,$inststatus) = @_;
                   7408:     my ($defquota,$settingstatus);
                   7409:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7410:                                             ['quotas'],$udom);
                   7411:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7412:         if ($inststatus ne '') {
1.765     raeburn  7413:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7414:             foreach my $item (@statuses) {
1.711     raeburn  7415:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7416:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7417:                         if ($defquota eq '') {
                   7418:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7419:                             $settingstatus = $item;
                   7420:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7421:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7422:                             $settingstatus = $item;
                   7423:                         }
                   7424:                     }
                   7425:                 } else {
                   7426:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7427:                         if ($defquota eq '') {
                   7428:                             $defquota = $quotahash{'quotas'}{$item};
                   7429:                             $settingstatus = $item;
                   7430:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7431:                             $defquota = $quotahash{'quotas'}{$item};
                   7432:                             $settingstatus = $item;
                   7433:                         }
1.536     raeburn  7434:                     }
                   7435:                 }
                   7436:             }
                   7437:         }
                   7438:         if ($defquota eq '') {
1.711     raeburn  7439:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7440:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7441:             } else {
                   7442:                 $defquota = $quotahash{'quotas'}{'default'};
                   7443:             }
1.536     raeburn  7444:             $settingstatus = 'default';
                   7445:         }
                   7446:     } else {
                   7447:         $settingstatus = 'default';
                   7448:         $defquota = 20;
                   7449:     }
                   7450:     if (wantarray) {
                   7451:         return ($defquota,$settingstatus);
1.472     raeburn  7452:     } else {
1.536     raeburn  7453:         return $defquota;
1.472     raeburn  7454:     }
                   7455: }
                   7456: 
1.384     raeburn  7457: sub get_secgrprole_info {
                   7458:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7459:     my %sections_count = &get_sections($cdom,$cnum);
                   7460:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7461:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7462:     my @groups = sort(keys(%curr_groups));
                   7463:     my $allroles = [];
                   7464:     my $rolehash;
                   7465:     my $accesshash = {
                   7466:                      active => 'Currently has access',
                   7467:                      future => 'Will have future access',
                   7468:                      previous => 'Previously had access',
                   7469:                   };
                   7470:     if ($needroles) {
                   7471:         $rolehash = {'all' => 'all'};
1.385     albertel 7472:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7473: 	if (&Apache::lonnet::error(%user_roles)) {
                   7474: 	    undef(%user_roles);
                   7475: 	}
                   7476:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7477:             my ($role)=split(/\:/,$item,2);
                   7478:             if ($role eq 'cr') { next; }
                   7479:             if ($role =~ /^cr/) {
                   7480:                 $$rolehash{$role} = (split('/',$role))[3];
                   7481:             } else {
                   7482:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7483:             }
                   7484:         }
                   7485:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7486:             push(@{$allroles},$key);
                   7487:         }
                   7488:         push (@{$allroles},'st');
                   7489:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7490:     }
                   7491:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7492: }
                   7493: 
1.555     raeburn  7494: sub user_picker {
1.627     raeburn  7495:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7496:     my $currdom = $dom;
                   7497:     my %curr_selected = (
                   7498:                         srchin => 'dom',
1.580     raeburn  7499:                         srchby => 'lastname',
1.555     raeburn  7500:                       );
                   7501:     my $srchterm;
1.625     raeburn  7502:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7503:         if ($srch->{'srchby'} ne '') {
                   7504:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7505:         }
                   7506:         if ($srch->{'srchin'} ne '') {
                   7507:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7508:         }
                   7509:         if ($srch->{'srchtype'} ne '') {
                   7510:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7511:         }
                   7512:         if ($srch->{'srchdomain'} ne '') {
                   7513:             $currdom = $srch->{'srchdomain'};
                   7514:         }
                   7515:         $srchterm = $srch->{'srchterm'};
                   7516:     }
                   7517:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7518:                     'usr'       => 'Search criteria',
1.563     raeburn  7519:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7520:                     'uname'     => 'username',
                   7521:                     'lastname'  => 'last name',
1.555     raeburn  7522:                     'lastfirst' => 'last name, first name',
1.558     albertel 7523:                     'crs'       => 'in this course',
1.576     raeburn  7524:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7525:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7526:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7527:                     'exact'     => 'is',
                   7528:                     'contains'  => 'contains',
1.569     raeburn  7529:                     'begins'    => 'begins with',
1.571     raeburn  7530:                     'youm'      => "You must include some text to search for.",
                   7531:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7532:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7533:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7534:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7535:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7536:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7537:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7538:                                        );
1.563     raeburn  7539:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7540:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7541: 
                   7542:     my @srchins = ('crs','dom','alc','instd');
                   7543: 
                   7544:     foreach my $option (@srchins) {
                   7545:         # FIXME 'alc' option unavailable until 
                   7546:         #       loncreateuser::print_user_query_page()
                   7547:         #       has been completed.
                   7548:         next if ($option eq 'alc');
1.880     raeburn  7549:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7550:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7551:         if ($curr_selected{'srchin'} eq $option) {
                   7552:             $srchinsel .= ' 
                   7553:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7554:         } else {
                   7555:             $srchinsel .= '
                   7556:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7557:         }
1.555     raeburn  7558:     }
1.563     raeburn  7559:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7560: 
                   7561:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7562:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7563:         if ($curr_selected{'srchby'} eq $option) {
                   7564:             $srchbysel .= '
                   7565:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7566:         } else {
                   7567:             $srchbysel .= '
                   7568:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7569:          }
                   7570:     }
                   7571:     $srchbysel .= "\n  </select>\n";
                   7572: 
                   7573:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7574:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7575:         if ($curr_selected{'srchtype'} eq $option) {
                   7576:             $srchtypesel .= '
                   7577:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7578:         } else {
                   7579:             $srchtypesel .= '
                   7580:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7581:         }
                   7582:     }
                   7583:     $srchtypesel .= "\n  </select>\n";
                   7584: 
1.558     albertel 7585:     my ($newuserscript,$new_user_create);
1.556     raeburn  7586: 
                   7587:     if ($forcenewuser) {
1.576     raeburn  7588:         if (ref($srch) eq 'HASH') {
                   7589:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7590:                 if ($cancreate) {
                   7591:                     $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>';
                   7592:                 } else {
1.799     bisitz   7593:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7594:                     my %usertypetext = (
                   7595:                         official   => 'institutional',
                   7596:                         unofficial => 'non-institutional',
                   7597:                     );
1.799     bisitz   7598:                     $new_user_create = '<p class="LC_warning">'
                   7599:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7600:                                       .' '
                   7601:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7602:                                           ,'<a href="'.$helplink.'">','</a>')
                   7603:                                       .'</p><br />';
1.627     raeburn  7604:                 }
1.576     raeburn  7605:             }
                   7606:         }
                   7607: 
1.556     raeburn  7608:         $newuserscript = <<"ENDSCRIPT";
                   7609: 
1.570     raeburn  7610: function setSearch(createnew,callingForm) {
1.556     raeburn  7611:     if (createnew == 1) {
1.570     raeburn  7612:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7613:             if (callingForm.srchby.options[i].value == 'uname') {
                   7614:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7615:             }
                   7616:         }
1.570     raeburn  7617:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7618:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7619: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7620:             }
                   7621:         }
1.570     raeburn  7622:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7623:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7624:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7625:             }
                   7626:         }
1.570     raeburn  7627:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7628:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7629:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7630:             }
                   7631:         }
                   7632:     }
                   7633: }
                   7634: ENDSCRIPT
1.558     albertel 7635: 
1.556     raeburn  7636:     }
                   7637: 
1.555     raeburn  7638:     my $output = <<"END_BLOCK";
1.556     raeburn  7639: <script type="text/javascript">
1.824     bisitz   7640: // <![CDATA[
1.570     raeburn  7641: function validateEntry(callingForm) {
1.558     albertel 7642: 
1.556     raeburn  7643:     var checkok = 1;
1.558     albertel 7644:     var srchin;
1.570     raeburn  7645:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7646: 	if ( callingForm.srchin[i].checked ) {
                   7647: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7648: 	}
                   7649:     }
                   7650: 
1.570     raeburn  7651:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7652:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7653:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7654:     var srchterm =  callingForm.srchterm.value;
                   7655:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7656:     var msg = "";
                   7657: 
                   7658:     if (srchterm == "") {
                   7659:         checkok = 0;
1.571     raeburn  7660:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7661:     }
                   7662: 
1.569     raeburn  7663:     if (srchtype== 'begins') {
                   7664:         if (srchterm.length < 2) {
                   7665:             checkok = 0;
1.571     raeburn  7666:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7667:         }
                   7668:     }
                   7669: 
1.556     raeburn  7670:     if (srchtype== 'contains') {
                   7671:         if (srchterm.length < 3) {
                   7672:             checkok = 0;
1.571     raeburn  7673:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7674:         }
                   7675:     }
                   7676:     if (srchin == 'instd') {
                   7677:         if (srchdomain == '') {
                   7678:             checkok = 0;
1.571     raeburn  7679:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7680:         }
                   7681:     }
                   7682:     if (srchin == 'dom') {
                   7683:         if (srchdomain == '') {
                   7684:             checkok = 0;
1.571     raeburn  7685:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7686:         }
                   7687:     }
                   7688:     if (srchby == 'lastfirst') {
                   7689:         if (srchterm.indexOf(",") == -1) {
                   7690:             checkok = 0;
1.571     raeburn  7691:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7692:         }
                   7693:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7694:             checkok = 0;
1.571     raeburn  7695:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7696:         }
                   7697:     }
                   7698:     if (checkok == 0) {
1.571     raeburn  7699:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7700:         return;
                   7701:     }
                   7702:     if (checkok == 1) {
1.570     raeburn  7703:         callingForm.submit();
1.556     raeburn  7704:     }
                   7705: }
                   7706: 
                   7707: $newuserscript
                   7708: 
1.824     bisitz   7709: // ]]>
1.556     raeburn  7710: </script>
1.558     albertel 7711: 
                   7712: $new_user_create
                   7713: 
1.555     raeburn  7714: END_BLOCK
1.558     albertel 7715: 
1.876     raeburn  7716:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7717:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7718:                $domform.
                   7719:                &Apache::lonhtmlcommon::row_closure().
                   7720:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7721:                $srchbysel.
                   7722:                $srchtypesel. 
                   7723:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7724:                $srchinsel.
                   7725:                &Apache::lonhtmlcommon::row_closure(1). 
                   7726:                &Apache::lonhtmlcommon::end_pick_box().
                   7727:                '<br />';
1.555     raeburn  7728:     return $output;
                   7729: }
                   7730: 
1.612     raeburn  7731: sub user_rule_check {
1.615     raeburn  7732:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7733:     my $response;
                   7734:     if (ref($usershash) eq 'HASH') {
                   7735:         foreach my $user (keys(%{$usershash})) {
                   7736:             my ($uname,$udom) = split(/:/,$user);
                   7737:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7738:             my ($id,$newuser);
1.612     raeburn  7739:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7740:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7741:                 $id = $usershash->{$user}->{'id'};
                   7742:             }
                   7743:             my $inst_response;
                   7744:             if (ref($checks) eq 'HASH') {
                   7745:                 if (defined($checks->{'username'})) {
1.615     raeburn  7746:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7747:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7748:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7749:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7750:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7751:                 }
1.615     raeburn  7752:             } else {
                   7753:                 ($inst_response,%{$inst_results->{$user}}) =
                   7754:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7755:                 return;
1.612     raeburn  7756:             }
1.615     raeburn  7757:             if (!$got_rules->{$udom}) {
1.612     raeburn  7758:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7759:                                                   ['usercreation'],$udom);
                   7760:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7761:                     foreach my $item ('username','id') {
1.612     raeburn  7762:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7763:                             $$curr_rules{$udom}{$item} = 
                   7764:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7765:                         }
                   7766:                     }
                   7767:                 }
1.615     raeburn  7768:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7769:             }
1.612     raeburn  7770:             foreach my $item (keys(%{$checks})) {
                   7771:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7772:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7773:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7774:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7775:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7776:                                 if ($rule_check{$rule}) {
                   7777:                                     $$rulematch{$user}{$item} = $rule;
                   7778:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7779:                                         if (ref($inst_results) eq 'HASH') {
                   7780:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7781:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7782:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7783:                                                 }
1.612     raeburn  7784:                                             }
                   7785:                                         }
1.615     raeburn  7786:                                     }
                   7787:                                     last;
1.585     raeburn  7788:                                 }
                   7789:                             }
                   7790:                         }
                   7791:                     }
                   7792:                 }
                   7793:             }
                   7794:         }
                   7795:     }
1.612     raeburn  7796:     return;
                   7797: }
                   7798: 
                   7799: sub user_rule_formats {
                   7800:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7801:     my %text = ( 
                   7802:                  'username' => 'Usernames',
                   7803:                  'id'       => 'IDs',
                   7804:                );
                   7805:     my $output;
                   7806:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7807:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7808:         if (@{$ruleorder} > 0) {
                   7809:             $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>';
                   7810:             foreach my $rule (@{$ruleorder}) {
                   7811:                 if (ref($curr_rules) eq 'ARRAY') {
                   7812:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7813:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7814:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7815:                                         $rules->{$rule}{'desc'}.'</li>';
                   7816:                         }
                   7817:                     }
                   7818:                 }
                   7819:             }
                   7820:             $output .= '</ul>';
                   7821:         }
                   7822:     }
                   7823:     return $output;
                   7824: }
                   7825: 
                   7826: sub instrule_disallow_msg {
1.615     raeburn  7827:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7828:     my $response;
                   7829:     my %text = (
                   7830:                   item   => 'username',
                   7831:                   items  => 'usernames',
                   7832:                   match  => 'matches',
                   7833:                   do     => 'does',
                   7834:                   action => 'a username',
                   7835:                   one    => 'one',
                   7836:                );
                   7837:     if ($count > 1) {
                   7838:         $text{'item'} = 'usernames';
                   7839:         $text{'match'} ='match';
                   7840:         $text{'do'} = 'do';
                   7841:         $text{'action'} = 'usernames',
                   7842:         $text{'one'} = 'ones';
                   7843:     }
                   7844:     if ($checkitem eq 'id') {
                   7845:         $text{'items'} = 'IDs';
                   7846:         $text{'item'} = 'ID';
                   7847:         $text{'action'} = 'an ID';
1.615     raeburn  7848:         if ($count > 1) {
                   7849:             $text{'item'} = 'IDs';
                   7850:             $text{'action'} = 'IDs';
                   7851:         }
1.612     raeburn  7852:     }
1.674     bisitz   7853:     $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  7854:     if ($mode eq 'upload') {
                   7855:         if ($checkitem eq 'username') {
                   7856:             $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'}.");
                   7857:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7858:             $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  7859:         }
1.669     raeburn  7860:     } elsif ($mode eq 'selfcreate') {
                   7861:         if ($checkitem eq 'id') {
                   7862:             $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.");
                   7863:         }
1.615     raeburn  7864:     } else {
                   7865:         if ($checkitem eq 'username') {
                   7866:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7867:         } elsif ($checkitem eq 'id') {
                   7868:             $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.");
                   7869:         }
1.612     raeburn  7870:     }
                   7871:     return $response;
1.585     raeburn  7872: }
                   7873: 
1.624     raeburn  7874: sub personal_data_fieldtitles {
                   7875:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7876:                         id => 'Student/Employee ID',
                   7877:                         permanentemail => 'E-mail address',
                   7878:                         lastname => 'Last Name',
                   7879:                         firstname => 'First Name',
                   7880:                         middlename => 'Middle Name',
                   7881:                         generation => 'Generation',
                   7882:                         gen => 'Generation',
1.765     raeburn  7883:                         inststatus => 'Affiliation',
1.624     raeburn  7884:                    );
                   7885:     return %fieldtitles;
                   7886: }
                   7887: 
1.642     raeburn  7888: sub sorted_inst_types {
                   7889:     my ($dom) = @_;
                   7890:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7891:     my $othertitle = &mt('All users');
                   7892:     if ($env{'request.course.id'}) {
1.668     raeburn  7893:         $othertitle  = &mt('Any users');
1.642     raeburn  7894:     }
                   7895:     my @types;
                   7896:     if (ref($order) eq 'ARRAY') {
                   7897:         @types = @{$order};
                   7898:     }
                   7899:     if (@types == 0) {
                   7900:         if (ref($usertypes) eq 'HASH') {
                   7901:             @types = sort(keys(%{$usertypes}));
                   7902:         }
                   7903:     }
                   7904:     if (keys(%{$usertypes}) > 0) {
                   7905:         $othertitle = &mt('Other users');
                   7906:     }
                   7907:     return ($othertitle,$usertypes,\@types);
                   7908: }
                   7909: 
1.645     raeburn  7910: sub get_institutional_codes {
                   7911:     my ($settings,$allcourses,$LC_code) = @_;
                   7912: # Get complete list of course sections to update
                   7913:     my @currsections = ();
                   7914:     my @currxlists = ();
                   7915:     my $coursecode = $$settings{'internal.coursecode'};
                   7916: 
                   7917:     if ($$settings{'internal.sectionnums'} ne '') {
                   7918:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7919:     }
                   7920: 
                   7921:     if ($$settings{'internal.crosslistings'} ne '') {
                   7922:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7923:     }
                   7924: 
                   7925:     if (@currxlists > 0) {
                   7926:         foreach (@currxlists) {
                   7927:             if (m/^([^:]+):(\w*)$/) {
                   7928:                 unless (grep/^$1$/,@{$allcourses}) {
                   7929:                     push @{$allcourses},$1;
                   7930:                     $$LC_code{$1} = $2;
                   7931:                 }
                   7932:             }
                   7933:         }
                   7934:     }
                   7935:  
                   7936:     if (@currsections > 0) {
                   7937:         foreach (@currsections) {
                   7938:             if (m/^(\w+):(\w*)$/) {
                   7939:                 my $sec = $coursecode.$1;
                   7940:                 my $lc_sec = $2;
                   7941:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7942:                     push @{$allcourses},$sec;
                   7943:                     $$LC_code{$sec} = $lc_sec;
                   7944:                 }
                   7945:             }
                   7946:         }
                   7947:     }
                   7948:     return;
                   7949: }
                   7950: 
1.112     bowersj2 7951: =pod
                   7952: 
1.780     raeburn  7953: =head1 Slot Helpers
                   7954: 
                   7955: =over 4
                   7956: 
                   7957: =item * sorted_slots()
                   7958: 
                   7959: Sorts an array of slot names in order of slot start time (earliest first). 
                   7960: 
                   7961: Inputs:
                   7962: 
                   7963: =over 4
                   7964: 
                   7965: slotsarr  - Reference to array of unsorted slot names.
                   7966: 
                   7967: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7968: 
1.549     albertel 7969: =back
                   7970: 
1.780     raeburn  7971: Returns:
                   7972: 
                   7973: =over 4
                   7974: 
                   7975: sorted   - An array of slot names sorted by the start time of the slot.
                   7976: 
                   7977: =back
                   7978: 
                   7979: =back
                   7980: 
                   7981: =cut
                   7982: 
                   7983: 
                   7984: sub sorted_slots {
                   7985:     my ($slotsarr,$slots) = @_;
                   7986:     my @sorted;
                   7987:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7988:         @sorted =
                   7989:             sort {
                   7990:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7991:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7992:                      }
                   7993:                      if (ref($slots->{$a})) { return -1;}
                   7994:                      if (ref($slots->{$b})) { return 1;}
                   7995:                      return 0;
                   7996:                  } @{$slotsarr};
                   7997:     }
                   7998:     return @sorted;
                   7999: }
                   8000: 
                   8001: 
                   8002: =pod
                   8003: 
1.549     albertel 8004: =head1 HTTP Helpers
                   8005: 
                   8006: =over 4
                   8007: 
1.648     raeburn  8008: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8009: 
1.258     albertel 8010: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8011: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8012: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8013: 
                   8014: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8015: $possible_names is an ref to an array of form element names.  As an example:
                   8016: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8017: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8018: 
                   8019: =cut
1.1       albertel 8020: 
1.6       albertel 8021: sub get_unprocessed_cgi {
1.25      albertel 8022:   my ($query,$possible_names)= @_;
1.26      matthew  8023:   # $Apache::lonxml::debug=1;
1.356     albertel 8024:   foreach my $pair (split(/&/,$query)) {
                   8025:     my ($name, $value) = split(/=/,$pair);
1.369     www      8026:     $name = &unescape($name);
1.25      albertel 8027:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8028:       $value =~ tr/+/ /;
                   8029:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8030:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8031:     }
1.16      harris41 8032:   }
1.6       albertel 8033: }
                   8034: 
1.112     bowersj2 8035: =pod
                   8036: 
1.648     raeburn  8037: =item * &cacheheader() 
1.112     bowersj2 8038: 
                   8039: returns cache-controlling header code
                   8040: 
                   8041: =cut
                   8042: 
1.7       albertel 8043: sub cacheheader {
1.258     albertel 8044:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8045:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8046:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8047:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8048:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8049:     return $output;
1.7       albertel 8050: }
                   8051: 
1.112     bowersj2 8052: =pod
                   8053: 
1.648     raeburn  8054: =item * &no_cache($r) 
1.112     bowersj2 8055: 
                   8056: specifies header code to not have cache
                   8057: 
                   8058: =cut
                   8059: 
1.9       albertel 8060: sub no_cache {
1.216     albertel 8061:     my ($r) = @_;
                   8062:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8063: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8064:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8065:     $r->no_cache(1);
                   8066:     $r->header_out("Expires" => $date);
                   8067:     $r->header_out("Pragma" => "no-cache");
1.123     www      8068: }
                   8069: 
                   8070: sub content_type {
1.181     albertel 8071:     my ($r,$type,$charset) = @_;
1.299     foxr     8072:     if ($r) {
                   8073: 	#  Note that printout.pl calls this with undef for $r.
                   8074: 	&no_cache($r);
                   8075:     }
1.258     albertel 8076:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8077:     unless ($charset) {
                   8078: 	$charset=&Apache::lonlocal::current_encoding;
                   8079:     }
                   8080:     if ($charset) { $type.='; charset='.$charset; }
                   8081:     if ($r) {
                   8082: 	$r->content_type($type);
                   8083:     } else {
                   8084: 	print("Content-type: $type\n\n");
                   8085:     }
1.9       albertel 8086: }
1.25      albertel 8087: 
1.112     bowersj2 8088: =pod
                   8089: 
1.648     raeburn  8090: =item * &add_to_env($name,$value) 
1.112     bowersj2 8091: 
1.258     albertel 8092: adds $name to the %env hash with value
1.112     bowersj2 8093: $value, if $name already exists, the entry is converted to an array
                   8094: reference and $value is added to the array.
                   8095: 
                   8096: =cut
                   8097: 
1.25      albertel 8098: sub add_to_env {
                   8099:   my ($name,$value)=@_;
1.258     albertel 8100:   if (defined($env{$name})) {
                   8101:     if (ref($env{$name})) {
1.25      albertel 8102:       #already have multiple values
1.258     albertel 8103:       push(@{ $env{$name} },$value);
1.25      albertel 8104:     } else {
                   8105:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8106:       my $first=$env{$name};
                   8107:       undef($env{$name});
                   8108:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8109:     }
                   8110:   } else {
1.258     albertel 8111:     $env{$name}=$value;
1.25      albertel 8112:   }
1.31      albertel 8113: }
1.149     albertel 8114: 
                   8115: =pod
                   8116: 
1.648     raeburn  8117: =item * &get_env_multiple($name) 
1.149     albertel 8118: 
1.258     albertel 8119: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8120: values may be defined and end up as an array ref.
                   8121: 
                   8122: returns an array of values
                   8123: 
                   8124: =cut
                   8125: 
                   8126: sub get_env_multiple {
                   8127:     my ($name) = @_;
                   8128:     my @values;
1.258     albertel 8129:     if (defined($env{$name})) {
1.149     albertel 8130:         # exists is it an array
1.258     albertel 8131:         if (ref($env{$name})) {
                   8132:             @values=@{ $env{$name} };
1.149     albertel 8133:         } else {
1.258     albertel 8134:             $values[0]=$env{$name};
1.149     albertel 8135:         }
                   8136:     }
                   8137:     return(@values);
                   8138: }
                   8139: 
1.660     raeburn  8140: sub ask_for_embedded_content {
                   8141:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8142:     my $upload_output = '
                   8143:    <form name="upload_embedded" action="'.$actionurl.'"
                   8144:                   method="post" enctype="multipart/form-data">';
                   8145:     $upload_output .= $state;
1.661     raeburn  8146:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8147: 
                   8148:     my $num = 0;
                   8149:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8150:         $upload_output .= &start_data_table_row().
                   8151:             '<td>'.$embed_file.'</td><td>';
                   8152:         if ($args->{'ignore_remote_references'}
                   8153:             && $embed_file =~ m{^\w+://}) {
                   8154:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8155:         } elsif ($args->{'error_on_invalid_names'}
                   8156:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8157: 
                   8158:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8159: 
                   8160:         } else {
                   8161:             $upload_output .='
1.661     raeburn  8162:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8163:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8164:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8165:             $upload_output .=
                   8166:                 "\n\t\t".
                   8167:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8168:                 $attrib.'" />';
                   8169:             if (exists($$codebase{$embed_file})) {
                   8170:                 $upload_output .=
                   8171:                     "\n\t\t".
                   8172:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8173:                     &escape($$codebase{$embed_file}).'" />';
                   8174:             }
                   8175:         }
                   8176:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8177:         $num++;
                   8178:     }
                   8179:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8180:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8181:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8182:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8183:    </form>';
                   8184:     return $upload_output;
                   8185: }
                   8186: 
1.661     raeburn  8187: sub upload_embedded {
                   8188:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8189:         $current_disk_usage) = @_;
                   8190:     my $output;
                   8191:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8192:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8193:         my $orig_uploaded_filename =
                   8194:             $env{'form.embedded_item_'.$i.'.filename'};
                   8195: 
                   8196:         $env{'form.embedded_orig_'.$i} =
                   8197:             &unescape($env{'form.embedded_orig_'.$i});
                   8198:         my ($path,$fname) =
                   8199:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8200:         # no path, whole string is fname
                   8201:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8202: 
                   8203:         $path = $env{'form.currentpath'}.$path;
                   8204:         $fname = &Apache::lonnet::clean_filename($fname);
                   8205:         # See if there is anything left
                   8206:         next if ($fname eq '');
                   8207: 
                   8208:         # Check if file already exists as a file or directory.
                   8209:         my ($state,$msg);
                   8210:         if ($context eq 'portfolio') {
                   8211:             my $port_path = $dirpath;
                   8212:             if ($group ne '') {
                   8213:                 $port_path = "groups/$group/$port_path";
                   8214:             }
                   8215:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8216:                                               $dir_root,$port_path,$disk_quota,
                   8217:                                               $current_disk_usage,$uname,$udom);
                   8218:             if ($state eq 'will_exceed_quota'
                   8219:                 || $state eq 'file_locked'
                   8220:                 || $state eq 'file_exists' ) {
                   8221:                 $output .= $msg;
                   8222:                 next;
                   8223:             }
                   8224:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8225:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8226:             if ($state eq 'exists') {
                   8227:                 $output .= $msg;
                   8228:                 next;
                   8229:             }
                   8230:         }
                   8231:         # Check if extension is valid
                   8232:         if (($fname =~ /\.(\w+)$/) &&
                   8233:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8234:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8235:             next;
                   8236:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8237:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8238:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8239:             next;
                   8240:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8241:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8242:             next;
                   8243:         }
                   8244: 
                   8245:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8246:         if ($context eq 'portfolio') {
                   8247:             my $result=
                   8248:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8249:                                                 $dirpath.$path);
                   8250:             if ($result !~ m|^/uploaded/|) {
                   8251:                 $output .= '<span class="LC_error">'
                   8252:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8253:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8254:                       .'</span><br />';
                   8255:                 next;
                   8256:             } else {
                   8257:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8258:                            $path.$fname.'</span>').'</p>';     
                   8259:             }
                   8260:         } else {
                   8261: # Save the file
                   8262:             my $target = $env{'form.embedded_item_'.$i};
                   8263:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8264:             my $dest = $fullpath.$fname;
                   8265:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8266:             my @parts=split(/\//,$fullpath);
                   8267:             my $count;
                   8268:             my $filepath = $dir_root;
                   8269:             for ($count=4;$count<=$#parts;$count++) {
                   8270:                 $filepath .= "/$parts[$count]";
                   8271:                 if ((-e $filepath)!=1) {
                   8272:                     mkdir($filepath,0770);
                   8273:                 }
                   8274:             }
                   8275:             my $fh;
                   8276:             if (!open($fh,'>'.$dest)) {
                   8277:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8278:                 $output .= '<span class="LC_error">'.
                   8279:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8280:                            '</span><br />';
                   8281:             } else {
                   8282:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8283:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8284:                     $output .= '<span class="LC_error">'.
                   8285:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8286:                               '</span><br />';
                   8287:                 } else {
                   8288:                     if ($context eq 'testbank') {
                   8289:                         $output .= &mt('Embedded file uploaded successfully:').
                   8290:                                    '&nbsp;<a href="'.$url.'">'.
                   8291:                                    $orig_uploaded_filename.'</a><br />';
                   8292:                     } else {
1.705     tempelho 8293:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8294:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8295:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8296:                     }
                   8297:                 }
                   8298:                 close($fh);
                   8299:             }
                   8300:         }
                   8301:     }
                   8302:     return $output;
                   8303: }
                   8304: 
                   8305: sub check_for_existing {
                   8306:     my ($path,$fname,$element) = @_;
                   8307:     my ($state,$msg);
                   8308:     if (-d $path.'/'.$fname) {
                   8309:         $state = 'exists';
                   8310:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8311:     } elsif (-e $path.'/'.$fname) {
                   8312:         $state = 'exists';
                   8313:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8314:     }
                   8315:     if ($state eq 'exists') {
                   8316:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8317:     }
                   8318:     return ($state,$msg);
                   8319: }
                   8320: 
                   8321: sub check_for_upload {
                   8322:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8323:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8324:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8325:     my $getpropath = 1;
                   8326:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8327:                                             $getpropath);
                   8328:     my $found_file = 0;
                   8329:     my $locked_file = 0;
                   8330:     foreach my $line (@dir_list) {
                   8331:         my ($file_name)=split(/\&/,$line,2);
                   8332:         if ($file_name eq $fname){
                   8333:             $file_name = $path.$file_name;
                   8334:             if ($group ne '') {
                   8335:                 $file_name = $group.$file_name;
                   8336:             }
                   8337:             $found_file = 1;
                   8338:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8339:                 $locked_file = 1;
                   8340:             }
                   8341:         }
                   8342:     }
                   8343:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8344:         my $msg = '<span class="LC_error">'.
                   8345:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8346:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8347:         return ('will_exceed_quota',$msg);
                   8348:     } elsif ($found_file) {
                   8349:         if ($locked_file) {
                   8350:             my $msg = '<span class="LC_error">';
                   8351:             $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>');
                   8352:             $msg .= '</span><br />';
                   8353:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8354:             return ('file_locked',$msg);
                   8355:         } else {
                   8356:             my $msg = '<span class="LC_error">';
                   8357:             $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'});
                   8358:             $msg .= '</span>';
                   8359:             $msg .= '<br />';
                   8360:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8361:             return ('file_exists',$msg);
                   8362:         }
                   8363:     }
                   8364: }
                   8365: 
1.31      albertel 8366: 
1.41      ng       8367: =pod
1.45      matthew  8368: 
1.464     albertel 8369: =back
1.41      ng       8370: 
1.112     bowersj2 8371: =head1 CSV Upload/Handling functions
1.38      albertel 8372: 
1.41      ng       8373: =over 4
                   8374: 
1.648     raeburn  8375: =item * &upfile_store($r)
1.41      ng       8376: 
                   8377: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8378: needs $env{'form.upfile'}
1.41      ng       8379: returns $datatoken to be put into hidden field
                   8380: 
                   8381: =cut
1.31      albertel 8382: 
                   8383: sub upfile_store {
                   8384:     my $r=shift;
1.258     albertel 8385:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8386:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8387:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8388:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8389: 
1.258     albertel 8390:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8391: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8392:     {
1.158     raeburn  8393:         my $datafile = $r->dir_config('lonDaemons').
                   8394:                            '/tmp/'.$datatoken.'.tmp';
                   8395:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8396:             print $fh $env{'form.upfile'};
1.158     raeburn  8397:             close($fh);
                   8398:         }
1.31      albertel 8399:     }
                   8400:     return $datatoken;
                   8401: }
                   8402: 
1.56      matthew  8403: =pod
                   8404: 
1.648     raeburn  8405: =item * &load_tmp_file($r)
1.41      ng       8406: 
                   8407: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8408: needs $env{'form.datatoken'},
                   8409: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8410: 
                   8411: =cut
1.31      albertel 8412: 
                   8413: sub load_tmp_file {
                   8414:     my $r=shift;
                   8415:     my @studentdata=();
                   8416:     {
1.158     raeburn  8417:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8418:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8419:         if ( open(my $fh,"<$studentfile") ) {
                   8420:             @studentdata=<$fh>;
                   8421:             close($fh);
                   8422:         }
1.31      albertel 8423:     }
1.258     albertel 8424:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8425: }
                   8426: 
1.56      matthew  8427: =pod
                   8428: 
1.648     raeburn  8429: =item * &upfile_record_sep()
1.41      ng       8430: 
                   8431: Separate uploaded file into records
                   8432: returns array of records,
1.258     albertel 8433: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8434: 
                   8435: =cut
1.31      albertel 8436: 
                   8437: sub upfile_record_sep {
1.258     albertel 8438:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8439:     } else {
1.248     albertel 8440: 	my @records;
1.258     albertel 8441: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8442: 	    if ($line=~/^\s*$/) { next; }
                   8443: 	    push(@records,$line);
                   8444: 	}
                   8445: 	return @records;
1.31      albertel 8446:     }
                   8447: }
                   8448: 
1.56      matthew  8449: =pod
                   8450: 
1.648     raeburn  8451: =item * &record_sep($record)
1.41      ng       8452: 
1.258     albertel 8453: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8454: 
                   8455: =cut
                   8456: 
1.263     www      8457: sub takeleft {
                   8458:     my $index=shift;
                   8459:     return substr('0000'.$index,-4,4);
                   8460: }
                   8461: 
1.31      albertel 8462: sub record_sep {
                   8463:     my $record=shift;
                   8464:     my %components=();
1.258     albertel 8465:     if ($env{'form.upfiletype'} eq 'xml') {
                   8466:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8467:         my $i=0;
1.356     albertel 8468:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8469:             $field=~s/^(\"|\')//;
                   8470:             $field=~s/(\"|\')$//;
1.263     www      8471:             $components{&takeleft($i)}=$field;
1.31      albertel 8472:             $i++;
                   8473:         }
1.258     albertel 8474:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8475:         my $i=0;
1.356     albertel 8476:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8477:             $field=~s/^(\"|\')//;
                   8478:             $field=~s/(\"|\')$//;
1.263     www      8479:             $components{&takeleft($i)}=$field;
1.31      albertel 8480:             $i++;
                   8481:         }
                   8482:     } else {
1.561     www      8483:         my $separator=',';
1.480     banghart 8484:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8485:             $separator=';';
1.480     banghart 8486:         }
1.31      albertel 8487:         my $i=0;
1.561     www      8488: # the character we are looking for to indicate the end of a quote or a record 
                   8489:         my $looking_for=$separator;
                   8490: # do not add the characters to the fields
                   8491:         my $ignore=0;
                   8492: # we just encountered a separator (or the beginning of the record)
                   8493:         my $just_found_separator=1;
                   8494: # store the field we are working on here
                   8495:         my $field='';
                   8496: # work our way through all characters in record
                   8497:         foreach my $character ($record=~/(.)/g) {
                   8498:             if ($character eq $looking_for) {
                   8499:                if ($character ne $separator) {
                   8500: # Found the end of a quote, again looking for separator
                   8501:                   $looking_for=$separator;
                   8502:                   $ignore=1;
                   8503:                } else {
                   8504: # Found a separator, store away what we got
                   8505:                   $components{&takeleft($i)}=$field;
                   8506: 	          $i++;
                   8507:                   $just_found_separator=1;
                   8508:                   $ignore=0;
                   8509:                   $field='';
                   8510:                }
                   8511:                next;
                   8512:             }
                   8513: # single or double quotation marks after a separator indicate beginning of a quote
                   8514: # we are now looking for the end of the quote and need to ignore separators
                   8515:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8516:                $looking_for=$character;
                   8517:                next;
                   8518:             }
                   8519: # ignore would be true after we reached the end of a quote
                   8520:             if ($ignore) { next; }
                   8521:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8522:             $field.=$character;
                   8523:             $just_found_separator=0; 
1.31      albertel 8524:         }
1.561     www      8525: # catch the very last entry, since we never encountered the separator
                   8526:         $components{&takeleft($i)}=$field;
1.31      albertel 8527:     }
                   8528:     return %components;
                   8529: }
                   8530: 
1.144     matthew  8531: ######################################################
                   8532: ######################################################
                   8533: 
1.56      matthew  8534: =pod
                   8535: 
1.648     raeburn  8536: =item * &upfile_select_html()
1.41      ng       8537: 
1.144     matthew  8538: Return HTML code to select a file from the users machine and specify 
                   8539: the file type.
1.41      ng       8540: 
                   8541: =cut
                   8542: 
1.144     matthew  8543: ######################################################
                   8544: ######################################################
1.31      albertel 8545: sub upfile_select_html {
1.144     matthew  8546:     my %Types = (
                   8547:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8548:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8549:                  space => &mt('Space separated'),
                   8550:                  tab   => &mt('Tabulator separated'),
                   8551: #                 xml   => &mt('HTML/XML'),
                   8552:                  );
                   8553:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8554:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8555:     foreach my $type (sort(keys(%Types))) {
                   8556:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8557:     }
                   8558:     $Str .= "</select>\n";
                   8559:     return $Str;
1.31      albertel 8560: }
                   8561: 
1.301     albertel 8562: sub get_samples {
                   8563:     my ($records,$toget) = @_;
                   8564:     my @samples=({});
                   8565:     my $got=0;
                   8566:     foreach my $rec (@$records) {
                   8567: 	my %temp = &record_sep($rec);
                   8568: 	if (! grep(/\S/, values(%temp))) { next; }
                   8569: 	if (%temp) {
                   8570: 	    $samples[$got]=\%temp;
                   8571: 	    $got++;
                   8572: 	    if ($got == $toget) { last; }
                   8573: 	}
                   8574:     }
                   8575:     return \@samples;
                   8576: }
                   8577: 
1.144     matthew  8578: ######################################################
                   8579: ######################################################
                   8580: 
1.56      matthew  8581: =pod
                   8582: 
1.648     raeburn  8583: =item * &csv_print_samples($r,$records)
1.41      ng       8584: 
                   8585: Prints a table of sample values from each column uploaded $r is an
                   8586: Apache Request ref, $records is an arrayref from
                   8587: &Apache::loncommon::upfile_record_sep
                   8588: 
                   8589: =cut
                   8590: 
1.144     matthew  8591: ######################################################
                   8592: ######################################################
1.31      albertel 8593: sub csv_print_samples {
                   8594:     my ($r,$records) = @_;
1.662     bisitz   8595:     my $samples = &get_samples($records,5);
1.301     albertel 8596: 
1.594     raeburn  8597:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8598:               &start_data_table_header_row());
1.356     albertel 8599:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8600:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8601:     $r->print(&end_data_table_header_row());
1.301     albertel 8602:     foreach my $hash (@$samples) {
1.594     raeburn  8603: 	$r->print(&start_data_table_row());
1.356     albertel 8604: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8605: 	    $r->print('<td>');
1.356     albertel 8606: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8607: 	    $r->print('</td>');
                   8608: 	}
1.594     raeburn  8609: 	$r->print(&end_data_table_row());
1.31      albertel 8610:     }
1.594     raeburn  8611:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8612: }
                   8613: 
1.144     matthew  8614: ######################################################
                   8615: ######################################################
                   8616: 
1.56      matthew  8617: =pod
                   8618: 
1.648     raeburn  8619: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8620: 
                   8621: Prints a table to create associations between values and table columns.
1.144     matthew  8622: 
1.41      ng       8623: $r is an Apache Request ref,
                   8624: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8625: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8626: 
                   8627: =cut
                   8628: 
1.144     matthew  8629: ######################################################
                   8630: ######################################################
1.31      albertel 8631: sub csv_print_select_table {
                   8632:     my ($r,$records,$d) = @_;
1.301     albertel 8633:     my $i=0;
                   8634:     my $samples = &get_samples($records,1);
1.144     matthew  8635:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8636: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8637:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8638:               '<th>'.&mt('Column').'</th>'.
                   8639:               &end_data_table_header_row()."\n");
1.356     albertel 8640:     foreach my $array_ref (@$d) {
                   8641: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8642: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8643: 
1.875     bisitz   8644: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8645: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8646: 	$r->print('<option value="none"></option>');
1.356     albertel 8647: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8648: 	    $r->print('<option value="'.$sample.'"'.
                   8649:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8650:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8651: 	}
1.594     raeburn  8652: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8653: 	$i++;
                   8654:     }
1.594     raeburn  8655:     $r->print(&end_data_table());
1.31      albertel 8656:     $i--;
                   8657:     return $i;
                   8658: }
1.56      matthew  8659: 
1.144     matthew  8660: ######################################################
                   8661: ######################################################
                   8662: 
1.56      matthew  8663: =pod
1.31      albertel 8664: 
1.648     raeburn  8665: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8666: 
                   8667: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8668: 
                   8669: $r is an Apache Request ref,
                   8670: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8671: $d is an array of 2 element arrays (internal name, displayed name)
                   8672: 
                   8673: =cut
                   8674: 
1.144     matthew  8675: ######################################################
                   8676: ######################################################
1.31      albertel 8677: sub csv_samples_select_table {
                   8678:     my ($r,$records,$d) = @_;
                   8679:     my $i=0;
1.144     matthew  8680:     #
1.662     bisitz   8681:     my $max_samples = 5;
                   8682:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8683:     $r->print(&start_data_table().
                   8684:               &start_data_table_header_row().'<th>'.
                   8685:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8686:               &end_data_table_header_row());
1.301     albertel 8687: 
                   8688:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8689: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8690: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8691: 	foreach my $option (@$d) {
                   8692: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8693: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8694:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8695:                       $display.'</option>');
1.31      albertel 8696: 	}
                   8697: 	$r->print('</select></td><td>');
1.662     bisitz   8698: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8699: 	    if (defined($samples->[$line]{$key})) { 
                   8700: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8701: 	    }
                   8702: 	}
1.594     raeburn  8703: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8704: 	$i++;
                   8705:     }
1.594     raeburn  8706:     $r->print(&end_data_table());
1.31      albertel 8707:     $i--;
                   8708:     return($i);
1.115     matthew  8709: }
                   8710: 
1.144     matthew  8711: ######################################################
                   8712: ######################################################
                   8713: 
1.115     matthew  8714: =pod
                   8715: 
1.648     raeburn  8716: =item * &clean_excel_name($name)
1.115     matthew  8717: 
                   8718: Returns a replacement for $name which does not contain any illegal characters.
                   8719: 
                   8720: =cut
                   8721: 
1.144     matthew  8722: ######################################################
                   8723: ######################################################
1.115     matthew  8724: sub clean_excel_name {
                   8725:     my ($name) = @_;
                   8726:     $name =~ s/[:\*\?\/\\]//g;
                   8727:     if (length($name) > 31) {
                   8728:         $name = substr($name,0,31);
                   8729:     }
                   8730:     return $name;
1.25      albertel 8731: }
1.84      albertel 8732: 
1.85      albertel 8733: =pod
                   8734: 
1.648     raeburn  8735: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8736: 
                   8737: Returns either 1 or undef
                   8738: 
                   8739: 1 if the part is to be hidden, undef if it is to be shown
                   8740: 
                   8741: Arguments are:
                   8742: 
                   8743: $id the id of the part to be checked
                   8744: $symb, optional the symb of the resource to check
                   8745: $udom, optional the domain of the user to check for
                   8746: $uname, optional the username of the user to check for
                   8747: 
                   8748: =cut
1.84      albertel 8749: 
                   8750: sub check_if_partid_hidden {
                   8751:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8752:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8753: 					 $symb,$udom,$uname);
1.141     albertel 8754:     my $truth=1;
                   8755:     #if the string starts with !, then the list is the list to show not hide
                   8756:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8757:     my @hiddenlist=split(/,/,$hiddenparts);
                   8758:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8759: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8760:     }
1.141     albertel 8761:     return !$truth;
1.84      albertel 8762: }
1.127     matthew  8763: 
1.138     matthew  8764: 
                   8765: ############################################################
                   8766: ############################################################
                   8767: 
                   8768: =pod
                   8769: 
1.157     matthew  8770: =back 
                   8771: 
1.138     matthew  8772: =head1 cgi-bin script and graphing routines
                   8773: 
1.157     matthew  8774: =over 4
                   8775: 
1.648     raeburn  8776: =item * &get_cgi_id()
1.138     matthew  8777: 
                   8778: Inputs: none
                   8779: 
                   8780: Returns an id which can be used to pass environment variables
                   8781: to various cgi-bin scripts.  These environment variables will
                   8782: be removed from the users environment after a given time by
                   8783: the routine &Apache::lonnet::transfer_profile_to_env.
                   8784: 
                   8785: =cut
                   8786: 
                   8787: ############################################################
                   8788: ############################################################
1.152     albertel 8789: my $uniq=0;
1.136     matthew  8790: sub get_cgi_id {
1.154     albertel 8791:     $uniq=($uniq+1)%100000;
1.280     albertel 8792:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8793: }
                   8794: 
1.127     matthew  8795: ############################################################
                   8796: ############################################################
                   8797: 
                   8798: =pod
                   8799: 
1.648     raeburn  8800: =item * &DrawBarGraph()
1.127     matthew  8801: 
1.138     matthew  8802: Facilitates the plotting of data in a (stacked) bar graph.
                   8803: Puts plot definition data into the users environment in order for 
                   8804: graph.png to plot it.  Returns an <img> tag for the plot.
                   8805: The bars on the plot are labeled '1','2',...,'n'.
                   8806: 
                   8807: Inputs:
                   8808: 
                   8809: =over 4
                   8810: 
                   8811: =item $Title: string, the title of the plot
                   8812: 
                   8813: =item $xlabel: string, text describing the X-axis of the plot
                   8814: 
                   8815: =item $ylabel: string, text describing the Y-axis of the plot
                   8816: 
                   8817: =item $Max: scalar, the maximum Y value to use in the plot
                   8818: If $Max is < any data point, the graph will not be rendered.
                   8819: 
1.140     matthew  8820: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8821: they are plotted.  If undefined, default values will be used.
                   8822: 
1.178     matthew  8823: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8824: 
1.138     matthew  8825: =item @Values: An array of array references.  Each array reference holds data
                   8826: to be plotted in a stacked bar chart.
                   8827: 
1.239     matthew  8828: =item If the final element of @Values is a hash reference the key/value
                   8829: pairs will be added to the graph definition.
                   8830: 
1.138     matthew  8831: =back
                   8832: 
                   8833: Returns:
                   8834: 
                   8835: An <img> tag which references graph.png and the appropriate identifying
                   8836: information for the plot.
                   8837: 
1.127     matthew  8838: =cut
                   8839: 
                   8840: ############################################################
                   8841: ############################################################
1.134     matthew  8842: sub DrawBarGraph {
1.178     matthew  8843:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8844:     #
                   8845:     if (! defined($colors)) {
                   8846:         $colors = ['#33ff00', 
                   8847:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8848:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8849:                   ]; 
                   8850:     }
1.228     matthew  8851:     my $extra_settings = {};
                   8852:     if (ref($Values[-1]) eq 'HASH') {
                   8853:         $extra_settings = pop(@Values);
                   8854:     }
1.127     matthew  8855:     #
1.136     matthew  8856:     my $identifier = &get_cgi_id();
                   8857:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8858:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8859:         return '';
                   8860:     }
1.225     matthew  8861:     #
                   8862:     my @Labels;
                   8863:     if (defined($labels)) {
                   8864:         @Labels = @$labels;
                   8865:     } else {
                   8866:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8867:             push (@Labels,$i+1);
                   8868:         }
                   8869:     }
                   8870:     #
1.129     matthew  8871:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8872:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8873:     my %ValuesHash;
                   8874:     my $NumSets=1;
                   8875:     foreach my $array (@Values) {
                   8876:         next if (! ref($array));
1.136     matthew  8877:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8878:             join(',',@$array);
1.129     matthew  8879:     }
1.127     matthew  8880:     #
1.136     matthew  8881:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8882:     if ($NumBars < 3) {
                   8883:         $width = 120+$NumBars*32;
1.220     matthew  8884:         $xskip = 1;
1.225     matthew  8885:         $bar_width = 30;
                   8886:     } elsif ($NumBars < 5) {
                   8887:         $width = 120+$NumBars*20;
                   8888:         $xskip = 1;
                   8889:         $bar_width = 20;
1.220     matthew  8890:     } elsif ($NumBars < 10) {
1.136     matthew  8891:         $width = 120+$NumBars*15;
                   8892:         $xskip = 1;
                   8893:         $bar_width = 15;
                   8894:     } elsif ($NumBars <= 25) {
                   8895:         $width = 120+$NumBars*11;
                   8896:         $xskip = 5;
                   8897:         $bar_width = 8;
                   8898:     } elsif ($NumBars <= 50) {
                   8899:         $width = 120+$NumBars*8;
                   8900:         $xskip = 5;
                   8901:         $bar_width = 4;
                   8902:     } else {
                   8903:         $width = 120+$NumBars*8;
                   8904:         $xskip = 5;
                   8905:         $bar_width = 4;
                   8906:     }
                   8907:     #
1.137     matthew  8908:     $Max = 1 if ($Max < 1);
                   8909:     if ( int($Max) < $Max ) {
                   8910:         $Max++;
                   8911:         $Max = int($Max);
                   8912:     }
1.127     matthew  8913:     $Title  = '' if (! defined($Title));
                   8914:     $xlabel = '' if (! defined($xlabel));
                   8915:     $ylabel = '' if (! defined($ylabel));
1.369     www      8916:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8917:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8918:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8919:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8920:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8921:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8922:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8923:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8924:     $ValuesHash{$id.'.height'}   = $height;
                   8925:     $ValuesHash{$id.'.width'}    = $width;
                   8926:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8927:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8928:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8929:     #
1.228     matthew  8930:     # Deal with other parameters
                   8931:     while (my ($key,$value) = each(%$extra_settings)) {
                   8932:         $ValuesHash{$id.'.'.$key} = $value;
                   8933:     }
                   8934:     #
1.646     raeburn  8935:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8936:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8937: }
                   8938: 
                   8939: ############################################################
                   8940: ############################################################
                   8941: 
                   8942: =pod
                   8943: 
1.648     raeburn  8944: =item * &DrawXYGraph()
1.137     matthew  8945: 
1.138     matthew  8946: Facilitates the plotting of data in an XY graph.
                   8947: Puts plot definition data into the users environment in order for 
                   8948: graph.png to plot it.  Returns an <img> tag for the plot.
                   8949: 
                   8950: Inputs:
                   8951: 
                   8952: =over 4
                   8953: 
                   8954: =item $Title: string, the title of the plot
                   8955: 
                   8956: =item $xlabel: string, text describing the X-axis of the plot
                   8957: 
                   8958: =item $ylabel: string, text describing the Y-axis of the plot
                   8959: 
                   8960: =item $Max: scalar, the maximum Y value to use in the plot
                   8961: If $Max is < any data point, the graph will not be rendered.
                   8962: 
                   8963: =item $colors: Array ref containing the hex color codes for the data to be 
                   8964: plotted in.  If undefined, default values will be used.
                   8965: 
                   8966: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8967: 
                   8968: =item $Ydata: Array ref containing Array refs.  
1.185     www      8969: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8970: 
                   8971: =item %Values: hash indicating or overriding any default values which are 
                   8972: passed to graph.png.  
                   8973: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8974: 
                   8975: =back
                   8976: 
                   8977: Returns:
                   8978: 
                   8979: An <img> tag which references graph.png and the appropriate identifying
                   8980: information for the plot.
                   8981: 
1.137     matthew  8982: =cut
                   8983: 
                   8984: ############################################################
                   8985: ############################################################
                   8986: sub DrawXYGraph {
                   8987:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8988:     #
                   8989:     # Create the identifier for the graph
                   8990:     my $identifier = &get_cgi_id();
                   8991:     my $id = 'cgi.'.$identifier;
                   8992:     #
                   8993:     $Title  = '' if (! defined($Title));
                   8994:     $xlabel = '' if (! defined($xlabel));
                   8995:     $ylabel = '' if (! defined($ylabel));
                   8996:     my %ValuesHash = 
                   8997:         (
1.369     www      8998:          $id.'.title'  => &escape($Title),
                   8999:          $id.'.xlabel' => &escape($xlabel),
                   9000:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9001:          $id.'.y_max_value'=> $Max,
                   9002:          $id.'.labels'     => join(',',@$Xlabels),
                   9003:          $id.'.PlotType'   => 'XY',
                   9004:          );
                   9005:     #
                   9006:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9007:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9008:     }
                   9009:     #
                   9010:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9011:         return '';
                   9012:     }
                   9013:     my $NumSets=1;
1.138     matthew  9014:     foreach my $array (@{$Ydata}){
1.137     matthew  9015:         next if (! ref($array));
                   9016:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9017:     }
1.138     matthew  9018:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9019:     #
                   9020:     # Deal with other parameters
                   9021:     while (my ($key,$value) = each(%Values)) {
                   9022:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9023:     }
                   9024:     #
1.646     raeburn  9025:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9026:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9027: }
                   9028: 
                   9029: ############################################################
                   9030: ############################################################
                   9031: 
                   9032: =pod
                   9033: 
1.648     raeburn  9034: =item * &DrawXYYGraph()
1.138     matthew  9035: 
                   9036: Facilitates the plotting of data in an XY graph with two Y axes.
                   9037: Puts plot definition data into the users environment in order for 
                   9038: graph.png to plot it.  Returns an <img> tag for the plot.
                   9039: 
                   9040: Inputs:
                   9041: 
                   9042: =over 4
                   9043: 
                   9044: =item $Title: string, the title of the plot
                   9045: 
                   9046: =item $xlabel: string, text describing the X-axis of the plot
                   9047: 
                   9048: =item $ylabel: string, text describing the Y-axis of the plot
                   9049: 
                   9050: =item $colors: Array ref containing the hex color codes for the data to be 
                   9051: plotted in.  If undefined, default values will be used.
                   9052: 
                   9053: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9054: 
                   9055: =item $Ydata1: The first data set
                   9056: 
                   9057: =item $Min1: The minimum value of the left Y-axis
                   9058: 
                   9059: =item $Max1: The maximum value of the left Y-axis
                   9060: 
                   9061: =item $Ydata2: The second data set
                   9062: 
                   9063: =item $Min2: The minimum value of the right Y-axis
                   9064: 
                   9065: =item $Max2: The maximum value of the left Y-axis
                   9066: 
                   9067: =item %Values: hash indicating or overriding any default values which are 
                   9068: passed to graph.png.  
                   9069: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9070: 
                   9071: =back
                   9072: 
                   9073: Returns:
                   9074: 
                   9075: An <img> tag which references graph.png and the appropriate identifying
                   9076: information for the plot.
1.136     matthew  9077: 
                   9078: =cut
                   9079: 
                   9080: ############################################################
                   9081: ############################################################
1.137     matthew  9082: sub DrawXYYGraph {
                   9083:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9084:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9085:     #
                   9086:     # Create the identifier for the graph
                   9087:     my $identifier = &get_cgi_id();
                   9088:     my $id = 'cgi.'.$identifier;
                   9089:     #
                   9090:     $Title  = '' if (! defined($Title));
                   9091:     $xlabel = '' if (! defined($xlabel));
                   9092:     $ylabel = '' if (! defined($ylabel));
                   9093:     my %ValuesHash = 
                   9094:         (
1.369     www      9095:          $id.'.title'  => &escape($Title),
                   9096:          $id.'.xlabel' => &escape($xlabel),
                   9097:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9098:          $id.'.labels' => join(',',@$Xlabels),
                   9099:          $id.'.PlotType' => 'XY',
                   9100:          $id.'.NumSets' => 2,
1.137     matthew  9101:          $id.'.two_axes' => 1,
                   9102:          $id.'.y1_max_value' => $Max1,
                   9103:          $id.'.y1_min_value' => $Min1,
                   9104:          $id.'.y2_max_value' => $Max2,
                   9105:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9106:          );
                   9107:     #
1.137     matthew  9108:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9109:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9110:     }
                   9111:     #
                   9112:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9113:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9114:         return '';
                   9115:     }
                   9116:     my $NumSets=1;
1.137     matthew  9117:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9118:         next if (! ref($array));
                   9119:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9120:     }
                   9121:     #
                   9122:     # Deal with other parameters
                   9123:     while (my ($key,$value) = each(%Values)) {
                   9124:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9125:     }
                   9126:     #
1.646     raeburn  9127:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9128:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9129: }
                   9130: 
                   9131: ############################################################
                   9132: ############################################################
                   9133: 
                   9134: =pod
                   9135: 
1.157     matthew  9136: =back 
                   9137: 
1.139     matthew  9138: =head1 Statistics helper routines?  
                   9139: 
                   9140: Bad place for them but what the hell.
                   9141: 
1.157     matthew  9142: =over 4
                   9143: 
1.648     raeburn  9144: =item * &chartlink()
1.139     matthew  9145: 
                   9146: Returns a link to the chart for a specific student.  
                   9147: 
                   9148: Inputs:
                   9149: 
                   9150: =over 4
                   9151: 
                   9152: =item $linktext: The text of the link
                   9153: 
                   9154: =item $sname: The students username
                   9155: 
                   9156: =item $sdomain: The students domain
                   9157: 
                   9158: =back
                   9159: 
1.157     matthew  9160: =back
                   9161: 
1.139     matthew  9162: =cut
                   9163: 
                   9164: ############################################################
                   9165: ############################################################
                   9166: sub chartlink {
                   9167:     my ($linktext, $sname, $sdomain) = @_;
                   9168:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9169:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9170:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9171:        '">'.$linktext.'</a>';
1.153     matthew  9172: }
                   9173: 
                   9174: #######################################################
                   9175: #######################################################
                   9176: 
                   9177: =pod
                   9178: 
                   9179: =head1 Course Environment Routines
1.157     matthew  9180: 
                   9181: =over 4
1.153     matthew  9182: 
1.648     raeburn  9183: =item * &restore_course_settings()
1.153     matthew  9184: 
1.648     raeburn  9185: =item * &store_course_settings()
1.153     matthew  9186: 
                   9187: Restores/Store indicated form parameters from the course environment.
                   9188: Will not overwrite existing values of the form parameters.
                   9189: 
                   9190: Inputs: 
                   9191: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9192: 
                   9193: a hash ref describing the data to be stored.  For example:
                   9194:    
                   9195: %Save_Parameters = ('Status' => 'scalar',
                   9196:     'chartoutputmode' => 'scalar',
                   9197:     'chartoutputdata' => 'scalar',
                   9198:     'Section' => 'array',
1.373     raeburn  9199:     'Group' => 'array',
1.153     matthew  9200:     'StudentData' => 'array',
                   9201:     'Maps' => 'array');
                   9202: 
                   9203: Returns: both routines return nothing
                   9204: 
1.631     raeburn  9205: =back
                   9206: 
1.153     matthew  9207: =cut
                   9208: 
                   9209: #######################################################
                   9210: #######################################################
                   9211: sub store_course_settings {
1.496     albertel 9212:     return &store_settings($env{'request.course.id'},@_);
                   9213: }
                   9214: 
                   9215: sub store_settings {
1.153     matthew  9216:     # save to the environment
                   9217:     # appenv the same items, just to be safe
1.300     albertel 9218:     my $udom  = $env{'user.domain'};
                   9219:     my $uname = $env{'user.name'};
1.496     albertel 9220:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9221:     my %SaveHash;
                   9222:     my %AppHash;
                   9223:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9224:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9225:         my $envname = 'environment.'.$basename;
1.258     albertel 9226:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9227:             # Save this value away
                   9228:             if ($type eq 'scalar' &&
1.258     albertel 9229:                 (! exists($env{$envname}) || 
                   9230:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9231:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9232:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9233:             } elsif ($type eq 'array') {
                   9234:                 my $stored_form;
1.258     albertel 9235:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9236:                     $stored_form = join(',',
                   9237:                                         map {
1.369     www      9238:                                             &escape($_);
1.258     albertel 9239:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9240:                 } else {
                   9241:                     $stored_form = 
1.369     www      9242:                         &escape($env{'form.'.$setting});
1.153     matthew  9243:                 }
                   9244:                 # Determine if the array contents are the same.
1.258     albertel 9245:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9246:                     $SaveHash{$basename} = $stored_form;
                   9247:                     $AppHash{$envname}   = $stored_form;
                   9248:                 }
                   9249:             }
                   9250:         }
                   9251:     }
                   9252:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9253:                                           $udom,$uname);
1.153     matthew  9254:     if ($put_result !~ /^(ok|delayed)/) {
                   9255:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9256:                                  'got error:'.$put_result);
                   9257:     }
                   9258:     # Make sure these settings stick around in this session, too
1.646     raeburn  9259:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9260:     return;
                   9261: }
                   9262: 
                   9263: sub restore_course_settings {
1.499     albertel 9264:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9265: }
                   9266: 
                   9267: sub restore_settings {
                   9268:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9269:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9270:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9271:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9272:             '.'.$setting;
1.258     albertel 9273:         if (exists($env{$envname})) {
1.153     matthew  9274:             if ($type eq 'scalar') {
1.258     albertel 9275:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9276:             } elsif ($type eq 'array') {
1.258     albertel 9277:                 $env{'form.'.$setting} = [ 
1.153     matthew  9278:                                            map { 
1.369     www      9279:                                                &unescape($_); 
1.258     albertel 9280:                                            } split(',',$env{$envname})
1.153     matthew  9281:                                            ];
                   9282:             }
                   9283:         }
                   9284:     }
1.127     matthew  9285: }
                   9286: 
1.618     raeburn  9287: #######################################################
                   9288: #######################################################
                   9289: 
                   9290: =pod
                   9291: 
                   9292: =head1 Domain E-mail Routines  
                   9293: 
                   9294: =over 4
                   9295: 
1.648     raeburn  9296: =item * &build_recipient_list()
1.618     raeburn  9297: 
1.884     raeburn  9298: Build recipient lists for five types of e-mail:
1.766     raeburn  9299: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9300: (d) Help requests, (e) Course requests needing approval,  generated by
                   9301: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9302: loncoursequeueadmin.pm respectively.
1.618     raeburn  9303: 
                   9304: Inputs:
1.619     raeburn  9305: defmail (scalar - email address of default recipient), 
1.618     raeburn  9306: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9307: defdom (domain for which to retrieve configuration settings),
                   9308: origmail (scalar - email address of recipient from loncapa.conf, 
                   9309: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9310: 
1.655     raeburn  9311: Returns: comma separated list of addresses to which to send e-mail.
                   9312: 
                   9313: =back
1.618     raeburn  9314: 
                   9315: =cut
                   9316: 
                   9317: ############################################################
                   9318: ############################################################
                   9319: sub build_recipient_list {
1.619     raeburn  9320:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9321:     my @recipients;
                   9322:     my $otheremails;
                   9323:     my %domconfig =
                   9324:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9325:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9326:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9327:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9328:                 my @contacts = ('adminemail','supportemail');
                   9329:                 foreach my $item (@contacts) {
                   9330:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9331:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9332:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9333:                             push(@recipients,$addr);
                   9334:                         }
1.619     raeburn  9335:                     }
1.766     raeburn  9336:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9337:                 }
                   9338:             }
1.766     raeburn  9339:         } elsif ($origmail ne '') {
                   9340:             push(@recipients,$origmail);
1.618     raeburn  9341:         }
1.619     raeburn  9342:     } elsif ($origmail ne '') {
                   9343:         push(@recipients,$origmail);
1.618     raeburn  9344:     }
1.688     raeburn  9345:     if (defined($defmail)) {
                   9346:         if ($defmail ne '') {
                   9347:             push(@recipients,$defmail);
                   9348:         }
1.618     raeburn  9349:     }
                   9350:     if ($otheremails) {
1.619     raeburn  9351:         my @others;
                   9352:         if ($otheremails =~ /,/) {
                   9353:             @others = split(/,/,$otheremails);
1.618     raeburn  9354:         } else {
1.619     raeburn  9355:             push(@others,$otheremails);
                   9356:         }
                   9357:         foreach my $addr (@others) {
                   9358:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9359:                 push(@recipients,$addr);
                   9360:             }
1.618     raeburn  9361:         }
                   9362:     }
1.619     raeburn  9363:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9364:     return $recipientlist;
                   9365: }
                   9366: 
1.127     matthew  9367: ############################################################
                   9368: ############################################################
1.154     albertel 9369: 
1.655     raeburn  9370: =pod
                   9371: 
                   9372: =head1 Course Catalog Routines
                   9373: 
                   9374: =over 4
                   9375: 
                   9376: =item * &gather_categories()
                   9377: 
                   9378: Converts category definitions - keys of categories hash stored in  
                   9379: coursecategories in configuration.db on the primary library server in a 
                   9380: domain - to an array.  Also generates javascript and idx hash used to 
                   9381: generate Domain Coordinator interface for editing Course Categories.
                   9382: 
                   9383: Inputs:
1.663     raeburn  9384: 
1.655     raeburn  9385: categories (reference to hash of category definitions).
1.663     raeburn  9386: 
1.655     raeburn  9387: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9388:       categories and subcategories).
1.663     raeburn  9389: 
1.655     raeburn  9390: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9391:       editing Course Categories).
1.663     raeburn  9392: 
1.655     raeburn  9393: jsarray (reference to array of categories used to create Javascript arrays for
                   9394:          Domain Coordinator interface for editing Course Categories).
                   9395: 
                   9396: Returns: nothing
                   9397: 
                   9398: Side effects: populates cats, idx and jsarray. 
                   9399: 
                   9400: =cut
                   9401: 
                   9402: sub gather_categories {
                   9403:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9404:     my %counters;
                   9405:     my $num = 0;
                   9406:     foreach my $item (keys(%{$categories})) {
                   9407:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9408:         if ($container eq '' && $depth == 0) {
                   9409:             $cats->[$depth][$categories->{$item}] = $cat;
                   9410:         } else {
                   9411:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9412:         }
                   9413:         my ($escitem,$tail) = split(/:/,$item,2);
                   9414:         if ($counters{$tail} eq '') {
                   9415:             $counters{$tail} = $num;
                   9416:             $num ++;
                   9417:         }
                   9418:         if (ref($idx) eq 'HASH') {
                   9419:             $idx->{$item} = $counters{$tail};
                   9420:         }
                   9421:         if (ref($jsarray) eq 'ARRAY') {
                   9422:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9423:         }
                   9424:     }
                   9425:     return;
                   9426: }
                   9427: 
                   9428: =pod
                   9429: 
                   9430: =item * &extract_categories()
                   9431: 
                   9432: Used to generate breadcrumb trails for course categories.
                   9433: 
                   9434: Inputs:
1.663     raeburn  9435: 
1.655     raeburn  9436: categories (reference to hash of category definitions).
1.663     raeburn  9437: 
1.655     raeburn  9438: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9439:       categories and subcategories).
1.663     raeburn  9440: 
1.655     raeburn  9441: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9442: 
1.655     raeburn  9443: allitems (reference to hash - key is category key 
                   9444:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9445: 
1.655     raeburn  9446: idx (reference to hash of counters used in Domain Coordinator interface for
                   9447:       editing Course Categories).
1.663     raeburn  9448: 
1.655     raeburn  9449: jsarray (reference to array of categories used to create Javascript arrays for
                   9450:          Domain Coordinator interface for editing Course Categories).
                   9451: 
1.665     raeburn  9452: subcats (reference to hash of arrays containing all subcategories within each 
                   9453:          category, -recursive)
                   9454: 
1.655     raeburn  9455: Returns: nothing
                   9456: 
                   9457: Side effects: populates trails and allitems hash references.
                   9458: 
                   9459: =cut
                   9460: 
                   9461: sub extract_categories {
1.665     raeburn  9462:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9463:     if (ref($categories) eq 'HASH') {
                   9464:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9465:         if (ref($cats->[0]) eq 'ARRAY') {
                   9466:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9467:                 my $name = $cats->[0][$i];
                   9468:                 my $item = &escape($name).'::0';
                   9469:                 my $trailstr;
                   9470:                 if ($name eq 'instcode') {
                   9471:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9472:                 } else {
                   9473:                     $trailstr = $name;
                   9474:                 }
                   9475:                 if ($allitems->{$item} eq '') {
                   9476:                     push(@{$trails},$trailstr);
                   9477:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9478:                 }
                   9479:                 my @parents = ($name);
                   9480:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9481:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9482:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9483:                         if (ref($subcats) eq 'HASH') {
                   9484:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9485:                         }
                   9486:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9487:                     }
                   9488:                 } else {
                   9489:                     if (ref($subcats) eq 'HASH') {
                   9490:                         $subcats->{$item} = [];
1.655     raeburn  9491:                     }
                   9492:                 }
                   9493:             }
                   9494:         }
                   9495:     }
                   9496:     return;
                   9497: }
                   9498: 
                   9499: =pod
                   9500: 
                   9501: =item *&recurse_categories()
                   9502: 
                   9503: Recursively used to generate breadcrumb trails for course categories.
                   9504: 
                   9505: Inputs:
1.663     raeburn  9506: 
1.655     raeburn  9507: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9508:       categories and subcategories).
1.663     raeburn  9509: 
1.655     raeburn  9510: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9511: 
                   9512: category (current course category, for which breadcrumb trail is being generated).
                   9513: 
                   9514: trails (reference to array of breadcrumb trails for each category).
                   9515: 
1.655     raeburn  9516: allitems (reference to hash - key is category key
                   9517:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9518: 
1.655     raeburn  9519: parents (array containing containers directories for current category, 
                   9520:          back to top level). 
                   9521: 
                   9522: Returns: nothing
                   9523: 
                   9524: Side effects: populates trails and allitems hash references
                   9525: 
                   9526: =cut
                   9527: 
                   9528: sub recurse_categories {
1.665     raeburn  9529:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9530:     my $shallower = $depth - 1;
                   9531:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9532:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9533:             my $name = $cats->[$depth]{$category}[$k];
                   9534:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9535:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9536:             if ($allitems->{$item} eq '') {
                   9537:                 push(@{$trails},$trailstr);
                   9538:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9539:             }
                   9540:             my $deeper = $depth+1;
                   9541:             push(@{$parents},$category);
1.665     raeburn  9542:             if (ref($subcats) eq 'HASH') {
                   9543:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9544:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9545:                     my $higher;
                   9546:                     if ($j > 0) {
                   9547:                         $higher = &escape($parents->[$j]).':'.
                   9548:                                   &escape($parents->[$j-1]).':'.$j;
                   9549:                     } else {
                   9550:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9551:                     }
                   9552:                     push(@{$subcats->{$higher}},$subcat);
                   9553:                 }
                   9554:             }
                   9555:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9556:                                 $subcats);
1.655     raeburn  9557:             pop(@{$parents});
                   9558:         }
                   9559:     } else {
                   9560:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9561:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9562:         if ($allitems->{$item} eq '') {
                   9563:             push(@{$trails},$trailstr);
                   9564:             $allitems->{$item} = scalar(@{$trails})-1;
                   9565:         }
                   9566:     }
                   9567:     return;
                   9568: }
                   9569: 
1.663     raeburn  9570: =pod
                   9571: 
                   9572: =item *&assign_categories_table()
                   9573: 
                   9574: Create a datatable for display of hierarchical categories in a domain,
                   9575: with checkboxes to allow a course to be categorized. 
                   9576: 
                   9577: Inputs:
                   9578: 
                   9579: cathash - reference to hash of categories defined for the domain (from
                   9580:           configuration.db)
                   9581: 
                   9582: currcat - scalar with an & separated list of categories assigned to a course. 
                   9583: 
                   9584: Returns: $output (markup to be displayed) 
                   9585: 
                   9586: =cut
                   9587: 
                   9588: sub assign_categories_table {
                   9589:     my ($cathash,$currcat) = @_;
                   9590:     my $output;
                   9591:     if (ref($cathash) eq 'HASH') {
                   9592:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9593:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9594:         $maxdepth = scalar(@cats);
                   9595:         if (@cats > 0) {
                   9596:             my $itemcount = 0;
                   9597:             if (ref($cats[0]) eq 'ARRAY') {
                   9598:                 $output = &Apache::loncommon::start_data_table();
                   9599:                 my @currcategories;
                   9600:                 if ($currcat ne '') {
                   9601:                     @currcategories = split('&',$currcat);
                   9602:                 }
                   9603:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9604:                     my $parent = $cats[0][$i];
                   9605:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9606:                     next if ($parent eq 'instcode');
                   9607:                     my $item = &escape($parent).'::0';
                   9608:                     my $checked = '';
                   9609:                     if (@currcategories > 0) {
                   9610:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9611:                             $checked = ' checked="checked"';
1.663     raeburn  9612:                         }
                   9613:                     }
1.675     raeburn  9614:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9615:                                '<input type="checkbox" name="usecategory" value="'.
                   9616:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9617:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9618:                     my $depth = 1;
                   9619:                     push(@path,$parent);
                   9620:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9621:                     pop(@path);
                   9622:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9623:                     $itemcount ++;
                   9624:                 }
                   9625:                 $output .= &Apache::loncommon::end_data_table();
                   9626:             }
                   9627:         }
                   9628:     }
                   9629:     return $output;
                   9630: }
                   9631: 
                   9632: =pod
                   9633: 
                   9634: =item *&assign_category_rows()
                   9635: 
                   9636: Create a datatable row for display of nested categories in a domain,
                   9637: with checkboxes to allow a course to be categorized,called recursively.
                   9638: 
                   9639: Inputs:
                   9640: 
                   9641: itemcount - track row number for alternating colors
                   9642: 
                   9643: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9644:       categories and subcategories.
                   9645: 
                   9646: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9647: 
                   9648: parent - parent of current category item
                   9649: 
                   9650: path - Array containing all categories back up through the hierarchy from the
                   9651:        current category to the top level.
                   9652: 
                   9653: currcategories - reference to array of current categories assigned to the course
                   9654: 
                   9655: Returns: $output (markup to be displayed).
                   9656: 
                   9657: =cut
                   9658: 
                   9659: sub assign_category_rows {
                   9660:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9661:     my ($text,$name,$item,$chgstr);
                   9662:     if (ref($cats) eq 'ARRAY') {
                   9663:         my $maxdepth = scalar(@{$cats});
                   9664:         if (ref($cats->[$depth]) eq 'HASH') {
                   9665:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9666:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9667:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9668:                 $text .= '<td><table class="LC_datatable">';
                   9669:                 for (my $j=0; $j<$numchildren; $j++) {
                   9670:                     $name = $cats->[$depth]{$parent}[$j];
                   9671:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9672:                     my $deeper = $depth+1;
                   9673:                     my $checked = '';
                   9674:                     if (ref($currcategories) eq 'ARRAY') {
                   9675:                         if (@{$currcategories} > 0) {
                   9676:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9677:                                 $checked = ' checked="checked"';
1.663     raeburn  9678:                             }
                   9679:                         }
                   9680:                     }
1.664     raeburn  9681:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9682:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9683:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9684:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9685:                              '</td><td>';
1.663     raeburn  9686:                     if (ref($path) eq 'ARRAY') {
                   9687:                         push(@{$path},$name);
                   9688:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9689:                         pop(@{$path});
                   9690:                     }
                   9691:                     $text .= '</td></tr>';
                   9692:                 }
                   9693:                 $text .= '</table></td>';
                   9694:             }
                   9695:         }
                   9696:     }
                   9697:     return $text;
                   9698: }
                   9699: 
1.655     raeburn  9700: ############################################################
                   9701: ############################################################
                   9702: 
                   9703: 
1.443     albertel 9704: sub commit_customrole {
1.664     raeburn  9705:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9706:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9707:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9708:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9709:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9710:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9711:                  '</b><br />';
                   9712:     return $output;
                   9713: }
                   9714: 
                   9715: sub commit_standardrole {
1.541     raeburn  9716:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9717:     my ($output,$logmsg,$linefeed);
                   9718:     if ($context eq 'auto') {
                   9719:         $linefeed = "\n";
                   9720:     } else {
                   9721:         $linefeed = "<br />\n";
                   9722:     }  
1.443     albertel 9723:     if ($three eq 'st') {
1.541     raeburn  9724:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9725:                                          $one,$two,$sec,$context);
                   9726:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9727:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9728:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9729:         } else {
1.541     raeburn  9730:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9731:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9732:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9733:             if ($context eq 'auto') {
                   9734:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9735:             } else {
                   9736:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9737:                &mt('Add to classlist').': <b>ok</b>';
                   9738:             }
                   9739:             $output .= $linefeed;
1.443     albertel 9740:         }
                   9741:     } else {
                   9742:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9743:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9744:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9745:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9746:         if ($context eq 'auto') {
                   9747:             $output .= $result.$linefeed;
                   9748:         } else {
                   9749:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9750:         }
1.443     albertel 9751:     }
                   9752:     return $output;
                   9753: }
                   9754: 
                   9755: sub commit_studentrole {
1.541     raeburn  9756:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9757:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9758:     if ($context eq 'auto') {
                   9759:         $linefeed = "\n";
                   9760:     } else {
                   9761:         $linefeed = '<br />'."\n";
                   9762:     }
1.443     albertel 9763:     if (defined($one) && defined($two)) {
                   9764:         my $cid=$one.'_'.$two;
                   9765:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9766:         my $secchange = 0;
                   9767:         my $expire_role_result;
                   9768:         my $modify_section_result;
1.628     raeburn  9769:         if ($oldsec ne '-1') { 
                   9770:             if ($oldsec ne $sec) {
1.443     albertel 9771:                 $secchange = 1;
1.628     raeburn  9772:                 my $now = time;
1.443     albertel 9773:                 my $uurl='/'.$cid;
                   9774:                 $uurl=~s/\_/\//g;
                   9775:                 if ($oldsec) {
                   9776:                     $uurl.='/'.$oldsec;
                   9777:                 }
1.626     raeburn  9778:                 $oldsecurl = $uurl;
1.628     raeburn  9779:                 $expire_role_result = 
1.652     raeburn  9780:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9781:                 if ($env{'request.course.sec'} ne '') { 
                   9782:                     if ($expire_role_result eq 'refused') {
                   9783:                         my @roles = ('st');
                   9784:                         my @statuses = ('previous');
                   9785:                         my @roledoms = ($one);
                   9786:                         my $withsec = 1;
                   9787:                         my %roleshash = 
                   9788:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9789:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9790:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9791:                             my ($oldstart,$oldend) = 
                   9792:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9793:                             if ($oldend > 0 && $oldend <= $now) {
                   9794:                                 $expire_role_result = 'ok';
                   9795:                             }
                   9796:                         }
                   9797:                     }
                   9798:                 }
1.443     albertel 9799:                 $result = $expire_role_result;
                   9800:             }
                   9801:         }
                   9802:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9803:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9804:             if ($modify_section_result =~ /^ok/) {
                   9805:                 if ($secchange == 1) {
1.628     raeburn  9806:                     if ($sec eq '') {
                   9807:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9808:                     } else {
                   9809:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9810:                     }
1.443     albertel 9811:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9812:                     if ($sec eq '') {
                   9813:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9814:                     } else {
                   9815:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9816:                     }
1.443     albertel 9817:                 } else {
1.628     raeburn  9818:                     if ($sec eq '') {
                   9819:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9820:                     } else {
                   9821:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9822:                     }
1.443     albertel 9823:                 }
                   9824:             } else {
1.628     raeburn  9825:                 if ($secchange) {       
                   9826:                     $$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;
                   9827:                 } else {
                   9828:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9829:                 }
1.443     albertel 9830:             }
                   9831:             $result = $modify_section_result;
                   9832:         } elsif ($secchange == 1) {
1.628     raeburn  9833:             if ($oldsec eq '') {
                   9834:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9835:             } else {
                   9836:                 $$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;
                   9837:             }
1.626     raeburn  9838:             if ($expire_role_result eq 'refused') {
                   9839:                 my $newsecurl = '/'.$cid;
                   9840:                 $newsecurl =~ s/\_/\//g;
                   9841:                 if ($sec ne '') {
                   9842:                     $newsecurl.='/'.$sec;
                   9843:                 }
                   9844:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9845:                     if ($sec eq '') {
                   9846:                         $$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;
                   9847:                     } else {
                   9848:                         $$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;
                   9849:                     }
                   9850:                 }
                   9851:             }
1.443     albertel 9852:         }
                   9853:     } else {
1.626     raeburn  9854:         $$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 9855:         $result = "error: incomplete course id\n";
                   9856:     }
                   9857:     return $result;
                   9858: }
                   9859: 
                   9860: ############################################################
                   9861: ############################################################
                   9862: 
1.566     albertel 9863: sub check_clone {
1.578     raeburn  9864:     my ($args,$linefeed) = @_;
1.566     albertel 9865:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9866:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9867:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9868:     my $clonemsg;
                   9869:     my $can_clone = 0;
                   9870: 
                   9871:     if ($clonehome eq 'no_host') {
1.578     raeburn  9872:         $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 9873:     } else {
                   9874: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.882     raeburn  9875: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   9876:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 9877: 	    $can_clone = 1;
                   9878: 	} else {
                   9879: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9880: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9881: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9882:             if (grep(/^\*$/,@cloners)) {
                   9883:                 $can_clone = 1;
                   9884:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9885:                 $can_clone = 1;
                   9886:             } else {
                   9887: 	        my %roleshash =
                   9888: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9889: 					 $args->{'ccdomain'},
                   9890:                                          'userroles',['active'],['cc'],
                   9891: 					 [$args->{'clonedomain'}]);
                   9892: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9893: 		    $can_clone = 1;
                   9894: 	        } else {
                   9895:                     $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'});
                   9896: 	        }
1.566     albertel 9897: 	    }
1.578     raeburn  9898:         }
1.566     albertel 9899:     }
                   9900:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9901: }
                   9902: 
1.444     albertel 9903: sub construct_course {
1.885     raeburn  9904:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 9905:     my $outcome;
1.541     raeburn  9906:     my $linefeed =  '<br />'."\n";
                   9907:     if ($context eq 'auto') {
                   9908:         $linefeed = "\n";
                   9909:     }
1.566     albertel 9910: 
                   9911: #
                   9912: # Are we cloning?
                   9913: #
                   9914:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9915:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9916: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9917: 	if ($context ne 'auto') {
1.578     raeburn  9918:             if ($clonemsg ne '') {
                   9919: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9920:             }
1.566     albertel 9921: 	}
                   9922: 	$outcome .= $clonemsg.$linefeed;
                   9923: 
                   9924:         if (!$can_clone) {
                   9925: 	    return (0,$outcome);
                   9926: 	}
                   9927:     }
                   9928: 
1.444     albertel 9929: #
                   9930: # Open course
                   9931: #
                   9932:     my $crstype = lc($args->{'crstype'});
                   9933:     my %cenv=();
                   9934:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9935:                                              $args->{'cdescr'},
                   9936:                                              $args->{'curl'},
                   9937:                                              $args->{'course_home'},
                   9938:                                              $args->{'nonstandard'},
                   9939:                                              $args->{'crscode'},
                   9940:                                              $args->{'ccuname'}.':'.
                   9941:                                              $args->{'ccdomain'},
1.882     raeburn  9942:                                              $args->{'crstype'},
1.885     raeburn  9943:                                              $cnum,$context,$category);
1.444     albertel 9944: 
                   9945:     # Note: The testing routines depend on this being output; see 
                   9946:     # Utils::Course. This needs to at least be output as a comment
                   9947:     # if anyone ever decides to not show this, and Utils::Course::new
                   9948:     # will need to be suitably modified.
1.541     raeburn  9949:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9950: #
                   9951: # Check if created correctly
                   9952: #
1.479     albertel 9953:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9954:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9955:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9956: 
1.444     albertel 9957: #
1.566     albertel 9958: # Do the cloning
                   9959: #   
                   9960:     if ($can_clone && $cloneid) {
                   9961: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9962: 	if ($context ne 'auto') {
                   9963: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9964: 	}
                   9965: 	$outcome .= $clonemsg.$linefeed;
                   9966: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9967: # Copy all files
1.637     www      9968: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9969: # Restore URL
1.566     albertel 9970: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9971: # Restore title
1.566     albertel 9972: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9973: # Mark as cloned
1.566     albertel 9974: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9975: # Need to clone grading mode
                   9976:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9977:         $cenv{'grading'}=$newenv{'grading'};
                   9978: # Do not clone these environment entries
                   9979:         &Apache::lonnet::del('environment',
                   9980:                   ['default_enrollment_start_date',
                   9981:                    'default_enrollment_end_date',
                   9982:                    'question.email',
                   9983:                    'policy.email',
                   9984:                    'comment.email',
                   9985:                    'pch.users.denied',
1.725     raeburn  9986:                    'plc.users.denied',
                   9987:                    'hidefromcat',
                   9988:                    'categories'],
1.638     www      9989:                    $$crsudom,$$crsunum);
1.444     albertel 9990:     }
1.566     albertel 9991: 
1.444     albertel 9992: #
                   9993: # Set environment (will override cloned, if existing)
                   9994: #
                   9995:     my @sections = ();
                   9996:     my @xlists = ();
                   9997:     if ($args->{'crstype'}) {
                   9998:         $cenv{'type'}=$args->{'crstype'};
                   9999:     }
                   10000:     if ($args->{'crsid'}) {
                   10001:         $cenv{'courseid'}=$args->{'crsid'};
                   10002:     }
                   10003:     if ($args->{'crscode'}) {
                   10004:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10005:     }
                   10006:     if ($args->{'crsquota'} ne '') {
                   10007:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10008:     } else {
                   10009:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10010:     }
                   10011:     if ($args->{'ccuname'}) {
                   10012:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10013:                                         ':'.$args->{'ccdomain'};
                   10014:     } else {
                   10015:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10016:     }
                   10017:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10018:     if ($args->{'crssections'}) {
                   10019:         $cenv{'internal.sectionnums'} = '';
                   10020:         if ($args->{'crssections'} =~ m/,/) {
                   10021:             @sections = split/,/,$args->{'crssections'};
                   10022:         } else {
                   10023:             $sections[0] = $args->{'crssections'};
                   10024:         }
                   10025:         if (@sections > 0) {
                   10026:             foreach my $item (@sections) {
                   10027:                 my ($sec,$gp) = split/:/,$item;
                   10028:                 my $class = $args->{'crscode'}.$sec;
                   10029:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10030:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10031:                 unless ($addcheck eq 'ok') {
                   10032:                     push @badclasses, $class;
                   10033:                 }
                   10034:             }
                   10035:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10036:         }
                   10037:     }
                   10038: # do not hide course coordinator from staff listing, 
                   10039: # even if privileged
                   10040:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10041: # add crosslistings
                   10042:     if ($args->{'crsxlist'}) {
                   10043:         $cenv{'internal.crosslistings'}='';
                   10044:         if ($args->{'crsxlist'} =~ m/,/) {
                   10045:             @xlists = split/,/,$args->{'crsxlist'};
                   10046:         } else {
                   10047:             $xlists[0] = $args->{'crsxlist'};
                   10048:         }
                   10049:         if (@xlists > 0) {
                   10050:             foreach my $item (@xlists) {
                   10051:                 my ($xl,$gp) = split/:/,$item;
                   10052:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10053:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10054:                 unless ($addcheck eq 'ok') {
                   10055:                     push @badclasses, $xl;
                   10056:                 }
                   10057:             }
                   10058:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10059:         }
                   10060:     }
                   10061:     if ($args->{'autoadds'}) {
                   10062:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10063:     }
                   10064:     if ($args->{'autodrops'}) {
                   10065:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10066:     }
                   10067: # check for notification of enrollment changes
                   10068:     my @notified = ();
                   10069:     if ($args->{'notify_owner'}) {
                   10070:         if ($args->{'ccuname'} ne '') {
                   10071:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10072:         }
                   10073:     }
                   10074:     if ($args->{'notify_dc'}) {
                   10075:         if ($uname ne '') { 
1.630     raeburn  10076:             push(@notified,$uname.':'.$udom);
1.444     albertel 10077:         }
                   10078:     }
                   10079:     if (@notified > 0) {
                   10080:         my $notifylist;
                   10081:         if (@notified > 1) {
                   10082:             $notifylist = join(',',@notified);
                   10083:         } else {
                   10084:             $notifylist = $notified[0];
                   10085:         }
                   10086:         $cenv{'internal.notifylist'} = $notifylist;
                   10087:     }
                   10088:     if (@badclasses > 0) {
                   10089:         my %lt=&Apache::lonlocal::texthash(
                   10090:                 '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',
                   10091:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10092:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10093:         );
1.541     raeburn  10094:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10095:                            ' ('.$lt{'adby'}.')';
                   10096:         if ($context eq 'auto') {
                   10097:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10098:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10099:             foreach my $item (@badclasses) {
                   10100:                 if ($context eq 'auto') {
                   10101:                     $outcome .= " - $item\n";
                   10102:                 } else {
                   10103:                     $outcome .= "<li>$item</li>\n";
                   10104:                 }
                   10105:             }
                   10106:             if ($context eq 'auto') {
                   10107:                 $outcome .= $linefeed;
                   10108:             } else {
1.566     albertel 10109:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10110:             }
                   10111:         } 
1.444     albertel 10112:     }
                   10113:     if ($args->{'no_end_date'}) {
                   10114:         $args->{'endaccess'} = 0;
                   10115:     }
                   10116:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10117:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10118:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10119:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10120:     if ($args->{'showphotos'}) {
                   10121:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10122:     }
                   10123:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10124:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10125:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10126:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10127:             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'); 
                   10128:             if ($context eq 'auto') {
                   10129:                 $outcome .= $krb_msg;
                   10130:             } else {
1.566     albertel 10131:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10132:             }
                   10133:             $outcome .= $linefeed;
1.444     albertel 10134:         }
                   10135:     }
                   10136:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10137:        if ($args->{'setpolicy'}) {
                   10138:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10139:        }
                   10140:        if ($args->{'setcontent'}) {
                   10141:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10142:        }
                   10143:     }
                   10144:     if ($args->{'reshome'}) {
                   10145: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10146: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10147:     }
                   10148: #
                   10149: # course has keyed access
                   10150: #
                   10151:     if ($args->{'setkeys'}) {
                   10152:        $cenv{'keyaccess'}='yes';
                   10153:     }
                   10154: # if specified, key authority is not course, but user
                   10155: # only active if keyaccess is yes
                   10156:     if ($args->{'keyauth'}) {
1.487     albertel 10157: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10158: 	$user = &LONCAPA::clean_username($user);
                   10159: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10160: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10161: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10162: 	}
                   10163:     }
                   10164: 
                   10165:     if ($args->{'disresdis'}) {
                   10166:         $cenv{'pch.roles.denied'}='st';
                   10167:     }
                   10168:     if ($args->{'disablechat'}) {
                   10169:         $cenv{'plc.roles.denied'}='st';
                   10170:     }
                   10171: 
                   10172:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10173:     # course
                   10174:     $cenv{'course.helper.not.run'} = 1;
                   10175:     #
                   10176:     # Use new Randomseed
                   10177:     #
                   10178:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10179:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10180:     #
                   10181:     # The encryption code and receipt prefix for this course
                   10182:     #
                   10183:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10184:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10185:     #
                   10186:     # By default, use standard grading
                   10187:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10188: 
1.541     raeburn  10189:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10190:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10191: #
                   10192: # Open all assignments
                   10193: #
                   10194:     if ($args->{'openall'}) {
                   10195:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10196:        my %storecontent = ($storeunder         => time,
                   10197:                            $storeunder.'.type' => 'date_start');
                   10198:        
                   10199:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10200:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10201:    }
                   10202: #
                   10203: # Set first page
                   10204: #
                   10205:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10206: 	    || ($cloneid)) {
1.445     albertel 10207: 	use LONCAPA::map;
1.444     albertel 10208: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10209: 
                   10210: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10211:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10212: 
1.444     albertel 10213:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10214:         my $title; my $url;
                   10215:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10216: 	    $title=&mt('Syllabus');
1.444     albertel 10217:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10218:         } else {
1.690     bisitz   10219:             $title=&mt('Navigate Contents');
1.444     albertel 10220:             $url='/adm/navmaps';
                   10221:         }
1.445     albertel 10222: 
                   10223:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10224: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10225: 
                   10226: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10227:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10228:     }
1.566     albertel 10229: 
                   10230:     return (1,$outcome);
1.444     albertel 10231: }
                   10232: 
                   10233: ############################################################
                   10234: ############################################################
                   10235: 
1.378     raeburn  10236: sub course_type {
                   10237:     my ($cid) = @_;
                   10238:     if (!defined($cid)) {
                   10239:         $cid = $env{'request.course.id'};
                   10240:     }
1.404     albertel 10241:     if (defined($env{'course.'.$cid.'.type'})) {
                   10242:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10243:     } else {
                   10244:         return 'Course';
1.377     raeburn  10245:     }
                   10246: }
1.156     albertel 10247: 
1.406     raeburn  10248: sub group_term {
                   10249:     my $crstype = &course_type();
                   10250:     my %names = (
                   10251:                   'Course' => 'group',
1.865     raeburn  10252:                   'Community' => 'group',
1.406     raeburn  10253:                 );
                   10254:     return $names{$crstype};
                   10255: }
                   10256: 
1.156     albertel 10257: sub icon {
                   10258:     my ($file)=@_;
1.505     albertel 10259:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10260:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10261:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10262:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10263: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10264: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10265: 	            $curfext.".gif") {
                   10266: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10267: 		$curfext.".gif";
                   10268: 	}
                   10269:     }
1.249     albertel 10270:     return &lonhttpdurl($iconname);
1.154     albertel 10271: } 
1.84      albertel 10272: 
1.575     albertel 10273: sub lonhttpdurl {
1.692     www      10274: #
                   10275: # Had been used for "small fry" static images on separate port 8080.
                   10276: # Modify here if lightweight http functionality desired again.
                   10277: # Currently eliminated due to increasing firewall issues.
                   10278: #
1.575     albertel 10279:     my ($url)=@_;
1.692     www      10280:     return $url;
1.215     albertel 10281: }
                   10282: 
1.213     albertel 10283: sub connection_aborted {
                   10284:     my ($r)=@_;
                   10285:     $r->print(" ");$r->rflush();
                   10286:     my $c = $r->connection;
                   10287:     return $c->aborted();
                   10288: }
                   10289: 
1.221     foxr     10290: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10291: #    strings as 'strings'.
                   10292: sub escape_single {
1.221     foxr     10293:     my ($input) = @_;
1.223     albertel 10294:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10295:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10296:     return $input;
                   10297: }
1.223     albertel 10298: 
1.222     foxr     10299: #  Same as escape_single, but escape's "'s  This 
                   10300: #  can be used for  "strings"
                   10301: sub escape_double {
                   10302:     my ($input) = @_;
                   10303:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10304:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10305:     return $input;
                   10306: }
1.223     albertel 10307:  
1.222     foxr     10308: #   Escapes the last element of a full URL.
                   10309: sub escape_url {
                   10310:     my ($url)   = @_;
1.238     raeburn  10311:     my @urlslices = split(/\//, $url,-1);
1.369     www      10312:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10313:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10314: }
1.462     albertel 10315: 
1.820     raeburn  10316: sub compare_arrays {
                   10317:     my ($arrayref1,$arrayref2) = @_;
                   10318:     my (@difference,%count);
                   10319:     @difference = ();
                   10320:     %count = ();
                   10321:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10322:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10323:         foreach my $element (keys(%count)) {
                   10324:             if ($count{$element} == 1) {
                   10325:                 push(@difference,$element);
                   10326:             }
                   10327:         }
                   10328:     }
                   10329:     return @difference;
                   10330: }
                   10331: 
1.817     bisitz   10332: # -------------------------------------------------------- Initialize user login
1.462     albertel 10333: sub init_user_environment {
1.463     albertel 10334:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10335:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10336: 
                   10337:     my $public=($username eq 'public' && $domain eq 'public');
                   10338: 
                   10339: # See if old ID present, if so, remove
                   10340: 
                   10341:     my ($filename,$cookie,$userroles);
                   10342:     my $now=time;
                   10343: 
                   10344:     if ($public) {
                   10345: 	my $max_public=100;
                   10346: 	my $oldest;
                   10347: 	my $oldest_time=0;
                   10348: 	for(my $next=1;$next<=$max_public;$next++) {
                   10349: 	    if (-e $lonids."/publicuser_$next.id") {
                   10350: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10351: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10352: 		    $oldest_time=$mtime;
                   10353: 		    $oldest=$next;
                   10354: 		}
                   10355: 	    } else {
                   10356: 		$cookie="publicuser_$next";
                   10357: 		last;
                   10358: 	    }
                   10359: 	}
                   10360: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10361:     } else {
1.463     albertel 10362: 	# if this isn't a robot, kill any existing non-robot sessions
                   10363: 	if (!$args->{'robot'}) {
                   10364: 	    opendir(DIR,$lonids);
                   10365: 	    while ($filename=readdir(DIR)) {
                   10366: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10367: 		    unlink($lonids.'/'.$filename);
                   10368: 		}
1.462     albertel 10369: 	    }
1.463     albertel 10370: 	    closedir(DIR);
1.462     albertel 10371: 	}
                   10372: # Give them a new cookie
1.463     albertel 10373: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10374: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10375: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10376:     
                   10377: # Initialize roles
                   10378: 
                   10379: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10380:     }
                   10381: # ------------------------------------ Check browser type and MathML capability
                   10382: 
                   10383:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10384:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10385: 
                   10386: # ------------------------------------------------------------- Get environment
                   10387: 
                   10388:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10389:     my ($tmp) = keys(%userenv);
                   10390:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10391: 	# default remote control to off
                   10392: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10393:     } else {
                   10394: 	undef(%userenv);
                   10395:     }
                   10396:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10397: 	$form->{'interface'}=$userenv{'interface'};
                   10398:     }
                   10399:     $env{'environment.remote'}=$userenv{'remote'};
                   10400:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10401: 
                   10402: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10403:     foreach my $option ('interface','localpath','localres') {
                   10404:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10405:     }
                   10406: # --------------------------------------------------------- Write first profile
                   10407: 
                   10408:     {
                   10409: 	my %initial_env = 
                   10410: 	    ("user.name"          => $username,
                   10411: 	     "user.domain"        => $domain,
                   10412: 	     "user.home"          => $authhost,
                   10413: 	     "browser.type"       => $clientbrowser,
                   10414: 	     "browser.version"    => $clientversion,
                   10415: 	     "browser.mathml"     => $clientmathml,
                   10416: 	     "browser.unicode"    => $clientunicode,
                   10417: 	     "browser.os"         => $clientos,
                   10418: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10419: 	     "request.course.fn"  => '',
                   10420: 	     "request.course.uri" => '',
                   10421: 	     "request.course.sec" => '',
                   10422: 	     "request.role"       => 'cm',
                   10423: 	     "request.role.adv"   => $env{'user.adv'},
                   10424: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10425: 
                   10426:         if ($form->{'localpath'}) {
                   10427: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10428: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10429:         }
                   10430: 	
                   10431: 	if ($public) {
                   10432: 	    $initial_env{"environment.remote"} = "off";
                   10433: 	}
                   10434: 	if ($form->{'interface'}) {
                   10435: 	    $form->{'interface'}=~s/\W//gs;
                   10436: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10437: 	    $env{'browser.interface'}=$form->{'interface'};
                   10438: 	}
                   10439: 
1.724     raeburn  10440:         foreach my $tool ('aboutme','blog','portfolio') {
                   10441:             $userenv{'availabletools.'.$tool} = 
                   10442:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10443:         }
                   10444: 
1.864     raeburn  10445:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10446:             $userenv{'canrequest.'.$crstype} =
                   10447:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10448:                                                   'reload','requestcourses');
                   10449:         }
                   10450: 
1.462     albertel 10451: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10452: 	
                   10453: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10454: 		 &GDBM_WRCREAT(),0640)) {
                   10455: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10456: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10457: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10458: 	    if (ref($args->{'extra_env'})) {
                   10459: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10460: 	    }
1.462     albertel 10461: 	    untie(%disk_env);
                   10462: 	} else {
1.705     tempelho 10463: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10464: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10465: 	    return 'error: '.$!;
                   10466: 	}
                   10467:     }
                   10468:     $env{'request.role'}='cm';
                   10469:     $env{'request.role.adv'}=$env{'user.adv'};
                   10470:     $env{'browser.type'}=$clientbrowser;
                   10471: 
                   10472:     return $cookie;
                   10473: 
                   10474: }
                   10475: 
                   10476: sub _add_to_env {
                   10477:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10478:     if (ref($env_data) eq 'HASH') {
                   10479:         while (my ($key,$value) = each(%$env_data)) {
                   10480: 	    $idf->{$prefix.$key} = $value;
                   10481: 	    $env{$prefix.$key}   = $value;
                   10482:         }
1.462     albertel 10483:     }
                   10484: }
                   10485: 
1.685     tempelho 10486: # --- Get the symbolic name of a problem and the url
                   10487: sub get_symb {
                   10488:     my ($request,$silent) = @_;
1.726     raeburn  10489:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10490:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10491:     if ($symb eq '') {
                   10492:         if (!$silent) {
                   10493:             $request->print("Unable to handle ambiguous references:$url:.");
                   10494:             return ();
                   10495:         }
                   10496:     }
                   10497:     &Apache::lonenc::check_decrypt(\$symb);
                   10498:     return ($symb);
                   10499: }
                   10500: 
                   10501: # --------------------------------------------------------------Get annotation
                   10502: 
                   10503: sub get_annotation {
                   10504:     my ($symb,$enc) = @_;
                   10505: 
                   10506:     my $key = $symb;
                   10507:     if (!$enc) {
                   10508:         $key =
                   10509:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10510:     }
                   10511:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10512:     return $annotation{$key};
                   10513: }
                   10514: 
                   10515: sub clean_symb {
1.731     raeburn  10516:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10517: 
                   10518:     &Apache::lonenc::check_decrypt(\$symb);
                   10519:     my $enc = $env{'request.enc'};
1.731     raeburn  10520:     if ($delete_enc) {
1.730     raeburn  10521:         delete($env{'request.enc'});
                   10522:     }
1.685     tempelho 10523: 
                   10524:     return ($symb,$enc);
                   10525: }
1.462     albertel 10526: 
1.41      ng       10527: =pod
                   10528: 
                   10529: =back
                   10530: 
1.112     bowersj2 10531: =cut
1.41      ng       10532: 
1.112     bowersj2 10533: 1;
                   10534: __END__;
1.41      ng       10535: 

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