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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.901   ! bisitz      4: # $Id: loncommon.pm,v 1.900 2009/10/22 13:13:12 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.895     raeburn   496:         var formid = getFormIdByName(formname);
1.876     raeburn   497:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  498:         if (domainfilter != null) {
                    499:            if (domainfilter != '') {
                    500:                url += 'domainfilter='+domainfilter+'&';
                    501: 	   }
                    502:         }
1.91      www       503:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  504: 	                            '&cdomelement='+udom+
                    505:                                     '&cnameelement='+desc;
1.468     raeburn   506:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   507:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   508:                 url += '&roleelement='+extra_element;
                    509:                 if (domainfilter == null || domainfilter == '') {
                    510:                     url += '&domainfilter='+extra_element;
                    511:                 }
1.234     raeburn   512:             }
1.468     raeburn   513:             else {
                    514:                 if (formname == 'portform') {
                    515:                     url += '&setroles='+extra_element;
1.800     raeburn   516:                 } else {
                    517:                     if (formname == 'rules') {
                    518:                         url += '&fixeddom='+extra_element; 
                    519:                     }
1.468     raeburn   520:                 }
                    521:             }     
1.230     raeburn   522:         }
1.872     raeburn   523:         if (formname == 'ccrs') {
                    524:             var ownername = document.forms[formid].ccuname.value;
                    525:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    526:             url += '&cloner='+ownername+':'+ownerdom;
                    527:         }
1.293     raeburn   528:         if (multflag !=null && multflag != '') {
                    529:             url += '&multiple='+multflag;
                    530:         }
1.865     raeburn   531:         if (crstype == 'Course/Community') {
1.377     raeburn   532:             if (formname == 'cu') {
                    533:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    534:                 if (crstype == "") {
                    535:                     alert("$crs_or_grp_alert");
                    536:                     return;
                    537:                 }
                    538:             }
                    539:         }
                    540:         if (crstype !=null && crstype != '') {
                    541:             url += '&type='+crstype;
                    542:         }
1.102     www       543:         var title = 'Course_Browser';
1.91      www       544:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    545:         options += ',width=700,height=600';
                    546:         stdeditbrowser = open(url,title,options,'1');
                    547:         stdeditbrowser.focus();
                    548:     }
1.876     raeburn   549: $id_functions
                    550: ENDSTDBRW
                    551:     if ($sec_element ne '') {
                    552:         $output .= &setsec_javascript($sec_element,$formname);
                    553:     }
                    554:     $output .= '
                    555: // ]]>
                    556: </script>';
                    557:     return $output;
                    558: }
                    559: 
                    560: sub javascript_index_functions {
                    561:     return <<"ENDJS";
                    562: 
                    563: function getFormIdByName(formname) {
                    564:     for (var i=0;i<document.forms.length;i++) {
                    565:         if (document.forms[i].name == formname) {
                    566:             return i;
                    567:         }
                    568:     }
                    569:     return -1;
                    570: }
                    571: 
                    572: function getIndexByName(formid,item) {
                    573:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    574:         if (document.forms[formid].elements[i].name == item) {
                    575:             return i;
                    576:         }
                    577:     }
                    578:     return -1;
                    579: }
1.468     raeburn   580: 
1.876     raeburn   581: function getDomainFromSelectbox(formname,udom) {
                    582:     var userdom;
                    583:     var formid = getFormIdByName(formname);
                    584:     if (formid > -1) {
                    585:         var domid = getIndexByName(formid,udom);
                    586:         if (domid > -1) {
                    587:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    588:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    589:             }
                    590:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    591:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   592:             }
                    593:         }
                    594:     }
1.876     raeburn   595:     return userdom;
                    596: }
                    597: 
                    598: ENDJS
1.468     raeburn   599: 
1.876     raeburn   600: }
                    601: 
                    602: sub userbrowser_javascript {
                    603:     my $id_functions = &javascript_index_functions();
                    604:     return <<"ENDUSERBRW";
                    605: 
1.888     raeburn   606: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   607:     var url = '/adm/pickuser?';
                    608:     var userdom = getDomainFromSelectbox(formname,udom);
                    609:     if (userdom != null) {
                    610:        if (userdom != '') {
                    611:            url += 'srchdom='+userdom+'&';
                    612:        }
                    613:     }
                    614:     url += 'form=' + formname + '&unameelement='+uname+
                    615:                                 '&udomelement='+udom+
                    616:                                 '&ulastelement='+ulast+
                    617:                                 '&ufirstelement='+ufirst+
                    618:                                 '&uemailelement='+uemail+
1.881     raeburn   619:                                 '&hideudomelement='+hideudom+
                    620:                                 '&coursedom='+crsdom;
1.888     raeburn   621:     if ((caller != null) && (caller != undefined)) {
                    622:         url += '&caller='+caller;
                    623:     }
1.876     raeburn   624:     var title = 'User_Browser';
                    625:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    626:     options += ',width=700,height=600';
                    627:     var stdeditbrowser = open(url,title,options,'1');
                    628:     stdeditbrowser.focus();
                    629: }
                    630: 
1.888     raeburn   631: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   632:     var formid = getFormIdByName(formname);
                    633:     if (formid > -1) {
1.888     raeburn   634:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   635:         var domid = getIndexByName(formid,udom);
                    636:         var hidedomid = getIndexByName(formid,origdom);
                    637:         if (hidedomid > -1) {
                    638:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   639:             var unameval = document.forms[formid].elements[unameid].value;
                    640:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    641:                 if (domid > -1) {
                    642:                     var slct = document.forms[formid].elements[domid];
                    643:                     if (slct.type == 'select-one') {
                    644:                         var i;
                    645:                         for (i=0;i<slct.length;i++) {
                    646:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    647:                         }
                    648:                     }
                    649:                     if (slct.type == 'hidden') {
                    650:                         slct.value = fixeddom;
1.876     raeburn   651:                     }
                    652:                 }
1.468     raeburn   653:             }
                    654:         }
                    655:     }
1.876     raeburn   656:     return;
                    657: }
                    658: 
                    659: $id_functions
                    660: ENDUSERBRW
1.468     raeburn   661: }
                    662: 
                    663: sub setsec_javascript {
                    664:     my ($sec_element,$formname) = @_;
                    665:     my $setsections = qq|
                    666: function setSect(sectionlist) {
1.629     raeburn   667:     var sectionsArray = new Array();
                    668:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    669:         sectionsArray = sectionlist.split(",");
                    670:     }
1.468     raeburn   671:     var numSections = sectionsArray.length;
                    672:     document.$formname.$sec_element.length = 0;
                    673:     if (numSections == 0) {
                    674:         document.$formname.$sec_element.multiple=false;
                    675:         document.$formname.$sec_element.size=1;
                    676:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    677:     } else {
                    678:         if (numSections == 1) {
                    679:             document.$formname.$sec_element.multiple=false;
                    680:             document.$formname.$sec_element.size=1;
                    681:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    682:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    683:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    684:         } else {
                    685:             for (var i=0; i<numSections; i++) {
                    686:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    687:             }
                    688:             document.$formname.$sec_element.multiple=true
                    689:             if (numSections < 3) {
                    690:                 document.$formname.$sec_element.size=numSections;
                    691:             } else {
                    692:                 document.$formname.$sec_element.size=3;
                    693:             }
                    694:             document.$formname.$sec_element.options[0].selected = false
                    695:         }
                    696:     }
1.91      www       697: }
1.468     raeburn   698: |;
                    699:     return $setsections;
                    700: }
                    701: 
1.91      www       702: 
                    703: sub selectcourse_link {
1.377     raeburn   704:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.871     raeburn   705:    my $linktext = &mt('Select Course');
                    706:    if ($selecttype eq 'Community') {
                    707:        $linktext = &mt('Select Community'); 
                    708:    }
1.787     bisitz    709:    return '<span class="LC_nobreak">'
                    710:          ."<a href='"
                    711:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    712:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    713:          .'","'.$multflag.'","'.$selecttype.'");'
1.871     raeburn   714:          ."'>".$linktext.'</a>'
1.787     bisitz    715:          .'</span>';
1.74      www       716: }
1.42      matthew   717: 
1.653     raeburn   718: sub selectauthor_link {
                    719:    my ($form,$udom)=@_;
                    720:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    721:           &mt('Select Author').'</a>';
                    722: }
                    723: 
1.876     raeburn   724: sub selectuser_link {
1.881     raeburn   725:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   726:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   727:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   728:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   729:            ');">'.$linktext.'</a>';
1.876     raeburn   730: }
                    731: 
1.273     raeburn   732: sub check_uncheck_jscript {
                    733:     my $jscript = <<"ENDSCRT";
                    734: function checkAll(field) {
                    735:     if (field.length > 0) {
                    736:         for (i = 0; i < field.length; i++) {
                    737:             field[i].checked = true ;
                    738:         }
                    739:     } else {
                    740:         field.checked = true
                    741:     }
                    742: }
                    743:  
                    744: function uncheckAll(field) {
                    745:     if (field.length > 0) {
                    746:         for (i = 0; i < field.length; i++) {
                    747:             field[i].checked = false ;
1.543     albertel  748:         }
                    749:     } else {
1.273     raeburn   750:         field.checked = false ;
                    751:     }
                    752: }
                    753: ENDSCRT
                    754:     return $jscript;
                    755: }
                    756: 
1.656     www       757: sub select_timezone {
1.659     raeburn   758:    my ($name,$selected,$onchange,$includeempty)=@_;
                    759:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    760:    if ($includeempty) {
                    761:        $output .= '<option value=""';
                    762:        if (($selected eq '') || ($selected eq 'local')) {
                    763:            $output .= ' selected="selected" ';
                    764:        }
                    765:        $output .= '> </option>';
                    766:    }
1.657     raeburn   767:    my @timezones = DateTime::TimeZone->all_names;
                    768:    foreach my $tzone (@timezones) {
                    769:        $output.= '<option value="'.$tzone.'"';
                    770:        if ($tzone eq $selected) {
                    771:            $output.=' selected="selected"';
                    772:        }
                    773:        $output.=">$tzone</option>\n";
1.656     www       774:    }
                    775:    $output.="</select>";
                    776:    return $output;
                    777: }
1.273     raeburn   778: 
1.687     raeburn   779: sub select_datelocale {
                    780:     my ($name,$selected,$onchange,$includeempty)=@_;
                    781:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    782:     if ($includeempty) {
                    783:         $output .= '<option value=""';
                    784:         if ($selected eq '') {
                    785:             $output .= ' selected="selected" ';
                    786:         }
                    787:         $output .= '> </option>';
                    788:     }
                    789:     my (@possibles,%locale_names);
                    790:     my @locales = DateTime::Locale::Catalog::Locales;
                    791:     foreach my $locale (@locales) {
                    792:         if (ref($locale) eq 'HASH') {
                    793:             my $id = $locale->{'id'};
                    794:             if ($id ne '') {
                    795:                 my $en_terr = $locale->{'en_territory'};
                    796:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   797:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   798:                 if (grep(/^en$/,@languages) || !@languages) {
                    799:                     if ($en_terr ne '') {
                    800:                         $locale_names{$id} = '('.$en_terr.')';
                    801:                     } elsif ($native_terr ne '') {
                    802:                         $locale_names{$id} = $native_terr;
                    803:                     }
                    804:                 } else {
                    805:                     if ($native_terr ne '') {
                    806:                         $locale_names{$id} = $native_terr.' ';
                    807:                     } elsif ($en_terr ne '') {
                    808:                         $locale_names{$id} = '('.$en_terr.')';
                    809:                     }
                    810:                 }
                    811:                 push (@possibles,$id);
                    812:             }
                    813:         }
                    814:     }
                    815:     foreach my $item (sort(@possibles)) {
                    816:         $output.= '<option value="'.$item.'"';
                    817:         if ($item eq $selected) {
                    818:             $output.=' selected="selected"';
                    819:         }
                    820:         $output.=">$item";
                    821:         if ($locale_names{$item} ne '') {
                    822:             $output.="  $locale_names{$item}</option>\n";
                    823:         }
                    824:         $output.="</option>\n";
                    825:     }
                    826:     $output.="</select>";
                    827:     return $output;
                    828: }
                    829: 
1.792     raeburn   830: sub select_language {
                    831:     my ($name,$selected,$includeempty) = @_;
                    832:     my %langchoices;
                    833:     if ($includeempty) {
                    834:         %langchoices = ('' => 'No language preference');
                    835:     }
                    836:     foreach my $id (&languageids()) {
                    837:         my $code = &supportedlanguagecode($id);
                    838:         if ($code) {
                    839:             $langchoices{$code} = &plainlanguagedescription($id);
                    840:         }
                    841:     }
                    842:     return &select_form($selected,$name,%langchoices);
                    843: }
                    844: 
1.42      matthew   845: =pod
1.36      matthew   846: 
1.648     raeburn   847: =item * &linked_select_forms(...)
1.36      matthew   848: 
                    849: linked_select_forms returns a string containing a <script></script> block
                    850: and html for two <select> menus.  The select menus will be linked in that
                    851: changing the value of the first menu will result in new values being placed
                    852: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   853: order unless a defined order is provided.
1.36      matthew   854: 
                    855: linked_select_forms takes the following ordered inputs:
                    856: 
                    857: =over 4
                    858: 
1.112     bowersj2  859: =item * $formname, the name of the <form> tag
1.36      matthew   860: 
1.112     bowersj2  861: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   862: 
1.112     bowersj2  863: =item * $firstdefault, the default value for the first menu
1.36      matthew   864: 
1.112     bowersj2  865: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   866: 
1.112     bowersj2  867: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   868: 
1.112     bowersj2  869: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   870: 
1.609     raeburn   871: =item * $menuorder, the order of values in the first menu
                    872: 
1.41      ng        873: =back 
                    874: 
1.36      matthew   875: Below is an example of such a hash.  Only the 'text', 'default', and 
                    876: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    877: values for the first select menu.  The text that coincides with the 
1.41      ng        878: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   879: and text for the second menu are given in the hash pointed to by 
                    880: $menu{$choice1}->{'select2'}.  
                    881: 
1.112     bowersj2  882:  my %menu = ( A1 => { text =>"Choice A1" ,
                    883:                        default => "B3",
                    884:                        select2 => { 
                    885:                            B1 => "Choice B1",
                    886:                            B2 => "Choice B2",
                    887:                            B3 => "Choice B3",
                    888:                            B4 => "Choice B4"
1.609     raeburn   889:                            },
                    890:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  891:                    },
                    892:                A2 => { text =>"Choice A2" ,
                    893:                        default => "C2",
                    894:                        select2 => { 
                    895:                            C1 => "Choice C1",
                    896:                            C2 => "Choice C2",
                    897:                            C3 => "Choice C3"
1.609     raeburn   898:                            },
                    899:                        order => ['C2','C1','C3'],
1.112     bowersj2  900:                    },
                    901:                A3 => { text =>"Choice A3" ,
                    902:                        default => "D6",
                    903:                        select2 => { 
                    904:                            D1 => "Choice D1",
                    905:                            D2 => "Choice D2",
                    906:                            D3 => "Choice D3",
                    907:                            D4 => "Choice D4",
                    908:                            D5 => "Choice D5",
                    909:                            D6 => "Choice D6",
                    910:                            D7 => "Choice D7"
1.609     raeburn   911:                            },
                    912:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  913:                    }
                    914:                );
1.36      matthew   915: 
                    916: =cut
                    917: 
                    918: sub linked_select_forms {
                    919:     my ($formname,
                    920:         $middletext,
                    921:         $firstdefault,
                    922:         $firstselectname,
                    923:         $secondselectname, 
1.609     raeburn   924:         $hashref,
                    925:         $menuorder,
1.36      matthew   926:         ) = @_;
                    927:     my $second = "document.$formname.$secondselectname";
                    928:     my $first = "document.$formname.$firstselectname";
                    929:     # output the javascript to do the changing
                    930:     my $result = '';
1.776     bisitz    931:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    932:     $result.="// <![CDATA[\n";
1.36      matthew   933:     $result.="var select2data = new Object();\n";
                    934:     $" = '","';
                    935:     my $debug = '';
                    936:     foreach my $s1 (sort(keys(%$hashref))) {
                    937:         $result.="select2data.d_$s1 = new Object();\n";        
                    938:         $result.="select2data.d_$s1.def = new String('".
                    939:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   940:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   941:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   942:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    943:             @s2values = @{$hashref->{$s1}->{'order'}};
                    944:         }
1.36      matthew   945:         $result.="\"@s2values\");\n";
                    946:         $result.="select2data.d_$s1.texts = new Array(";        
                    947:         my @s2texts;
                    948:         foreach my $value (@s2values) {
                    949:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    950:         }
                    951:         $result.="\"@s2texts\");\n";
                    952:     }
                    953:     $"=' ';
                    954:     $result.= <<"END";
                    955: 
                    956: function select1_changed() {
                    957:     // Determine new choice
                    958:     var newvalue = "d_" + $first.value;
                    959:     // update select2
                    960:     var values     = select2data[newvalue].values;
                    961:     var texts      = select2data[newvalue].texts;
                    962:     var select2def = select2data[newvalue].def;
                    963:     var i;
                    964:     // out with the old
                    965:     for (i = 0; i < $second.options.length; i++) {
                    966:         $second.options[i] = null;
                    967:     }
                    968:     // in with the nuclear
                    969:     for (i=0;i<values.length; i++) {
                    970:         $second.options[i] = new Option(values[i]);
1.143     matthew   971:         $second.options[i].value = values[i];
1.36      matthew   972:         $second.options[i].text = texts[i];
                    973:         if (values[i] == select2def) {
                    974:             $second.options[i].selected = true;
                    975:         }
                    976:     }
                    977: }
1.824     bisitz    978: // ]]>
1.36      matthew   979: </script>
                    980: END
                    981:     # output the initial values for the selection lists
                    982:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   983:     my @order = sort(keys(%{$hashref}));
                    984:     if (ref($menuorder) eq 'ARRAY') {
                    985:         @order = @{$menuorder};
                    986:     }
                    987:     foreach my $value (@order) {
1.36      matthew   988:         $result.="    <option value=\"$value\" ";
1.253     albertel  989:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       990:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   991:     }
                    992:     $result .= "</select>\n";
                    993:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    994:     $result .= $middletext;
                    995:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    996:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   997:     
                    998:     my @secondorder = sort(keys(%select2));
                    999:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1000:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1001:     }
                   1002:     foreach my $value (@secondorder) {
1.36      matthew  1003:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1004:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1005:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1006:     }
                   1007:     $result .= "</select>\n";
                   1008:     #    return $debug;
                   1009:     return $result;
                   1010: }   #  end of sub linked_select_forms {
                   1011: 
1.45      matthew  1012: =pod
1.44      bowersj2 1013: 
1.648     raeburn  1014: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1015: 
1.112     bowersj2 1016: Returns a string corresponding to an HTML link to the given help
                   1017: $topic, where $topic corresponds to the name of a .tex file in
                   1018: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1019: spaces. 
                   1020: 
                   1021: $text will optionally be linked to the same topic, allowing you to
                   1022: link text in addition to the graphic. If you do not want to link
                   1023: text, but wish to specify one of the later parameters, pass an
                   1024: empty string. 
                   1025: 
                   1026: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1027: the link will not open a new window. If false, the link will open
                   1028: a new window using Javascript. (Default is false.) 
                   1029: 
                   1030: $width and $height are optional numerical parameters that will
                   1031: override the width and height of the popped up window, which may
                   1032: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1033: 
                   1034: =cut
                   1035: 
                   1036: sub help_open_topic {
1.48      bowersj2 1037:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1038:     $text = "" if (not defined $text);
1.44      bowersj2 1039:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1040:     $width = 350 if (not defined $width);
                   1041:     $height = 400 if (not defined $height);
                   1042:     my $filename = $topic;
                   1043:     $filename =~ s/ /_/g;
                   1044: 
1.48      bowersj2 1045:     my $template = "";
                   1046:     my $link;
1.572     banghart 1047:     
1.159     www      1048:     $topic=~s/\W/\_/g;
1.44      bowersj2 1049: 
1.572     banghart 1050:     if (!$stayOnPage) {
1.72      bowersj2 1051: 	$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 1052:     } else {
1.48      bowersj2 1053: 	$link = "/adm/help/${filename}.hlp";
                   1054:     }
                   1055: 
                   1056:     # Add the text
1.755     neumanie 1057:     if ($text ne "") {	
1.763     bisitz   1058: 	$template.='<span class="LC_help_open_topic">'
                   1059:                   .'<a target="_top" href="'.$link.'">'
                   1060:                   .$text.'</a>';
1.48      bowersj2 1061:     }
                   1062: 
1.763     bisitz   1063:     # (Always) Add the graphic
1.179     matthew  1064:     my $title = &mt('Online Help');
1.667     raeburn  1065:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1066:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1067:               .'<img src="'.$helpicon.'" border="0"'
                   1068:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1069:               .' title="'.$title.'"' 
1.763     bisitz   1070:               .' /></a>';
                   1071:     if ($text ne "") {	
                   1072:         $template.='</span>';
                   1073:     }
1.44      bowersj2 1074:     return $template;
                   1075: 
1.106     bowersj2 1076: }
                   1077: 
                   1078: # This is a quicky function for Latex cheatsheet editing, since it 
                   1079: # appears in at least four places
                   1080: sub helpLatexCheatsheet {
1.732     raeburn  1081:     my ($topic,$text,$not_author) = @_;
                   1082:     my $out;
1.106     bowersj2 1083:     my $addOther = '';
1.732     raeburn  1084:     if ($topic) {
1.763     bisitz   1085: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1086: 							       undef, undef, 600).
                   1087: 								   '</span> ';
                   1088:     }
                   1089:     $out = '<span>' # Start cheatsheet
                   1090: 	  .$addOther
                   1091:           .'<span>'
                   1092: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1093: 					       undef,undef,600)
                   1094: 	  .'</span> <span>'
                   1095: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1096: 					       undef,undef,600)
                   1097: 	  .'</span>';
1.732     raeburn  1098:     unless ($not_author) {
1.763     bisitz   1099:         $out .= ' <span>'
                   1100: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1101: 	                                            undef,undef,600)
                   1102: 	       .'</span>';
1.732     raeburn  1103:     }
1.763     bisitz   1104:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1105:     return $out;
1.172     www      1106: }
                   1107: 
1.430     albertel 1108: sub general_help {
                   1109:     my $helptopic='Student_Intro';
                   1110:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1111: 	$helptopic='Authoring_Intro';
                   1112:     } elsif ($env{'request.role'}=~/^cc/) {
                   1113: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1114:     } elsif ($env{'request.role'}=~/^dc/) {
                   1115:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1116:     }
                   1117:     return $helptopic;
                   1118: }
                   1119: 
                   1120: sub update_help_link {
                   1121:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1122:     my $origurl = $ENV{'REQUEST_URI'};
                   1123:     $origurl=~s|^/~|/priv/|;
                   1124:     my $timestamp = time;
                   1125:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1126:         $$datum = &escape($$datum);
                   1127:     }
                   1128: 
                   1129:     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";
                   1130:     my $output .= <<"ENDOUTPUT";
                   1131: <script type="text/javascript">
1.824     bisitz   1132: // <![CDATA[
1.430     albertel 1133: banner_link = '$banner_link';
1.824     bisitz   1134: // ]]>
1.430     albertel 1135: </script>
                   1136: ENDOUTPUT
                   1137:     return $output;
                   1138: }
                   1139: 
                   1140: # now just updates the help link and generates a blue icon
1.193     raeburn  1141: sub help_open_menu {
1.430     albertel 1142:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1143: 	= @_;    
1.430     albertel 1144:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1145:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1146:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1147:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1148:         $stayOnPage=1;
1.430     albertel 1149:     }
                   1150:     my $output;
                   1151:     if ($component_help) {
                   1152: 	if (!$text) {
                   1153: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1154: 				       $width,$height);
                   1155: 	} else {
                   1156: 	    my $help_text;
                   1157: 	    $help_text=&unescape($topic);
                   1158: 	    $output='<table><tr><td>'.
                   1159: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1160: 				 $width,$height).'</td></tr></table>';
                   1161: 	}
                   1162:     }
                   1163:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1164:     return $output.$banner_link;
                   1165: }
                   1166: 
                   1167: sub top_nav_help {
                   1168:     my ($text) = @_;
1.436     albertel 1169:     $text = &mt($text);
1.572     banghart 1170:     my $stay_on_page = 
1.798     tempelho 1171: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1172:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1173: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1174:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1175: 
1.201     raeburn  1176:     my $title = &mt('Get help');
1.436     albertel 1177: 
                   1178:     return <<"END";
                   1179: $banner_link
                   1180:  <a href="$link" title="$title">$text</a>
                   1181: END
                   1182: }
                   1183: 
                   1184: sub help_menu_js {
                   1185:     my ($text) = @_;
                   1186: 
                   1187:     my $stayOnPage = 
1.798     tempelho 1188: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1189: 
                   1190:     my $width = 620;
                   1191:     my $height = 600;
1.430     albertel 1192:     my $helptopic=&general_help();
                   1193:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1194:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1195:     my $start_page =
                   1196:         &Apache::loncommon::start_page('Help Menu', undef,
                   1197: 				       {'frameset'    => 1,
                   1198: 					'js_ready'    => 1,
                   1199: 					'add_entries' => {
                   1200: 					    'border' => '0',
1.579     raeburn  1201: 					    'rows'   => "110,*",},});
1.331     albertel 1202:     my $end_page =
                   1203:         &Apache::loncommon::end_page({'frameset' => 1,
                   1204: 				      'js_ready' => 1,});
                   1205: 
1.436     albertel 1206:     my $template .= <<"ENDTEMPLATE";
                   1207: <script type="text/javascript">
1.877     bisitz   1208: // <![CDATA[
1.253     albertel 1209: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1210: var banner_link = '';
1.243     raeburn  1211: function helpMenu(target) {
                   1212:     var caller = this;
                   1213:     if (target == 'open') {
                   1214:         var newWindow = null;
                   1215:         try {
1.262     albertel 1216:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1217:         }
                   1218:         catch(error) {
                   1219:             writeHelp(caller);
                   1220:             return;
                   1221:         }
                   1222:         if (newWindow) {
                   1223:             caller = newWindow;
                   1224:         }
1.193     raeburn  1225:     }
1.243     raeburn  1226:     writeHelp(caller);
                   1227:     return;
                   1228: }
                   1229: function writeHelp(caller) {
1.430     albertel 1230:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1231:     caller.document.close()
                   1232:     caller.focus()
1.193     raeburn  1233: }
1.877     bisitz   1234: // END LON-CAPA Internal -->
1.253     albertel 1235: // ]]>
1.436     albertel 1236: </script>
1.193     raeburn  1237: ENDTEMPLATE
                   1238:     return $template;
                   1239: }
                   1240: 
1.172     www      1241: sub help_open_bug {
                   1242:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1243:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1244:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1245:     $text = "" if (not defined $text);
                   1246:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1247:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1248: 	$stayOnPage=1;
                   1249:     }
1.184     albertel 1250:     $width = 600 if (not defined $width);
                   1251:     $height = 600 if (not defined $height);
1.172     www      1252: 
                   1253:     $topic=~s/\W+/\+/g;
                   1254:     my $link='';
                   1255:     my $template='';
1.379     albertel 1256:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1257: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1258:     if (!$stayOnPage)
                   1259:     {
                   1260: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1261:     }
                   1262:     else
                   1263:     {
                   1264: 	$link = $url;
                   1265:     }
                   1266:     # Add the text
                   1267:     if ($text ne "")
                   1268:     {
                   1269: 	$template .= 
                   1270:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1271:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1272:     }
                   1273: 
                   1274:     # Add the graphic
1.179     matthew  1275:     my $title = &mt('Report a Bug');
1.215     albertel 1276:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1277:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1278:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1279: ENDTEMPLATE
                   1280:     if ($text ne '') { $template.='</td></tr></table>' };
                   1281:     return $template;
                   1282: 
                   1283: }
                   1284: 
                   1285: sub help_open_faq {
                   1286:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1287:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1288:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1289:     $text = "" if (not defined $text);
                   1290:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1291:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1292: 	$stayOnPage=1;
                   1293:     }
                   1294:     $width = 350 if (not defined $width);
                   1295:     $height = 400 if (not defined $height);
                   1296: 
                   1297:     $topic=~s/\W+/\+/g;
                   1298:     my $link='';
                   1299:     my $template='';
                   1300:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1301:     if (!$stayOnPage)
                   1302:     {
                   1303: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1304:     }
                   1305:     else
                   1306:     {
                   1307: 	$link = $url;
                   1308:     }
                   1309: 
                   1310:     # Add the text
                   1311:     if ($text ne "")
                   1312:     {
                   1313: 	$template .= 
1.173     www      1314:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1315:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1316:     }
                   1317: 
                   1318:     # Add the graphic
1.179     matthew  1319:     my $title = &mt('View the FAQ');
1.215     albertel 1320:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1321:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1322:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1323: ENDTEMPLATE
                   1324:     if ($text ne '') { $template.='</td></tr></table>' };
                   1325:     return $template;
                   1326: 
1.44      bowersj2 1327: }
1.37      matthew  1328: 
1.180     matthew  1329: ###############################################################
                   1330: ###############################################################
                   1331: 
1.45      matthew  1332: =pod
                   1333: 
1.648     raeburn  1334: =item * &change_content_javascript():
1.256     matthew  1335: 
                   1336: This and the next function allow you to create small sections of an
                   1337: otherwise static HTML page that you can update on the fly with
                   1338: Javascript, even in Netscape 4.
                   1339: 
                   1340: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1341: must be written to the HTML page once. It will prove the Javascript
                   1342: function "change(name, content)". Calling the change function with the
                   1343: name of the section 
                   1344: you want to update, matching the name passed to C<changable_area>, and
                   1345: the new content you want to put in there, will put the content into
                   1346: that area.
                   1347: 
                   1348: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1349: to contain room for the original contents. You need to "make space"
                   1350: for whatever changes you wish to make, and be B<sure> to check your
                   1351: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1352: it's adequate for updating a one-line status display, but little more.
                   1353: This script will set the space to 100% width, so you only need to
                   1354: worry about height in Netscape 4.
                   1355: 
                   1356: Modern browsers are much less limiting, and if you can commit to the
                   1357: user not using Netscape 4, this feature may be used freely with
                   1358: pretty much any HTML.
                   1359: 
                   1360: =cut
                   1361: 
                   1362: sub change_content_javascript {
                   1363:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1364:     if ($env{'browser.type'} eq 'netscape' &&
                   1365: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1366: 	return (<<NETSCAPE4);
                   1367: 	function change(name, content) {
                   1368: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1369: 	    doc.open();
                   1370: 	    doc.write(content);
                   1371: 	    doc.close();
                   1372: 	}
                   1373: NETSCAPE4
                   1374:     } else {
                   1375: 	# Otherwise, we need to use semi-standards-compliant code
                   1376: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1377: 	# is really scary, and every useful browser supports it
                   1378: 	return (<<DOMBASED);
                   1379: 	function change(name, content) {
                   1380: 	    element = document.getElementById(name);
                   1381: 	    element.innerHTML = content;
                   1382: 	}
                   1383: DOMBASED
                   1384:     }
                   1385: }
                   1386: 
                   1387: =pod
                   1388: 
1.648     raeburn  1389: =item * &changable_area($name,$origContent):
1.256     matthew  1390: 
                   1391: This provides a "changable area" that can be modified on the fly via
                   1392: the Javascript code provided in C<change_content_javascript>. $name is
                   1393: the name you will use to reference the area later; do not repeat the
                   1394: same name on a given HTML page more then once. $origContent is what
                   1395: the area will originally contain, which can be left blank.
                   1396: 
                   1397: =cut
                   1398: 
                   1399: sub changable_area {
                   1400:     my ($name, $origContent) = @_;
                   1401: 
1.258     albertel 1402:     if ($env{'browser.type'} eq 'netscape' &&
                   1403: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1404: 	# If this is netscape 4, we need to use the Layer tag
                   1405: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1406:     } else {
                   1407: 	return "<span id='$name'>$origContent</span>";
                   1408:     }
                   1409: }
                   1410: 
                   1411: =pod
                   1412: 
1.648     raeburn  1413: =item * &viewport_geometry_js 
1.590     raeburn  1414: 
                   1415: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1416: 
                   1417: =cut
                   1418: 
                   1419: 
                   1420: sub viewport_geometry_js { 
                   1421:     return <<"GEOMETRY";
                   1422: var Geometry = {};
                   1423: function init_geometry() {
                   1424:     if (Geometry.init) { return };
                   1425:     Geometry.init=1;
                   1426:     if (window.innerHeight) {
                   1427:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1428:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1429:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1430:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1431:     }
                   1432:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1433:         Geometry.getViewportHeight =
                   1434:             function() { return document.documentElement.clientHeight; };
                   1435:         Geometry.getViewportWidth =
                   1436:             function() { return document.documentElement.clientWidth; };
                   1437: 
                   1438:         Geometry.getHorizontalScroll =
                   1439:             function() { return document.documentElement.scrollLeft; };
                   1440:         Geometry.getVerticalScroll =
                   1441:             function() { return document.documentElement.scrollTop; };
                   1442:     }
                   1443:     else if (document.body.clientHeight) {
                   1444:         Geometry.getViewportHeight =
                   1445:             function() { return document.body.clientHeight; };
                   1446:         Geometry.getViewportWidth =
                   1447:             function() { return document.body.clientWidth; };
                   1448:         Geometry.getHorizontalScroll =
                   1449:             function() { return document.body.scrollLeft; };
                   1450:         Geometry.getVerticalScroll =
                   1451:             function() { return document.body.scrollTop; };
                   1452:     }
                   1453: }
                   1454: 
                   1455: GEOMETRY
                   1456: }
                   1457: 
                   1458: =pod
                   1459: 
1.648     raeburn  1460: =item * &viewport_size_js()
1.590     raeburn  1461: 
                   1462: 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. 
                   1463: 
                   1464: =cut
                   1465: 
                   1466: sub viewport_size_js {
                   1467:     my $geometry = &viewport_geometry_js();
                   1468:     return <<"DIMS";
                   1469: 
                   1470: $geometry
                   1471: 
                   1472: function getViewportDims(width,height) {
                   1473:     init_geometry();
                   1474:     width.value = Geometry.getViewportWidth();
                   1475:     height.value = Geometry.getViewportHeight();
                   1476:     return;
                   1477: }
                   1478: 
                   1479: DIMS
                   1480: }
                   1481: 
                   1482: =pod
                   1483: 
1.648     raeburn  1484: =item * &resize_textarea_js()
1.565     albertel 1485: 
                   1486: emits the needed javascript to resize a textarea to be as big as possible
                   1487: 
                   1488: creates a function resize_textrea that takes two IDs first should be
                   1489: the id of the element to resize, second should be the id of a div that
                   1490: surrounds everything that comes after the textarea, this routine needs
                   1491: to be attached to the <body> for the onload and onresize events.
                   1492: 
1.648     raeburn  1493: =back
1.565     albertel 1494: 
                   1495: =cut
                   1496: 
                   1497: sub resize_textarea_js {
1.590     raeburn  1498:     my $geometry = &viewport_geometry_js();
1.565     albertel 1499:     return <<"RESIZE";
                   1500:     <script type="text/javascript">
1.824     bisitz   1501: // <![CDATA[
1.590     raeburn  1502: $geometry
1.565     albertel 1503: 
1.588     albertel 1504: function getX(element) {
                   1505:     var x = 0;
                   1506:     while (element) {
                   1507: 	x += element.offsetLeft;
                   1508: 	element = element.offsetParent;
                   1509:     }
                   1510:     return x;
                   1511: }
                   1512: function getY(element) {
                   1513:     var y = 0;
                   1514:     while (element) {
                   1515: 	y += element.offsetTop;
                   1516: 	element = element.offsetParent;
                   1517:     }
                   1518:     return y;
                   1519: }
                   1520: 
                   1521: 
1.565     albertel 1522: function resize_textarea(textarea_id,bottom_id) {
                   1523:     init_geometry();
                   1524:     var textarea        = document.getElementById(textarea_id);
                   1525:     //alert(textarea);
                   1526: 
1.588     albertel 1527:     var textarea_top    = getY(textarea);
1.565     albertel 1528:     var textarea_height = textarea.offsetHeight;
                   1529:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1530:     var bottom_top      = getY(bottom);
1.565     albertel 1531:     var bottom_height   = bottom.offsetHeight;
                   1532:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1533:     var fudge           = 23;
1.565     albertel 1534:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1535:     if (new_height < 300) {
                   1536: 	new_height = 300;
                   1537:     }
                   1538:     textarea.style.height=new_height+'px';
                   1539: }
1.824     bisitz   1540: // ]]>
1.565     albertel 1541: </script>
                   1542: RESIZE
                   1543: 
                   1544: }
                   1545: 
                   1546: =pod
                   1547: 
1.256     matthew  1548: =head1 Excel and CSV file utility routines
                   1549: 
                   1550: =over 4
                   1551: 
                   1552: =cut
                   1553: 
                   1554: ###############################################################
                   1555: ###############################################################
                   1556: 
                   1557: =pod
                   1558: 
1.648     raeburn  1559: =item * &csv_translate($text) 
1.37      matthew  1560: 
1.185     www      1561: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1562: format.
                   1563: 
                   1564: =cut
                   1565: 
1.180     matthew  1566: ###############################################################
                   1567: ###############################################################
1.37      matthew  1568: sub csv_translate {
                   1569:     my $text = shift;
                   1570:     $text =~ s/\"/\"\"/g;
1.209     albertel 1571:     $text =~ s/\n/ /g;
1.37      matthew  1572:     return $text;
                   1573: }
1.180     matthew  1574: 
                   1575: ###############################################################
                   1576: ###############################################################
                   1577: 
                   1578: =pod
                   1579: 
1.648     raeburn  1580: =item * &define_excel_formats()
1.180     matthew  1581: 
                   1582: Define some commonly used Excel cell formats.
                   1583: 
                   1584: Currently supported formats:
                   1585: 
                   1586: =over 4
                   1587: 
                   1588: =item header
                   1589: 
                   1590: =item bold
                   1591: 
                   1592: =item h1
                   1593: 
                   1594: =item h2
                   1595: 
                   1596: =item h3
                   1597: 
1.256     matthew  1598: =item h4
                   1599: 
                   1600: =item i
                   1601: 
1.180     matthew  1602: =item date
                   1603: 
                   1604: =back
                   1605: 
                   1606: Inputs: $workbook
                   1607: 
                   1608: Returns: $format, a hash reference.
                   1609: 
                   1610: =cut
                   1611: 
                   1612: ###############################################################
                   1613: ###############################################################
                   1614: sub define_excel_formats {
                   1615:     my ($workbook) = @_;
                   1616:     my $format;
                   1617:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1618:                                                 bottom    => 1,
                   1619:                                                 align     => 'center');
                   1620:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1621:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1622:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1623:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1624:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1625:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1626:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1627:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1628:     return $format;
                   1629: }
                   1630: 
                   1631: ###############################################################
                   1632: ###############################################################
1.113     bowersj2 1633: 
                   1634: =pod
                   1635: 
1.648     raeburn  1636: =item * &create_workbook()
1.255     matthew  1637: 
                   1638: Create an Excel worksheet.  If it fails, output message on the
                   1639: request object and return undefs.
                   1640: 
                   1641: Inputs: Apache request object
                   1642: 
                   1643: Returns (undef) on failure, 
                   1644:     Excel worksheet object, scalar with filename, and formats 
                   1645:     from &Apache::loncommon::define_excel_formats on success
                   1646: 
                   1647: =cut
                   1648: 
                   1649: ###############################################################
                   1650: ###############################################################
                   1651: sub create_workbook {
                   1652:     my ($r) = @_;
                   1653:         #
                   1654:     # Create the excel spreadsheet
                   1655:     my $filename = '/prtspool/'.
1.258     albertel 1656:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1657:         time.'_'.rand(1000000000).'.xls';
                   1658:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1659:     if (! defined($workbook)) {
                   1660:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1661:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1662:                             "This error has been logged.  ".
                   1663:                             "Please alert your LON-CAPA administrator").
                   1664:                   '</p>');
                   1665:         return (undef);
                   1666:     }
                   1667:     #
                   1668:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1669:     #
                   1670:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1671:     return ($workbook,$filename,$format);
                   1672: }
                   1673: 
                   1674: ###############################################################
                   1675: ###############################################################
                   1676: 
                   1677: =pod
                   1678: 
1.648     raeburn  1679: =item * &create_text_file()
1.113     bowersj2 1680: 
1.542     raeburn  1681: Create a file to write to and eventually make available to the user.
1.256     matthew  1682: If file creation fails, outputs an error message on the request object and 
                   1683: return undefs.
1.113     bowersj2 1684: 
1.256     matthew  1685: Inputs: Apache request object, and file suffix
1.113     bowersj2 1686: 
1.256     matthew  1687: Returns (undef) on failure, 
                   1688:     Filehandle and filename on success.
1.113     bowersj2 1689: 
                   1690: =cut
                   1691: 
1.256     matthew  1692: ###############################################################
                   1693: ###############################################################
                   1694: sub create_text_file {
                   1695:     my ($r,$suffix) = @_;
                   1696:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1697:     my $fh;
                   1698:     my $filename = '/prtspool/'.
1.258     albertel 1699:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1700:         time.'_'.rand(1000000000).'.'.$suffix;
                   1701:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1702:     if (! defined($fh)) {
                   1703:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1704:         $r->print(&mt('Problems occurred in creating the output file. '
                   1705:                      .'This error has been logged. '
                   1706:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1707:     }
1.256     matthew  1708:     return ($fh,$filename)
1.113     bowersj2 1709: }
                   1710: 
                   1711: 
1.256     matthew  1712: =pod 
1.113     bowersj2 1713: 
                   1714: =back
                   1715: 
                   1716: =cut
1.37      matthew  1717: 
                   1718: ###############################################################
1.33      matthew  1719: ##        Home server <option> list generating code          ##
                   1720: ###############################################################
1.35      matthew  1721: 
1.169     www      1722: # ------------------------------------------
                   1723: 
                   1724: sub domain_select {
                   1725:     my ($name,$value,$multiple)=@_;
                   1726:     my %domains=map { 
1.514     albertel 1727: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1728:     } &Apache::lonnet::all_domains();
1.169     www      1729:     if ($multiple) {
                   1730: 	$domains{''}=&mt('Any domain');
1.550     albertel 1731: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1732: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1733:     } else {
1.550     albertel 1734: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1735: 	return &select_form($name,$value,%domains);
                   1736:     }
                   1737: }
                   1738: 
1.282     albertel 1739: #-------------------------------------------
                   1740: 
                   1741: =pod
                   1742: 
1.519     raeburn  1743: =head1 Routines for form select boxes
                   1744: 
                   1745: =over 4
                   1746: 
1.648     raeburn  1747: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1748: 
                   1749: Returns a string containing a <select> element int multiple mode
                   1750: 
                   1751: 
                   1752: Args:
                   1753:   $name - name of the <select> element
1.506     raeburn  1754:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1755:   $size - number of rows long the select element is
1.283     albertel 1756:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1757:           (shown text should already have been &mt())
1.506     raeburn  1758:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1759: 
1.282     albertel 1760: =cut
                   1761: 
                   1762: #-------------------------------------------
1.169     www      1763: sub multiple_select_form {
1.284     albertel 1764:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1765:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1766:     my $output='';
1.191     matthew  1767:     if (! defined($size)) {
                   1768:         $size = 4;
1.283     albertel 1769:         if (scalar(keys(%$hash))<4) {
                   1770:             $size = scalar(keys(%$hash));
1.191     matthew  1771:         }
                   1772:     }
1.734     bisitz   1773:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1774:     my @order;
1.506     raeburn  1775:     if (ref($order) eq 'ARRAY')  {
                   1776:         @order = @{$order};
                   1777:     } else {
                   1778:         @order = sort(keys(%$hash));
1.501     banghart 1779:     }
                   1780:     if (exists($$hash{'select_form_order'})) {
                   1781:         @order = @{$$hash{'select_form_order'}};
                   1782:     }
                   1783:         
1.284     albertel 1784:     foreach my $key (@order) {
1.356     albertel 1785:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1786:         $output.='selected="selected" ' if ($selected{$key});
                   1787:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1788:     }
                   1789:     $output.="</select>\n";
                   1790:     return $output;
                   1791: }
                   1792: 
1.88      www      1793: #-------------------------------------------
                   1794: 
                   1795: =pod
                   1796: 
1.648     raeburn  1797: =item * &select_form($defdom,$name,%hash)
1.88      www      1798: 
                   1799: Returns a string containing a <select name='$name' size='1'> form to 
                   1800: allow a user to select options from a hash option_name => displayed text.  
                   1801: See lonrights.pm for an example invocation and use.
                   1802: 
                   1803: =cut
                   1804: 
                   1805: #-------------------------------------------
                   1806: sub select_form {
                   1807:     my ($def,$name,%hash) = @_;
                   1808:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1809:     my @keys;
                   1810:     if (exists($hash{'select_form_order'})) {
                   1811: 	@keys=@{$hash{'select_form_order'}};
                   1812:     } else {
                   1813: 	@keys=sort(keys(%hash));
                   1814:     }
1.356     albertel 1815:     foreach my $key (@keys) {
                   1816:         $selectform.=
                   1817: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1818:             ($key eq $def ? 'selected="selected" ' : '').
                   1819:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1820:     }
                   1821:     $selectform.="</select>";
                   1822:     return $selectform;
                   1823: }
                   1824: 
1.475     www      1825: # For display filters
                   1826: 
                   1827: sub display_filter {
                   1828:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1829:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1830:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1831: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1832: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1833: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1834:            &mt('Filter [_1]',
1.477     www      1835: 	   &select_form($env{'form.displayfilter'},
                   1836: 			'displayfilter',
                   1837: 			('currentfolder' => 'Current folder/page',
                   1838: 			 'containing' => 'Containing phrase',
                   1839: 			 'none' => 'None'))).
1.714     bisitz   1840: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1841: }
                   1842: 
1.167     www      1843: sub gradeleveldescription {
                   1844:     my $gradelevel=shift;
                   1845:     my %gradelevels=(0 => 'Not specified',
                   1846: 		     1 => 'Grade 1',
                   1847: 		     2 => 'Grade 2',
                   1848: 		     3 => 'Grade 3',
                   1849: 		     4 => 'Grade 4',
                   1850: 		     5 => 'Grade 5',
                   1851: 		     6 => 'Grade 6',
                   1852: 		     7 => 'Grade 7',
                   1853: 		     8 => 'Grade 8',
                   1854: 		     9 => 'Grade 9',
                   1855: 		     10 => 'Grade 10',
                   1856: 		     11 => 'Grade 11',
                   1857: 		     12 => 'Grade 12',
                   1858: 		     13 => 'Grade 13',
                   1859: 		     14 => '100 Level',
                   1860: 		     15 => '200 Level',
                   1861: 		     16 => '300 Level',
                   1862: 		     17 => '400 Level',
                   1863: 		     18 => 'Graduate Level');
                   1864:     return &mt($gradelevels{$gradelevel});
                   1865: }
                   1866: 
1.163     www      1867: sub select_level_form {
                   1868:     my ($deflevel,$name)=@_;
                   1869:     unless ($deflevel) { $deflevel=0; }
1.167     www      1870:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1871:     for (my $i=0; $i<=18; $i++) {
                   1872:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1873:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1874:                 ">".&gradeleveldescription($i)."</option>\n";
                   1875:     }
                   1876:     $selectform.="</select>";
                   1877:     return $selectform;
1.163     www      1878: }
1.167     www      1879: 
1.35      matthew  1880: #-------------------------------------------
                   1881: 
1.45      matthew  1882: =pod
                   1883: 
1.873     raeburn  1884: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange)
1.35      matthew  1885: 
                   1886: Returns a string containing a <select name='$name' size='1'> form to 
                   1887: allow a user to select the domain to preform an operation in.  
                   1888: See loncreateuser.pm for an example invocation and use.
                   1889: 
1.90      www      1890: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1891: selected");
                   1892: 
1.743     raeburn  1893: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1894: 
1.872     raeburn  1895: 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  1896: 
1.35      matthew  1897: =cut
                   1898: 
                   1899: #-------------------------------------------
1.34      matthew  1900: sub select_dom_form {
1.872     raeburn  1901:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange) = @_;
                   1902:     if ($onchange) {
1.874     raeburn  1903:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1904:     }
1.550     albertel 1905:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1906:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1907:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1908:     foreach my $dom (@domains) {
                   1909:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1910:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1911:         if ($showdomdesc) {
                   1912:             if ($dom ne '') {
                   1913:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1914:                 if ($domdesc ne '') {
                   1915:                     $selectdomain .= ' ('.$domdesc.')';
                   1916:                 }
                   1917:             } 
                   1918:         }
                   1919:         $selectdomain .= "</option>\n";
1.34      matthew  1920:     }
                   1921:     $selectdomain.="</select>";
                   1922:     return $selectdomain;
                   1923: }
                   1924: 
1.35      matthew  1925: #-------------------------------------------
                   1926: 
1.45      matthew  1927: =pod
                   1928: 
1.648     raeburn  1929: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1930: 
1.586     raeburn  1931: input: 4 arguments (two required, two optional) - 
                   1932:     $domain - domain of new user
                   1933:     $name - name of form element
                   1934:     $default - Value of 'default' causes a default item to be first 
                   1935:                             option, and selected by default. 
                   1936:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1937:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1938: output: returns 2 items: 
1.586     raeburn  1939: (a) form element which contains either:
                   1940:    (i) <select name="$name">
                   1941:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1942:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1943:        </select>
                   1944:        form item if there are multiple library servers in $domain, or
                   1945:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1946:        if there is only one library server in $domain.
                   1947: 
                   1948: (b) number of library servers found.
                   1949: 
                   1950: See loncreateuser.pm for example of use.
1.35      matthew  1951: 
                   1952: =cut
                   1953: 
                   1954: #-------------------------------------------
1.586     raeburn  1955: sub home_server_form_item {
                   1956:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1957:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1958:     my $result;
                   1959:     my $numlib = keys(%servers);
                   1960:     if ($numlib > 1) {
                   1961:         $result .= '<select name="'.$name.'" />'."\n";
                   1962:         if ($default) {
1.804     bisitz   1963:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1964:                        '</option>'."\n";
                   1965:         }
                   1966:         foreach my $hostid (sort(keys(%servers))) {
                   1967:             $result.= '<option value="'.$hostid.'">'.
                   1968: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1969:         }
                   1970:         $result .= '</select>'."\n";
                   1971:     } elsif ($numlib == 1) {
                   1972:         my $hostid;
                   1973:         foreach my $item (keys(%servers)) {
                   1974:             $hostid = $item;
                   1975:         }
                   1976:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1977:                    $hostid.'" />';
                   1978:                    if (!$hide) {
                   1979:                        $result .= $hostid.' '.$servers{$hostid};
                   1980:                    }
                   1981:                    $result .= "\n";
                   1982:     } elsif ($default) {
                   1983:         $result .= '<input type="hidden" name="'.$name.
                   1984:                    '" value="default" />';
                   1985:                    if (!$hide) {
                   1986:                        $result .= &mt('default');
                   1987:                    }
                   1988:                    $result .= "\n";
1.33      matthew  1989:     }
1.586     raeburn  1990:     return ($result,$numlib);
1.33      matthew  1991: }
1.112     bowersj2 1992: 
                   1993: =pod
                   1994: 
1.534     albertel 1995: =back 
                   1996: 
1.112     bowersj2 1997: =cut
1.87      matthew  1998: 
                   1999: ###############################################################
1.112     bowersj2 2000: ##                  Decoding User Agent                      ##
1.87      matthew  2001: ###############################################################
                   2002: 
                   2003: =pod
                   2004: 
1.112     bowersj2 2005: =head1 Decoding the User Agent
                   2006: 
                   2007: =over 4
                   2008: 
                   2009: =item * &decode_user_agent()
1.87      matthew  2010: 
                   2011: Inputs: $r
                   2012: 
                   2013: Outputs:
                   2014: 
                   2015: =over 4
                   2016: 
1.112     bowersj2 2017: =item * $httpbrowser
1.87      matthew  2018: 
1.112     bowersj2 2019: =item * $clientbrowser
1.87      matthew  2020: 
1.112     bowersj2 2021: =item * $clientversion
1.87      matthew  2022: 
1.112     bowersj2 2023: =item * $clientmathml
1.87      matthew  2024: 
1.112     bowersj2 2025: =item * $clientunicode
1.87      matthew  2026: 
1.112     bowersj2 2027: =item * $clientos
1.87      matthew  2028: 
                   2029: =back
                   2030: 
1.157     matthew  2031: =back 
                   2032: 
1.87      matthew  2033: =cut
                   2034: 
                   2035: ###############################################################
                   2036: ###############################################################
                   2037: sub decode_user_agent {
1.247     albertel 2038:     my ($r)=@_;
1.87      matthew  2039:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2040:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2041:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2042:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2043:     my $clientbrowser='unknown';
                   2044:     my $clientversion='0';
                   2045:     my $clientmathml='';
                   2046:     my $clientunicode='0';
                   2047:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2048:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2049: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2050: 	    $clientbrowser=$bname;
                   2051:             $httpbrowser=~/$vreg/i;
                   2052: 	    $clientversion=$1;
                   2053:             $clientmathml=($clientversion>=$minv);
                   2054:             $clientunicode=($clientversion>=$univ);
                   2055: 	}
                   2056:     }
                   2057:     my $clientos='unknown';
                   2058:     if (($httpbrowser=~/linux/i) ||
                   2059:         ($httpbrowser=~/unix/i) ||
                   2060:         ($httpbrowser=~/ux/i) ||
                   2061:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2062:     if (($httpbrowser=~/vax/i) ||
                   2063:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2064:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2065:     if (($httpbrowser=~/mac/i) ||
                   2066:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2067:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2068:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2069:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2070:             $clientunicode,$clientos,);
                   2071: }
                   2072: 
1.32      matthew  2073: ###############################################################
                   2074: ##    Authentication changing form generation subroutines    ##
                   2075: ###############################################################
                   2076: ##
                   2077: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2078: ## hash, and have reasonable default values.
                   2079: ##
                   2080: ##    formname = the name given in the <form> tag.
1.35      matthew  2081: #-------------------------------------------
                   2082: 
1.45      matthew  2083: =pod
                   2084: 
1.112     bowersj2 2085: =head1 Authentication Routines
                   2086: 
                   2087: =over 4
                   2088: 
1.648     raeburn  2089: =item * &authform_xxxxxx()
1.35      matthew  2090: 
                   2091: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2092: handle some of the conveniences required for authentication forms.  
                   2093: This is not an optimal method, but it works.  
                   2094: 
                   2095: =over 4
                   2096: 
1.112     bowersj2 2097: =item * authform_header
1.35      matthew  2098: 
1.112     bowersj2 2099: =item * authform_authorwarning
1.35      matthew  2100: 
1.112     bowersj2 2101: =item * authform_nochange
1.35      matthew  2102: 
1.112     bowersj2 2103: =item * authform_kerberos
1.35      matthew  2104: 
1.112     bowersj2 2105: =item * authform_internal
1.35      matthew  2106: 
1.112     bowersj2 2107: =item * authform_filesystem
1.35      matthew  2108: 
                   2109: =back
                   2110: 
1.648     raeburn  2111: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2112: 
1.35      matthew  2113: =cut
                   2114: 
                   2115: #-------------------------------------------
1.32      matthew  2116: sub authform_header{  
                   2117:     my %in = (
                   2118:         formname => 'cu',
1.80      albertel 2119:         kerb_def_dom => '',
1.32      matthew  2120:         @_,
                   2121:     );
                   2122:     $in{'formname'} = 'document.' . $in{'formname'};
                   2123:     my $result='';
1.80      albertel 2124: 
                   2125: #---------------------------------------------- Code for upper case translation
                   2126:     my $Javascript_toUpperCase;
                   2127:     unless ($in{kerb_def_dom}) {
                   2128:         $Javascript_toUpperCase =<<"END";
                   2129:         switch (choice) {
                   2130:            case 'krb': currentform.elements[choicearg].value =
                   2131:                currentform.elements[choicearg].value.toUpperCase();
                   2132:                break;
                   2133:            default:
                   2134:         }
                   2135: END
                   2136:     } else {
                   2137:         $Javascript_toUpperCase = "";
                   2138:     }
                   2139: 
1.165     raeburn  2140:     my $radioval = "'nochange'";
1.591     raeburn  2141:     if (defined($in{'curr_authtype'})) {
                   2142:         if ($in{'curr_authtype'} ne '') {
                   2143:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2144:         }
1.174     matthew  2145:     }
1.165     raeburn  2146:     my $argfield = 'null';
1.591     raeburn  2147:     if (defined($in{'mode'})) {
1.165     raeburn  2148:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2149:             if (defined($in{'curr_autharg'})) {
                   2150:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2151:                     $argfield = "'$in{'curr_autharg'}'";
                   2152:                 }
                   2153:             }
                   2154:         }
                   2155:     }
                   2156: 
1.32      matthew  2157:     $result.=<<"END";
                   2158: var current = new Object();
1.165     raeburn  2159: current.radiovalue = $radioval;
                   2160: current.argfield = $argfield;
1.32      matthew  2161: 
                   2162: function changed_radio(choice,currentform) {
                   2163:     var choicearg = choice + 'arg';
                   2164:     // If a radio button in changed, we need to change the argfield
                   2165:     if (current.radiovalue != choice) {
                   2166:         current.radiovalue = choice;
                   2167:         if (current.argfield != null) {
                   2168:             currentform.elements[current.argfield].value = '';
                   2169:         }
                   2170:         if (choice == 'nochange') {
                   2171:             current.argfield = null;
                   2172:         } else {
                   2173:             current.argfield = choicearg;
                   2174:             switch(choice) {
                   2175:                 case 'krb': 
                   2176:                     currentform.elements[current.argfield].value = 
                   2177:                         "$in{'kerb_def_dom'}";
                   2178:                 break;
                   2179:               default:
                   2180:                 break;
                   2181:             }
                   2182:         }
                   2183:     }
                   2184:     return;
                   2185: }
1.22      www      2186: 
1.32      matthew  2187: function changed_text(choice,currentform) {
                   2188:     var choicearg = choice + 'arg';
                   2189:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2190:         $Javascript_toUpperCase
1.32      matthew  2191:         // clear old field
                   2192:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2193:             currentform.elements[current.argfield].value = '';
                   2194:         }
                   2195:         current.argfield = choicearg;
                   2196:     }
                   2197:     set_auth_radio_buttons(choice,currentform);
                   2198:     return;
1.20      www      2199: }
1.32      matthew  2200: 
                   2201: function set_auth_radio_buttons(newvalue,currentform) {
                   2202:     var i=0;
                   2203:     while (i < currentform.login.length) {
                   2204:         if (currentform.login[i].value == newvalue) { break; }
                   2205:         i++;
                   2206:     }
                   2207:     if (i == currentform.login.length) {
                   2208:         return;
                   2209:     }
                   2210:     current.radiovalue = newvalue;
                   2211:     currentform.login[i].checked = true;
                   2212:     return;
                   2213: }
                   2214: END
                   2215:     return $result;
                   2216: }
                   2217: 
                   2218: sub authform_authorwarning{
                   2219:     my $result='';
1.144     matthew  2220:     $result='<i>'.
                   2221:         &mt('As a general rule, only authors or co-authors should be '.
                   2222:             'filesystem authenticated '.
                   2223:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2224:     return $result;
                   2225: }
                   2226: 
                   2227: sub authform_nochange{  
                   2228:     my %in = (
                   2229:               formname => 'document.cu',
                   2230:               kerb_def_dom => 'MSU.EDU',
                   2231:               @_,
                   2232:           );
1.586     raeburn  2233:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2234:     my $result;
                   2235:     if (keys(%can_assign) == 0) {
                   2236:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2237:     } else {
                   2238:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2239:                   '<input type="radio" name="login" value="nochange" '.
                   2240:                   'checked="checked" onclick="'.
1.281     albertel 2241:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2242: 	    '</label>';
1.586     raeburn  2243:     }
1.32      matthew  2244:     return $result;
                   2245: }
                   2246: 
1.591     raeburn  2247: sub authform_kerberos {
1.32      matthew  2248:     my %in = (
                   2249:               formname => 'document.cu',
                   2250:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2251:               kerb_def_auth => 'krb4',
1.32      matthew  2252:               @_,
                   2253:               );
1.586     raeburn  2254:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2255:         $autharg,$jscall);
                   2256:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2257:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2258:        $check5 = ' checked="checked"';
1.80      albertel 2259:     } else {
1.772     bisitz   2260:        $check4 = ' checked="checked"';
1.80      albertel 2261:     }
1.165     raeburn  2262:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2263:     if (defined($in{'curr_authtype'})) {
                   2264:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2265:             $krbcheck = ' checked="checked"';
1.623     raeburn  2266:             if (defined($in{'mode'})) {
                   2267:                 if ($in{'mode'} eq 'modifyuser') {
                   2268:                     $krbcheck = '';
                   2269:                 }
                   2270:             }
1.591     raeburn  2271:             if (defined($in{'curr_kerb_ver'})) {
                   2272:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2273:                     $check5 = ' checked="checked"';
1.591     raeburn  2274:                     $check4 = '';
                   2275:                 } else {
1.772     bisitz   2276:                     $check4 = ' checked="checked"';
1.591     raeburn  2277:                     $check5 = '';
                   2278:                 }
1.586     raeburn  2279:             }
1.591     raeburn  2280:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2281:                 $krbarg = $in{'curr_autharg'};
                   2282:             }
1.586     raeburn  2283:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2284:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2285:                     $result = 
                   2286:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2287:         $in{'curr_autharg'},$krbver);
                   2288:                 } else {
                   2289:                     $result =
                   2290:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2291:                 }
                   2292:                 return $result; 
                   2293:             }
                   2294:         }
                   2295:     } else {
                   2296:         if ($authnum == 1) {
1.784     bisitz   2297:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2298:         }
                   2299:     }
1.586     raeburn  2300:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2301:         return;
1.587     raeburn  2302:     } elsif ($authtype eq '') {
1.591     raeburn  2303:         if (defined($in{'mode'})) {
1.587     raeburn  2304:             if ($in{'mode'} eq 'modifycourse') {
                   2305:                 if ($authnum == 1) {
1.784     bisitz   2306:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2307:                 }
                   2308:             }
                   2309:         }
1.586     raeburn  2310:     }
                   2311:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2312:     if ($authtype eq '') {
                   2313:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2314:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2315:                     $krbcheck.' />';
                   2316:     }
                   2317:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2318:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2319:          $in{'curr_authtype'} eq 'krb5') ||
                   2320:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2321:          $in{'curr_authtype'} eq 'krb4')) {
                   2322:         $result .= &mt
1.144     matthew  2323:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2324:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2325:          '<label>'.$authtype,
1.281     albertel 2326:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2327:              'value="'.$krbarg.'" '.
1.144     matthew  2328:              'onchange="'.$jscall.'" />',
1.281     albertel 2329:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2330:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2331: 	 '</label>');
1.586     raeburn  2332:     } elsif ($can_assign{'krb4'}) {
                   2333:         $result .= &mt
                   2334:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2335:          '[_3] Version 4 [_4]',
                   2336:          '<label>'.$authtype,
                   2337:          '</label><input type="text" size="10" name="krbarg" '.
                   2338:              'value="'.$krbarg.'" '.
                   2339:              'onchange="'.$jscall.'" />',
                   2340:          '<label><input type="hidden" name="krbver" value="4" />',
                   2341:          '</label>');
                   2342:     } elsif ($can_assign{'krb5'}) {
                   2343:         $result .= &mt
                   2344:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2345:          '[_3] Version 5 [_4]',
                   2346:          '<label>'.$authtype,
                   2347:          '</label><input type="text" size="10" name="krbarg" '.
                   2348:              'value="'.$krbarg.'" '.
                   2349:              'onchange="'.$jscall.'" />',
                   2350:          '<label><input type="hidden" name="krbver" value="5" />',
                   2351:          '</label>');
                   2352:     }
1.32      matthew  2353:     return $result;
                   2354: }
                   2355: 
                   2356: sub authform_internal{  
1.586     raeburn  2357:     my %in = (
1.32      matthew  2358:                 formname => 'document.cu',
                   2359:                 kerb_def_dom => 'MSU.EDU',
                   2360:                 @_,
                   2361:                 );
1.586     raeburn  2362:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2363:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2364:     if (defined($in{'curr_authtype'})) {
                   2365:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2366:             if ($can_assign{'int'}) {
1.772     bisitz   2367:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2368:                 if (defined($in{'mode'})) {
                   2369:                     if ($in{'mode'} eq 'modifyuser') {
                   2370:                         $intcheck = '';
                   2371:                     }
                   2372:                 }
1.591     raeburn  2373:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2374:                     $intarg = $in{'curr_autharg'};
                   2375:                 }
                   2376:             } else {
                   2377:                 $result = &mt('Currently internally authenticated.');
                   2378:                 return $result;
1.165     raeburn  2379:             }
                   2380:         }
1.586     raeburn  2381:     } else {
                   2382:         if ($authnum == 1) {
1.784     bisitz   2383:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2384:         }
                   2385:     }
                   2386:     if (!$can_assign{'int'}) {
                   2387:         return;
1.587     raeburn  2388:     } elsif ($authtype eq '') {
1.591     raeburn  2389:         if (defined($in{'mode'})) {
1.587     raeburn  2390:             if ($in{'mode'} eq 'modifycourse') {
                   2391:                 if ($authnum == 1) {
1.784     bisitz   2392:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2393:                 }
                   2394:             }
                   2395:         }
1.165     raeburn  2396:     }
1.586     raeburn  2397:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2398:     if ($authtype eq '') {
                   2399:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2400:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2401:     }
1.605     bisitz   2402:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2403:                $intarg.'" onchange="'.$jscall.'" />';
                   2404:     $result = &mt
1.144     matthew  2405:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2406:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2407:     $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  2408:     return $result;
                   2409: }
                   2410: 
                   2411: sub authform_local{  
                   2412:     my %in = (
                   2413:               formname => 'document.cu',
                   2414:               kerb_def_dom => 'MSU.EDU',
                   2415:               @_,
                   2416:               );
1.586     raeburn  2417:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2418:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2419:     if (defined($in{'curr_authtype'})) {
                   2420:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2421:             if ($can_assign{'loc'}) {
1.772     bisitz   2422:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2423:                 if (defined($in{'mode'})) {
                   2424:                     if ($in{'mode'} eq 'modifyuser') {
                   2425:                         $loccheck = '';
                   2426:                     }
                   2427:                 }
1.591     raeburn  2428:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2429:                     $locarg = $in{'curr_autharg'};
                   2430:                 }
                   2431:             } else {
                   2432:                 $result = &mt('Currently using local (institutional) authentication.');
                   2433:                 return $result;
1.165     raeburn  2434:             }
                   2435:         }
1.586     raeburn  2436:     } else {
                   2437:         if ($authnum == 1) {
1.784     bisitz   2438:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2439:         }
                   2440:     }
                   2441:     if (!$can_assign{'loc'}) {
                   2442:         return;
1.587     raeburn  2443:     } elsif ($authtype eq '') {
1.591     raeburn  2444:         if (defined($in{'mode'})) {
1.587     raeburn  2445:             if ($in{'mode'} eq 'modifycourse') {
                   2446:                 if ($authnum == 1) {
1.784     bisitz   2447:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2448:                 }
                   2449:             }
                   2450:         }
1.165     raeburn  2451:     }
1.586     raeburn  2452:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2453:     if ($authtype eq '') {
                   2454:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2455:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2456:                     $jscall.'" />';
                   2457:     }
                   2458:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2459:                $locarg.'" onchange="'.$jscall.'" />';
                   2460:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2461:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2462:     return $result;
                   2463: }
                   2464: 
                   2465: sub authform_filesystem{  
                   2466:     my %in = (
                   2467:               formname => 'document.cu',
                   2468:               kerb_def_dom => 'MSU.EDU',
                   2469:               @_,
                   2470:               );
1.586     raeburn  2471:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2472:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2473:     if (defined($in{'curr_authtype'})) {
                   2474:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2475:             if ($can_assign{'fsys'}) {
1.772     bisitz   2476:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2477:                 if (defined($in{'mode'})) {
                   2478:                     if ($in{'mode'} eq 'modifyuser') {
                   2479:                         $fsyscheck = '';
                   2480:                     }
                   2481:                 }
1.586     raeburn  2482:             } else {
                   2483:                 $result = &mt('Currently Filesystem Authenticated.');
                   2484:                 return $result;
                   2485:             }           
                   2486:         }
                   2487:     } else {
                   2488:         if ($authnum == 1) {
1.784     bisitz   2489:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2490:         }
                   2491:     }
                   2492:     if (!$can_assign{'fsys'}) {
                   2493:         return;
1.587     raeburn  2494:     } elsif ($authtype eq '') {
1.591     raeburn  2495:         if (defined($in{'mode'})) {
1.587     raeburn  2496:             if ($in{'mode'} eq 'modifycourse') {
                   2497:                 if ($authnum == 1) {
1.784     bisitz   2498:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2499:                 }
                   2500:             }
                   2501:         }
1.586     raeburn  2502:     }
                   2503:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2504:     if ($authtype eq '') {
                   2505:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2506:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2507:                     $jscall.'" />';
                   2508:     }
                   2509:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2510:                ' onchange="'.$jscall.'" />';
                   2511:     $result = &mt
1.144     matthew  2512:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2513:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2514:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2515:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2516:                   'onchange="'.$jscall.'" />');
1.32      matthew  2517:     return $result;
                   2518: }
                   2519: 
1.586     raeburn  2520: sub get_assignable_auth {
                   2521:     my ($dom) = @_;
                   2522:     if ($dom eq '') {
                   2523:         $dom = $env{'request.role.domain'};
                   2524:     }
                   2525:     my %can_assign = (
                   2526:                           krb4 => 1,
                   2527:                           krb5 => 1,
                   2528:                           int  => 1,
                   2529:                           loc  => 1,
                   2530:                      );
                   2531:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2532:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2533:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2534:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2535:             my $context;
                   2536:             if ($env{'request.role'} =~ /^au/) {
                   2537:                 $context = 'author';
                   2538:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2539:                 $context = 'domain';
                   2540:             } elsif ($env{'request.course.id'}) {
                   2541:                 $context = 'course';
                   2542:             }
                   2543:             if ($context) {
                   2544:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2545:                    %can_assign = %{$authhash->{$context}}; 
                   2546:                 }
                   2547:             }
                   2548:         }
                   2549:     }
                   2550:     my $authnum = 0;
                   2551:     foreach my $key (keys(%can_assign)) {
                   2552:         if ($can_assign{$key}) {
                   2553:             $authnum ++;
                   2554:         }
                   2555:     }
                   2556:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2557:         $authnum --;
                   2558:     }
                   2559:     return ($authnum,%can_assign);
                   2560: }
                   2561: 
1.80      albertel 2562: ###############################################################
                   2563: ##    Get Kerberos Defaults for Domain                 ##
                   2564: ###############################################################
                   2565: ##
                   2566: ## Returns default kerberos version and an associated argument
                   2567: ## as listed in file domain.tab. If not listed, provides
                   2568: ## appropriate default domain and kerberos version.
                   2569: ##
                   2570: #-------------------------------------------
                   2571: 
                   2572: =pod
                   2573: 
1.648     raeburn  2574: =item * &get_kerberos_defaults()
1.80      albertel 2575: 
                   2576: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2577: version and domain. If not found, it defaults to version 4 and the 
                   2578: domain of the server.
1.80      albertel 2579: 
1.648     raeburn  2580: =over 4
                   2581: 
1.80      albertel 2582: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2583: 
1.648     raeburn  2584: =back
                   2585: 
                   2586: =back
                   2587: 
1.80      albertel 2588: =cut
                   2589: 
                   2590: #-------------------------------------------
                   2591: sub get_kerberos_defaults {
                   2592:     my $domain=shift;
1.641     raeburn  2593:     my ($krbdef,$krbdefdom);
                   2594:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2595:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2596:         $krbdef = $domdefaults{'auth_def'};
                   2597:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2598:     } else {
1.80      albertel 2599:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2600:         my $krbdefdom=$1;
                   2601:         $krbdefdom=~tr/a-z/A-Z/;
                   2602:         $krbdef = "krb4";
                   2603:     }
                   2604:     return ($krbdef,$krbdefdom);
                   2605: }
1.112     bowersj2 2606: 
1.32      matthew  2607: 
1.46      matthew  2608: ###############################################################
                   2609: ##                Thesaurus Functions                        ##
                   2610: ###############################################################
1.20      www      2611: 
1.46      matthew  2612: =pod
1.20      www      2613: 
1.112     bowersj2 2614: =head1 Thesaurus Functions
                   2615: 
                   2616: =over 4
                   2617: 
1.648     raeburn  2618: =item * &initialize_keywords()
1.46      matthew  2619: 
                   2620: Initializes the package variable %Keywords if it is empty.  Uses the
                   2621: package variable $thesaurus_db_file.
                   2622: 
                   2623: =cut
                   2624: 
                   2625: ###################################################
                   2626: 
                   2627: sub initialize_keywords {
                   2628:     return 1 if (scalar keys(%Keywords));
                   2629:     # If we are here, %Keywords is empty, so fill it up
                   2630:     #   Make sure the file we need exists...
                   2631:     if (! -e $thesaurus_db_file) {
                   2632:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2633:                                  " failed because it does not exist");
                   2634:         return 0;
                   2635:     }
                   2636:     #   Set up the hash as a database
                   2637:     my %thesaurus_db;
                   2638:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2639:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2640:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2641:                                  $thesaurus_db_file);
                   2642:         return 0;
                   2643:     } 
                   2644:     #  Get the average number of appearances of a word.
                   2645:     my $avecount = $thesaurus_db{'average.count'};
                   2646:     #  Put keywords (those that appear > average) into %Keywords
                   2647:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2648:         my ($count,undef) = split /:/,$data;
                   2649:         $Keywords{$word}++ if ($count > $avecount);
                   2650:     }
                   2651:     untie %thesaurus_db;
                   2652:     # Remove special values from %Keywords.
1.356     albertel 2653:     foreach my $value ('total.count','average.count') {
                   2654:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2655:   }
1.46      matthew  2656:     return 1;
                   2657: }
                   2658: 
                   2659: ###################################################
                   2660: 
                   2661: =pod
                   2662: 
1.648     raeburn  2663: =item * &keyword($word)
1.46      matthew  2664: 
                   2665: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2666: than the average number of times in the thesaurus database.  Calls 
                   2667: &initialize_keywords
                   2668: 
                   2669: =cut
                   2670: 
                   2671: ###################################################
1.20      www      2672: 
                   2673: sub keyword {
1.46      matthew  2674:     return if (!&initialize_keywords());
                   2675:     my $word=lc(shift());
                   2676:     $word=~s/\W//g;
                   2677:     return exists($Keywords{$word});
1.20      www      2678: }
1.46      matthew  2679: 
                   2680: ###############################################################
                   2681: 
                   2682: =pod 
1.20      www      2683: 
1.648     raeburn  2684: =item * &get_related_words()
1.46      matthew  2685: 
1.160     matthew  2686: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2687: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2688: will be returned.  The order of the words returned is determined by the
                   2689: database which holds them.
                   2690: 
                   2691: Uses global $thesaurus_db_file.
                   2692: 
                   2693: =cut
                   2694: 
                   2695: ###############################################################
                   2696: sub get_related_words {
                   2697:     my $keyword = shift;
                   2698:     my %thesaurus_db;
                   2699:     if (! -e $thesaurus_db_file) {
                   2700:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2701:                                  "failed because the file does not exist");
                   2702:         return ();
                   2703:     }
                   2704:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2705:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2706:         return ();
                   2707:     } 
                   2708:     my @Words=();
1.429     www      2709:     my $count=0;
1.46      matthew  2710:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2711: 	# The first element is the number of times
                   2712: 	# the word appears.  We do not need it now.
1.429     www      2713: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2714: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2715: 	my $threshold=$mostfrequentcount/10;
                   2716:         foreach my $possibleword (@RelatedWords) {
                   2717:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2718:             if ($wordcount>$threshold) {
                   2719: 		push(@Words,$word);
                   2720:                 $count++;
                   2721:                 if ($count>10) { last; }
                   2722: 	    }
1.20      www      2723:         }
                   2724:     }
1.46      matthew  2725:     untie %thesaurus_db;
                   2726:     return @Words;
1.14      harris41 2727: }
1.46      matthew  2728: 
1.112     bowersj2 2729: =pod
                   2730: 
                   2731: =back
                   2732: 
                   2733: =cut
1.61      www      2734: 
                   2735: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2736: =pod
                   2737: 
1.112     bowersj2 2738: =head1 User Name Functions
                   2739: 
                   2740: =over 4
                   2741: 
1.648     raeburn  2742: =item * &plainname($uname,$udom,$first)
1.81      albertel 2743: 
1.112     bowersj2 2744: Takes a users logon name and returns it as a string in
1.226     albertel 2745: "first middle last generation" form 
                   2746: if $first is set to 'lastname' then it returns it as
                   2747: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2748: 
                   2749: =cut
1.61      www      2750: 
1.295     www      2751: 
1.81      albertel 2752: ###############################################################
1.61      www      2753: sub plainname {
1.226     albertel 2754:     my ($uname,$udom,$first)=@_;
1.537     albertel 2755:     return if (!defined($uname) || !defined($udom));
1.295     www      2756:     my %names=&getnames($uname,$udom);
1.226     albertel 2757:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2758: 					  $names{'middlename'},
                   2759: 					  $names{'lastname'},
                   2760: 					  $names{'generation'},$first);
                   2761:     $name=~s/^\s+//;
1.62      www      2762:     $name=~s/\s+$//;
                   2763:     $name=~s/\s+/ /g;
1.353     albertel 2764:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2765:     return $name;
1.61      www      2766: }
1.66      www      2767: 
                   2768: # -------------------------------------------------------------------- Nickname
1.81      albertel 2769: =pod
                   2770: 
1.648     raeburn  2771: =item * &nickname($uname,$udom)
1.81      albertel 2772: 
                   2773: Gets a users name and returns it as a string as
                   2774: 
                   2775: "&quot;nickname&quot;"
1.66      www      2776: 
1.81      albertel 2777: if the user has a nickname or
                   2778: 
                   2779: "first middle last generation"
                   2780: 
                   2781: if the user does not
                   2782: 
                   2783: =cut
1.66      www      2784: 
                   2785: sub nickname {
                   2786:     my ($uname,$udom)=@_;
1.537     albertel 2787:     return if (!defined($uname) || !defined($udom));
1.295     www      2788:     my %names=&getnames($uname,$udom);
1.68      albertel 2789:     my $name=$names{'nickname'};
1.66      www      2790:     if ($name) {
                   2791:        $name='&quot;'.$name.'&quot;'; 
                   2792:     } else {
                   2793:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2794: 	     $names{'lastname'}.' '.$names{'generation'};
                   2795:        $name=~s/\s+$//;
                   2796:        $name=~s/\s+/ /g;
                   2797:     }
                   2798:     return $name;
                   2799: }
                   2800: 
1.295     www      2801: sub getnames {
                   2802:     my ($uname,$udom)=@_;
1.537     albertel 2803:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2804:     if ($udom eq 'public' && $uname eq 'public') {
                   2805: 	return ('lastname' => &mt('Public'));
                   2806:     }
1.295     www      2807:     my $id=$uname.':'.$udom;
                   2808:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2809:     if ($cached) {
                   2810: 	return %{$names};
                   2811:     } else {
                   2812: 	my %loadnames=&Apache::lonnet::get('environment',
                   2813:                     ['firstname','middlename','lastname','generation','nickname'],
                   2814: 					 $udom,$uname);
                   2815: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2816: 	return %loadnames;
                   2817:     }
                   2818: }
1.61      www      2819: 
1.542     raeburn  2820: # -------------------------------------------------------------------- getemails
1.648     raeburn  2821: 
1.542     raeburn  2822: =pod
                   2823: 
1.648     raeburn  2824: =item * &getemails($uname,$udom)
1.542     raeburn  2825: 
                   2826: Gets a user's email information and returns it as a hash with keys:
                   2827: notification, critnotification, permanentemail
                   2828: 
                   2829: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2830: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2831:  
1.648     raeburn  2832: 
1.542     raeburn  2833: =cut
                   2834: 
1.648     raeburn  2835: 
1.466     albertel 2836: sub getemails {
                   2837:     my ($uname,$udom)=@_;
                   2838:     if ($udom eq 'public' && $uname eq 'public') {
                   2839: 	return;
                   2840:     }
1.467     www      2841:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2842:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2843:     my $id=$uname.':'.$udom;
                   2844:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2845:     if ($cached) {
                   2846: 	return %{$names};
                   2847:     } else {
                   2848: 	my %loadnames=&Apache::lonnet::get('environment',
                   2849:                     			   ['notification','critnotification',
                   2850: 					    'permanentemail'],
                   2851: 					   $udom,$uname);
                   2852: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2853: 	return %loadnames;
                   2854:     }
                   2855: }
                   2856: 
1.551     albertel 2857: sub flush_email_cache {
                   2858:     my ($uname,$udom)=@_;
                   2859:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2860:     if (!$uname) { $uname=$env{'user.name'};   }
                   2861:     return if ($udom eq 'public' && $uname eq 'public');
                   2862:     my $id=$uname.':'.$udom;
                   2863:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2864: }
                   2865: 
1.728     raeburn  2866: # -------------------------------------------------------------------- getlangs
                   2867: 
                   2868: =pod
                   2869: 
                   2870: =item * &getlangs($uname,$udom)
                   2871: 
                   2872: Gets a user's language preference and returns it as a hash with key:
                   2873: language.
                   2874: 
                   2875: =cut
                   2876: 
                   2877: 
                   2878: sub getlangs {
                   2879:     my ($uname,$udom) = @_;
                   2880:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2881:     if (!$uname) { $uname=$env{'user.name'};   }
                   2882:     my $id=$uname.':'.$udom;
                   2883:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2884:     if ($cached) {
                   2885:         return %{$langs};
                   2886:     } else {
                   2887:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2888:                                            $udom,$uname);
                   2889:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2890:         return %loadlangs;
                   2891:     }
                   2892: }
                   2893: 
                   2894: sub flush_langs_cache {
                   2895:     my ($uname,$udom)=@_;
                   2896:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2897:     if (!$uname) { $uname=$env{'user.name'};   }
                   2898:     return if ($udom eq 'public' && $uname eq 'public');
                   2899:     my $id=$uname.':'.$udom;
                   2900:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2901: }
                   2902: 
1.61      www      2903: # ------------------------------------------------------------------ Screenname
1.81      albertel 2904: 
                   2905: =pod
                   2906: 
1.648     raeburn  2907: =item * &screenname($uname,$udom)
1.81      albertel 2908: 
                   2909: Gets a users screenname and returns it as a string
                   2910: 
                   2911: =cut
1.61      www      2912: 
                   2913: sub screenname {
                   2914:     my ($uname,$udom)=@_;
1.258     albertel 2915:     if ($uname eq $env{'user.name'} &&
                   2916: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2917:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2918:     return $names{'screenname'};
1.62      www      2919: }
                   2920: 
1.212     albertel 2921: 
1.802     bisitz   2922: # ------------------------------------------------------------- Confirm Wrapper
                   2923: =pod
                   2924: 
                   2925: =item confirmwrapper
                   2926: 
                   2927: Wrap messages about completion of operation in box
                   2928: 
                   2929: =cut
                   2930: 
                   2931: sub confirmwrapper {
                   2932:     my ($message)=@_;
                   2933:     if ($message) {
                   2934:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2935:                .$message."\n"
                   2936:                .'</div>'."\n";
                   2937:     } else {
                   2938:         return $message;
                   2939:     }
                   2940: }
                   2941: 
1.62      www      2942: # ------------------------------------------------------------- Message Wrapper
                   2943: 
                   2944: sub messagewrapper {
1.369     www      2945:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2946:     return 
1.441     albertel 2947:         '<a href="/adm/email?compose=individual&amp;'.
                   2948:         'recname='.$username.'&amp;recdom='.$domain.
                   2949: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2950:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2951: }
1.802     bisitz   2952: 
1.74      www      2953: # --------------------------------------------------------------- Notes Wrapper
                   2954: 
                   2955: sub noteswrapper {
                   2956:     my ($link,$un,$do)=@_;
                   2957:     return 
1.896     amueller 2958: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      2959: }
1.802     bisitz   2960: 
1.62      www      2961: # ------------------------------------------------------------- Aboutme Wrapper
                   2962: 
                   2963: sub aboutmewrapper {
1.166     www      2964:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2965:     if (!defined($username)  && !defined($domain)) {
                   2966:         return;
                   2967:     }
1.892     amueller 2968:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  2969: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2970: }
                   2971: 
                   2972: # ------------------------------------------------------------ Syllabus Wrapper
                   2973: 
                   2974: sub syllabuswrapper {
1.707     bisitz   2975:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2976:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2977: }
1.14      harris41 2978: 
1.802     bisitz   2979: # -----------------------------------------------------------------------------
                   2980: 
1.208     matthew  2981: sub track_student_link {
1.887     raeburn  2982:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 2983:     my $link ="/adm/trackstudent?";
1.208     matthew  2984:     my $title = 'View recent activity';
                   2985:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2986:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2987:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2988:         $title .= ' of this student';
1.268     albertel 2989:     } 
1.208     matthew  2990:     if (defined($target) && $target !~ /^\s*$/) {
                   2991:         $target = qq{target="$target"};
                   2992:     } else {
                   2993:         $target = '';
                   2994:     }
1.268     albertel 2995:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  2996:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 2997:     $title = &mt($title);
                   2998:     $linktext = &mt($linktext);
1.448     albertel 2999:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3000: 	&help_open_topic('View_recent_activity');
1.208     matthew  3001: }
                   3002: 
1.781     raeburn  3003: sub slot_reservations_link {
                   3004:     my ($linktext,$sname,$sdom,$target) = @_;
                   3005:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3006:     my $title = 'View slot reservation history';
                   3007:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3008:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3009:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3010:         $title .= ' of this student';
                   3011:     }
                   3012:     if (defined($target) && $target !~ /^\s*$/) {
                   3013:         $target = qq{target="$target"};
                   3014:     } else {
                   3015:         $target = '';
                   3016:     }
                   3017:     $title = &mt($title);
                   3018:     $linktext = &mt($linktext);
                   3019:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3020: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3021: 
                   3022: }
                   3023: 
1.508     www      3024: # ===================================================== Display a student photo
                   3025: 
                   3026: 
1.509     albertel 3027: sub student_image_tag {
1.508     www      3028:     my ($domain,$user)=@_;
                   3029:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3030:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3031: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3032:     } else {
                   3033: 	return '';
                   3034:     }
                   3035: }
                   3036: 
1.112     bowersj2 3037: =pod
                   3038: 
                   3039: =back
                   3040: 
                   3041: =head1 Access .tab File Data
                   3042: 
                   3043: =over 4
                   3044: 
1.648     raeburn  3045: =item * &languageids() 
1.112     bowersj2 3046: 
                   3047: returns list of all language ids
                   3048: 
                   3049: =cut
                   3050: 
1.14      harris41 3051: sub languageids {
1.16      harris41 3052:     return sort(keys(%language));
1.14      harris41 3053: }
                   3054: 
1.112     bowersj2 3055: =pod
                   3056: 
1.648     raeburn  3057: =item * &languagedescription() 
1.112     bowersj2 3058: 
                   3059: returns description of a specified language id
                   3060: 
                   3061: =cut
                   3062: 
1.14      harris41 3063: sub languagedescription {
1.125     www      3064:     my $code=shift;
                   3065:     return  ($supported_language{$code}?'* ':'').
                   3066:             $language{$code}.
1.126     www      3067: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3068: }
                   3069: 
                   3070: sub plainlanguagedescription {
                   3071:     my $code=shift;
                   3072:     return $language{$code};
                   3073: }
                   3074: 
                   3075: sub supportedlanguagecode {
                   3076:     my $code=shift;
                   3077:     return $supported_language{$code};
1.97      www      3078: }
                   3079: 
1.112     bowersj2 3080: =pod
                   3081: 
1.648     raeburn  3082: =item * &copyrightids() 
1.112     bowersj2 3083: 
                   3084: returns list of all copyrights
                   3085: 
                   3086: =cut
                   3087: 
                   3088: sub copyrightids {
                   3089:     return sort(keys(%cprtag));
                   3090: }
                   3091: 
                   3092: =pod
                   3093: 
1.648     raeburn  3094: =item * &copyrightdescription() 
1.112     bowersj2 3095: 
                   3096: returns description of a specified copyright id
                   3097: 
                   3098: =cut
                   3099: 
                   3100: sub copyrightdescription {
1.166     www      3101:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3102: }
1.197     matthew  3103: 
                   3104: =pod
                   3105: 
1.648     raeburn  3106: =item * &source_copyrightids() 
1.192     taceyjo1 3107: 
                   3108: returns list of all source copyrights
                   3109: 
                   3110: =cut
                   3111: 
                   3112: sub source_copyrightids {
                   3113:     return sort(keys(%scprtag));
                   3114: }
                   3115: 
                   3116: =pod
                   3117: 
1.648     raeburn  3118: =item * &source_copyrightdescription() 
1.192     taceyjo1 3119: 
                   3120: returns description of a specified source copyright id
                   3121: 
                   3122: =cut
                   3123: 
                   3124: sub source_copyrightdescription {
                   3125:     return &mt($scprtag{shift(@_)});
                   3126: }
1.112     bowersj2 3127: 
                   3128: =pod
                   3129: 
1.648     raeburn  3130: =item * &filecategories() 
1.112     bowersj2 3131: 
                   3132: returns list of all file categories
                   3133: 
                   3134: =cut
                   3135: 
                   3136: sub filecategories {
                   3137:     return sort(keys(%category_extensions));
                   3138: }
                   3139: 
                   3140: =pod
                   3141: 
1.648     raeburn  3142: =item * &filecategorytypes() 
1.112     bowersj2 3143: 
                   3144: returns list of file types belonging to a given file
                   3145: category
                   3146: 
                   3147: =cut
                   3148: 
                   3149: sub filecategorytypes {
1.356     albertel 3150:     my ($cat) = @_;
                   3151:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3152: }
                   3153: 
                   3154: =pod
                   3155: 
1.648     raeburn  3156: =item * &fileembstyle() 
1.112     bowersj2 3157: 
                   3158: returns embedding style for a specified file type
                   3159: 
                   3160: =cut
                   3161: 
                   3162: sub fileembstyle {
                   3163:     return $fe{lc(shift(@_))};
1.169     www      3164: }
                   3165: 
1.351     www      3166: sub filemimetype {
                   3167:     return $fm{lc(shift(@_))};
                   3168: }
                   3169: 
1.169     www      3170: 
                   3171: sub filecategoryselect {
                   3172:     my ($name,$value)=@_;
1.189     matthew  3173:     return &select_form($value,$name,
1.169     www      3174: 			'' => &mt('Any category'),
                   3175: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3176: }
                   3177: 
                   3178: =pod
                   3179: 
1.648     raeburn  3180: =item * &filedescription() 
1.112     bowersj2 3181: 
                   3182: returns description for a specified file type
                   3183: 
                   3184: =cut
                   3185: 
                   3186: sub filedescription {
1.188     matthew  3187:     my $file_description = $fd{lc(shift())};
                   3188:     $file_description =~ s:([\[\]]):~$1:g;
                   3189:     return &mt($file_description);
1.112     bowersj2 3190: }
                   3191: 
                   3192: =pod
                   3193: 
1.648     raeburn  3194: =item * &filedescriptionex() 
1.112     bowersj2 3195: 
                   3196: returns description for a specified file type with
                   3197: extra formatting
                   3198: 
                   3199: =cut
                   3200: 
                   3201: sub filedescriptionex {
                   3202:     my $ex=shift;
1.188     matthew  3203:     my $file_description = $fd{lc($ex)};
                   3204:     $file_description =~ s:([\[\]]):~$1:g;
                   3205:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3206: }
                   3207: 
                   3208: # End of .tab access
                   3209: =pod
                   3210: 
                   3211: =back
                   3212: 
                   3213: =cut
                   3214: 
                   3215: # ------------------------------------------------------------------ File Types
                   3216: sub fileextensions {
                   3217:     return sort(keys(%fe));
                   3218: }
                   3219: 
1.97      www      3220: # ----------------------------------------------------------- Display Languages
                   3221: # returns a hash with all desired display languages
                   3222: #
                   3223: 
                   3224: sub display_languages {
                   3225:     my %languages=();
1.695     raeburn  3226:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3227: 	$languages{$lang}=1;
1.97      www      3228:     }
                   3229:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3230:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3231: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3232: 	    $languages{$lang}=1;
1.97      www      3233:         }
                   3234:     }
                   3235:     return %languages;
1.14      harris41 3236: }
                   3237: 
1.582     albertel 3238: sub languages {
                   3239:     my ($possible_langs) = @_;
1.695     raeburn  3240:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3241:     if (!ref($possible_langs)) {
                   3242: 	if( wantarray ) {
                   3243: 	    return @preferred_langs;
                   3244: 	} else {
                   3245: 	    return $preferred_langs[0];
                   3246: 	}
                   3247:     }
                   3248:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3249:     my @preferred_possibilities;
                   3250:     foreach my $preferred_lang (@preferred_langs) {
                   3251: 	if (exists($possibilities{$preferred_lang})) {
                   3252: 	    push(@preferred_possibilities, $preferred_lang);
                   3253: 	}
                   3254:     }
                   3255:     if( wantarray ) {
                   3256: 	return @preferred_possibilities;
                   3257:     }
                   3258:     return $preferred_possibilities[0];
                   3259: }
                   3260: 
1.742     raeburn  3261: sub user_lang {
                   3262:     my ($touname,$toudom,$fromcid) = @_;
                   3263:     my @userlangs;
                   3264:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3265:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3266:                     $env{'course.'.$fromcid.'.languages'}));
                   3267:     } else {
                   3268:         my %langhash = &getlangs($touname,$toudom);
                   3269:         if ($langhash{'languages'} ne '') {
                   3270:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3271:         } else {
                   3272:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3273:             if ($domdefs{'lang_def'} ne '') {
                   3274:                 @userlangs = ($domdefs{'lang_def'});
                   3275:             }
                   3276:         }
                   3277:     }
                   3278:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3279:     my $user_lh = Apache::localize->get_handle(@languages);
                   3280:     return $user_lh;
                   3281: }
                   3282: 
                   3283: 
1.112     bowersj2 3284: ###############################################################
                   3285: ##               Student Answer Attempts                     ##
                   3286: ###############################################################
                   3287: 
                   3288: =pod
                   3289: 
                   3290: =head1 Alternate Problem Views
                   3291: 
                   3292: =over 4
                   3293: 
1.648     raeburn  3294: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3295:     $getattempt, $regexp, $gradesub)
                   3296: 
                   3297: Return string with previous attempt on problem. Arguments:
                   3298: 
                   3299: =over 4
                   3300: 
                   3301: =item * $symb: Problem, including path
                   3302: 
                   3303: =item * $username: username of the desired student
                   3304: 
                   3305: =item * $domain: domain of the desired student
1.14      harris41 3306: 
1.112     bowersj2 3307: =item * $course: Course ID
1.14      harris41 3308: 
1.112     bowersj2 3309: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3310:     something
1.14      harris41 3311: 
1.112     bowersj2 3312: =item * $regexp: if string matches this regexp, the string will be
                   3313:     sent to $gradesub
1.14      harris41 3314: 
1.112     bowersj2 3315: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3316: 
1.112     bowersj2 3317: =back
1.14      harris41 3318: 
1.112     bowersj2 3319: The output string is a table containing all desired attempts, if any.
1.16      harris41 3320: 
1.112     bowersj2 3321: =cut
1.1       albertel 3322: 
                   3323: sub get_previous_attempt {
1.43      ng       3324:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3325:   my $prevattempts='';
1.43      ng       3326:   no strict 'refs';
1.1       albertel 3327:   if ($symb) {
1.3       albertel 3328:     my (%returnhash)=
                   3329:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3330:     if ($returnhash{'version'}) {
                   3331:       my %lasthash=();
                   3332:       my $version;
                   3333:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3334:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3335: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3336:         }
1.1       albertel 3337:       }
1.596     albertel 3338:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3339:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3340:       foreach my $key (sort(keys(%lasthash))) {
                   3341: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3342: 	if ($#parts > 0) {
1.31      albertel 3343: 	  my $data=$parts[-1];
                   3344: 	  pop(@parts);
1.596     albertel 3345: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3346: 	} else {
1.41      ng       3347: 	  if ($#parts == 0) {
                   3348: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3349: 	  } else {
                   3350: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3351: 	  }
1.31      albertel 3352: 	}
1.16      harris41 3353:       }
1.596     albertel 3354:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3355:       if ($getattempt eq '') {
                   3356: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3357: 	  $prevattempts.=&start_data_table_row().
                   3358: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3359: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3360: 		my $value = &format_previous_attempt_value($key,
                   3361: 							   $returnhash{$version.':'.$key});
                   3362: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3363: 	    }
1.596     albertel 3364: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3365: 	 }
1.1       albertel 3366:       }
1.596     albertel 3367:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3368:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3369: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3370: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3371: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3372:       }
1.596     albertel 3373:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3374:     } else {
1.596     albertel 3375:       $prevattempts=
                   3376: 	  &start_data_table().&start_data_table_row().
                   3377: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3378: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3379:     }
                   3380:   } else {
1.596     albertel 3381:     $prevattempts=
                   3382: 	  &start_data_table().&start_data_table_row().
                   3383: 	  '<td>'.&mt('No data.').'</td>'.
                   3384: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3385:   }
1.10      albertel 3386: }
                   3387: 
1.581     albertel 3388: sub format_previous_attempt_value {
                   3389:     my ($key,$value) = @_;
                   3390:     if ($key =~ /timestamp/) {
                   3391: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3392:     } elsif (ref($value) eq 'ARRAY') {
                   3393: 	$value = '('.join(', ', @{ $value }).')';
                   3394:     } else {
                   3395: 	$value = &unescape($value);
                   3396:     }
                   3397:     return $value;
                   3398: }
                   3399: 
                   3400: 
1.107     albertel 3401: sub relative_to_absolute {
                   3402:     my ($url,$output)=@_;
                   3403:     my $parser=HTML::TokeParser->new(\$output);
                   3404:     my $token;
                   3405:     my $thisdir=$url;
                   3406:     my @rlinks=();
                   3407:     while ($token=$parser->get_token) {
                   3408: 	if ($token->[0] eq 'S') {
                   3409: 	    if ($token->[1] eq 'a') {
                   3410: 		if ($token->[2]->{'href'}) {
                   3411: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3412: 		}
                   3413: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3414: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3415: 	    } elsif ($token->[1] eq 'base') {
                   3416: 		$thisdir=$token->[2]->{'href'};
                   3417: 	    }
                   3418: 	}
                   3419:     }
                   3420:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3421:     foreach my $link (@rlinks) {
1.726     raeburn  3422: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3423: 		($link=~/^\//) ||
                   3424: 		($link=~/^javascript:/i) ||
                   3425: 		($link=~/^mailto:/i) ||
                   3426: 		($link=~/^\#/)) {
                   3427: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3428: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3429: 	}
                   3430:     }
                   3431: # -------------------------------------------------- Deal with Applet codebases
                   3432:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3433:     return $output;
                   3434: }
                   3435: 
1.112     bowersj2 3436: =pod
                   3437: 
1.648     raeburn  3438: =item * &get_student_view()
1.112     bowersj2 3439: 
                   3440: show a snapshot of what student was looking at
                   3441: 
                   3442: =cut
                   3443: 
1.10      albertel 3444: sub get_student_view {
1.186     albertel 3445:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3446:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3447:   my (%form);
1.10      albertel 3448:   my @elements=('symb','courseid','domain','username');
                   3449:   foreach my $element (@elements) {
1.186     albertel 3450:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3451:   }
1.186     albertel 3452:   if (defined($moreenv)) {
                   3453:       %form=(%form,%{$moreenv});
                   3454:   }
1.236     albertel 3455:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3456:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3457:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3458:   $userview=~s/\<body[^\>]*\>//gi;
                   3459:   $userview=~s/\<\/body\>//gi;
                   3460:   $userview=~s/\<html\>//gi;
                   3461:   $userview=~s/\<\/html\>//gi;
                   3462:   $userview=~s/\<head\>//gi;
                   3463:   $userview=~s/\<\/head\>//gi;
                   3464:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3465:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3466:   if (wantarray) {
                   3467:      return ($userview,$response);
                   3468:   } else {
                   3469:      return $userview;
                   3470:   }
                   3471: }
                   3472: 
                   3473: sub get_student_view_with_retries {
                   3474:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3475: 
                   3476:     my $ok = 0;                 # True if we got a good response.
                   3477:     my $content;
                   3478:     my $response;
                   3479: 
                   3480:     # Try to get the student_view done. within the retries count:
                   3481:     
                   3482:     do {
                   3483:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3484:          $ok      = $response->is_success;
                   3485:          if (!$ok) {
                   3486:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3487:          }
                   3488:          $retries--;
                   3489:     } while (!$ok && ($retries > 0));
                   3490:     
                   3491:     if (!$ok) {
                   3492:        $content = '';          # On error return an empty content.
                   3493:     }
1.651     www      3494:     if (wantarray) {
                   3495:        return ($content, $response);
                   3496:     } else {
                   3497:        return $content;
                   3498:     }
1.11      albertel 3499: }
                   3500: 
1.112     bowersj2 3501: =pod
                   3502: 
1.648     raeburn  3503: =item * &get_student_answers() 
1.112     bowersj2 3504: 
                   3505: show a snapshot of how student was answering problem
                   3506: 
                   3507: =cut
                   3508: 
1.11      albertel 3509: sub get_student_answers {
1.100     sakharuk 3510:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3511:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3512:   my (%moreenv);
1.11      albertel 3513:   my @elements=('symb','courseid','domain','username');
                   3514:   foreach my $element (@elements) {
1.186     albertel 3515:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3516:   }
1.186     albertel 3517:   $moreenv{'grade_target'}='answer';
                   3518:   %moreenv=(%form,%moreenv);
1.497     raeburn  3519:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3520:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3521:   return $userview;
1.1       albertel 3522: }
1.116     albertel 3523: 
                   3524: =pod
                   3525: 
                   3526: =item * &submlink()
                   3527: 
1.242     albertel 3528: Inputs: $text $uname $udom $symb $target
1.116     albertel 3529: 
                   3530: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3531: 
                   3532: =cut
                   3533: 
                   3534: ###############################################
                   3535: sub submlink {
1.242     albertel 3536:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3537:     if (!($uname && $udom)) {
                   3538: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3539: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3540: 	if (!$symb) { $symb=$cursymb; }
                   3541:     }
1.254     matthew  3542:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3543:     $symb=&escape($symb);
1.242     albertel 3544:     if ($target) { $target="target=\"$target\""; }
                   3545:     return '<a href="/adm/grades?&command=submission&'.
                   3546: 	'symb='.$symb.'&student='.$uname.
                   3547: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3548: }
                   3549: ##############################################
                   3550: 
                   3551: =pod
                   3552: 
                   3553: =item * &pgrdlink()
                   3554: 
                   3555: Inputs: $text $uname $udom $symb $target
                   3556: 
                   3557: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3558: 
                   3559: =cut
                   3560: 
                   3561: ###############################################
                   3562: sub pgrdlink {
                   3563:     my $link=&submlink(@_);
                   3564:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3565:     return $link;
                   3566: }
                   3567: ##############################################
                   3568: 
                   3569: =pod
                   3570: 
                   3571: =item * &pprmlink()
                   3572: 
                   3573: Inputs: $text $uname $udom $symb $target
                   3574: 
                   3575: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3576: student and a specific resource
1.242     albertel 3577: 
                   3578: =cut
                   3579: 
                   3580: ###############################################
                   3581: sub pprmlink {
                   3582:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3583:     if (!($uname && $udom)) {
                   3584: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3585: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3586: 	if (!$symb) { $symb=$cursymb; }
                   3587:     }
1.254     matthew  3588:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3589:     $symb=&escape($symb);
1.242     albertel 3590:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3591:     return '<a href="/adm/parmset?command=set&amp;'.
                   3592: 	'symb='.$symb.'&amp;uname='.$uname.
                   3593: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3594: }
                   3595: ##############################################
1.37      matthew  3596: 
1.112     bowersj2 3597: =pod
                   3598: 
                   3599: =back
                   3600: 
                   3601: =cut
                   3602: 
1.37      matthew  3603: ###############################################
1.51      www      3604: 
                   3605: 
                   3606: sub timehash {
1.687     raeburn  3607:     my ($thistime) = @_;
                   3608:     my $timezone = &Apache::lonlocal::gettimezone();
                   3609:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3610:                      ->set_time_zone($timezone);
                   3611:     my $wday = $dt->day_of_week();
                   3612:     if ($wday == 7) { $wday = 0; }
                   3613:     return ( 'second' => $dt->second(),
                   3614:              'minute' => $dt->minute(),
                   3615:              'hour'   => $dt->hour(),
                   3616:              'day'     => $dt->day_of_month(),
                   3617:              'month'   => $dt->month(),
                   3618:              'year'    => $dt->year(),
                   3619:              'weekday' => $wday,
                   3620:              'dayyear' => $dt->day_of_year(),
                   3621:              'dlsav'   => $dt->is_dst() );
1.51      www      3622: }
                   3623: 
1.370     www      3624: sub utc_string {
                   3625:     my ($date)=@_;
1.371     www      3626:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3627: }
                   3628: 
1.51      www      3629: sub maketime {
                   3630:     my %th=@_;
1.687     raeburn  3631:     my ($epoch_time,$timezone,$dt);
                   3632:     $timezone = &Apache::lonlocal::gettimezone();
                   3633:     eval {
                   3634:         $dt = DateTime->new( year   => $th{'year'},
                   3635:                              month  => $th{'month'},
                   3636:                              day    => $th{'day'},
                   3637:                              hour   => $th{'hour'},
                   3638:                              minute => $th{'minute'},
                   3639:                              second => $th{'second'},
                   3640:                              time_zone => $timezone,
                   3641:                          );
                   3642:     };
                   3643:     if (!$@) {
                   3644:         $epoch_time = $dt->epoch;
                   3645:         if ($epoch_time) {
                   3646:             return $epoch_time;
                   3647:         }
                   3648:     }
1.51      www      3649:     return POSIX::mktime(
                   3650:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3651:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3652: }
                   3653: 
                   3654: #########################################
1.51      www      3655: 
                   3656: sub findallcourses {
1.482     raeburn  3657:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3658:     my %roles;
                   3659:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3660:     my %courses;
1.51      www      3661:     my $now=time;
1.482     raeburn  3662:     if (!defined($uname)) {
                   3663:         $uname = $env{'user.name'};
                   3664:     }
                   3665:     if (!defined($udom)) {
                   3666:         $udom = $env{'user.domain'};
                   3667:     }
                   3668:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3669:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3670:         if (!%roles) {
                   3671:             %roles = (
                   3672:                        cc => 1,
                   3673:                        in => 1,
                   3674:                        ep => 1,
                   3675:                        ta => 1,
                   3676:                        cr => 1,
                   3677:                        st => 1,
                   3678:              );
                   3679:         }
                   3680:         foreach my $entry (keys(%roleshash)) {
                   3681:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3682:             if ($trole =~ /^cr/) { 
                   3683:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3684:             } else {
                   3685:                 next if (!exists($roles{$trole}));
                   3686:             }
                   3687:             if ($tend) {
                   3688:                 next if ($tend < $now);
                   3689:             }
                   3690:             if ($tstart) {
                   3691:                 next if ($tstart > $now);
                   3692:             }
                   3693:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3694:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3695:             if ($secpart eq '') {
                   3696:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3697:                 $sec = 'none';
                   3698:                 $realsec = '';
                   3699:             } else {
                   3700:                 $cnum = $cnumpart;
                   3701:                 ($sec,$role) = split(/_/,$secpart);
                   3702:                 $realsec = $sec;
1.490     raeburn  3703:             }
1.482     raeburn  3704:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3705:         }
                   3706:     } else {
                   3707:         foreach my $key (keys(%env)) {
1.483     albertel 3708: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3709:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3710: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3711: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3712: 	        next if (%roles && !exists($roles{$role}));
                   3713: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3714:                 my $active=1;
                   3715:                 if ($starttime) {
                   3716: 		    if ($now<$starttime) { $active=0; }
                   3717:                 }
                   3718:                 if ($endtime) {
                   3719:                     if ($now>$endtime) { $active=0; }
                   3720:                 }
                   3721:                 if ($active) {
                   3722:                     if ($sec eq '') {
                   3723:                         $sec = 'none';
                   3724:                     }
                   3725:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3726:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3727:                 }
                   3728:             }
1.51      www      3729:         }
                   3730:     }
1.474     raeburn  3731:     return %courses;
1.51      www      3732: }
1.37      matthew  3733: 
1.54      www      3734: ###############################################
1.474     raeburn  3735: 
                   3736: sub blockcheck {
1.482     raeburn  3737:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3738: 
                   3739:     if (!defined($udom)) {
                   3740:         $udom = $env{'user.domain'};
                   3741:     }
                   3742:     if (!defined($uname)) {
                   3743:         $uname = $env{'user.name'};
                   3744:     }
                   3745: 
                   3746:     # If uname and udom are for a course, check for blocks in the course.
                   3747: 
                   3748:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3749:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3750:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3751:         return ($startblock,$endblock);
                   3752:     }
1.474     raeburn  3753: 
1.502     raeburn  3754:     my $startblock = 0;
                   3755:     my $endblock = 0;
1.482     raeburn  3756:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3757: 
1.490     raeburn  3758:     # If uname is for a user, and activity is course-specific, i.e.,
                   3759:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3760: 
1.490     raeburn  3761:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3762:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3763:         foreach my $key (keys(%live_courses)) {
                   3764:             if ($key ne $env{'request.course.id'}) {
                   3765:                 delete($live_courses{$key});
                   3766:             }
                   3767:         }
                   3768:     }
                   3769: 
                   3770:     my $otheruser = 0;
                   3771:     my %own_courses;
                   3772:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3773:         # Resource belongs to user other than current user.
                   3774:         $otheruser = 1;
                   3775:         # Gather courses for current user
                   3776:         %own_courses = 
                   3777:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3778:     }
                   3779: 
                   3780:     # Gather active course roles - course coordinator, instructor, 
                   3781:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3782: 
                   3783:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3784:         my ($cdom,$cnum);
                   3785:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3786:             $cdom = $env{'course.'.$course.'.domain'};
                   3787:             $cnum = $env{'course.'.$course.'.num'};
                   3788:         } else {
1.490     raeburn  3789:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3790:         }
                   3791:         my $no_ownblock = 0;
                   3792:         my $no_userblock = 0;
1.533     raeburn  3793:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3794:             # Check if current user has 'evb' priv for this
                   3795:             if (defined($own_courses{$course})) {
                   3796:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3797:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3798:                     if ($sec ne 'none') {
                   3799:                         $checkrole .= '/'.$sec;
                   3800:                     }
                   3801:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3802:                         $no_ownblock = 1;
                   3803:                         last;
                   3804:                     }
                   3805:                 }
                   3806:             }
                   3807:             # if they have 'evb' priv and are currently not playing student
                   3808:             next if (($no_ownblock) &&
                   3809:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3810:         }
1.474     raeburn  3811:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3812:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3813:             if ($sec ne 'none') {
1.482     raeburn  3814:                 $checkrole .= '/'.$sec;
1.474     raeburn  3815:             }
1.490     raeburn  3816:             if ($otheruser) {
                   3817:                 # Resource belongs to user other than current user.
                   3818:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3819:                 my ($trole,$tdom,$tnum,$tsec);
                   3820:                 my $entry = $live_courses{$course}{$sec};
                   3821:                 if ($entry =~ /^cr/) {
                   3822:                     ($trole,$tdom,$tnum,$tsec) = 
                   3823:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3824:                 } else {
                   3825:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3826:                 }
                   3827:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3828:                 $area = '/'.$tdom.'/'.$tnum;
                   3829:                 $trest = $tnum;
                   3830:                 if ($tsec ne '') {
                   3831:                     $area .= '/'.$tsec;
                   3832:                     $trest .= '/'.$tsec;
                   3833:                 }
                   3834:                 $spec = $trole.'.'.$area;
                   3835:                 if ($trole =~ /^cr/) {
                   3836:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3837:                                                       $tdom,$spec,$trest,$area);
                   3838:                 } else {
                   3839:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3840:                                                        $tdom,$spec,$trest,$area);
                   3841:                 }
                   3842:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3843:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3844:                     if ($1) {
                   3845:                         $no_userblock = 1;
                   3846:                         last;
                   3847:                     }
                   3848:                 }
1.490     raeburn  3849:             } else {
                   3850:                 # Resource belongs to current user
                   3851:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3852:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3853:                     $no_ownblock = 1;
                   3854:                     last;
                   3855:                 }
1.474     raeburn  3856:             }
                   3857:         }
                   3858:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3859:         next if (($no_ownblock) &&
1.491     albertel 3860:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3861:         next if ($no_userblock);
1.474     raeburn  3862: 
1.866     kalberla 3863:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3864:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3865:         
                   3866:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3867:         if (($start != 0) && 
                   3868:             (($startblock == 0) || ($startblock > $start))) {
                   3869:             $startblock = $start;
                   3870:         }
                   3871:         if (($end != 0)  &&
                   3872:             (($endblock == 0) || ($endblock < $end))) {
                   3873:             $endblock = $end;
                   3874:         }
1.490     raeburn  3875:     }
                   3876:     return ($startblock,$endblock);
                   3877: }
                   3878: 
                   3879: sub get_blocks {
                   3880:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3881:     my $startblock = 0;
                   3882:     my $endblock = 0;
                   3883:     my $course = $cdom.'_'.$cnum;
                   3884:     $setters->{$course} = {};
                   3885:     $setters->{$course}{'staff'} = [];
                   3886:     $setters->{$course}{'times'} = [];
                   3887:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3888:     foreach my $record (keys(%records)) {
                   3889:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3890:         if ($start <= time && $end >= time) {
                   3891:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3892:                 &parse_block_record($records{$record});
                   3893:             if ($blocks->{$activity} eq 'on') {
                   3894:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3895:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3896:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3897:                     $startblock = $start;
1.490     raeburn  3898:                 }
1.491     albertel 3899:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3900:                     $endblock = $end;
1.474     raeburn  3901:                 }
                   3902:             }
                   3903:         }
                   3904:     }
                   3905:     return ($startblock,$endblock);
                   3906: }
                   3907: 
                   3908: sub parse_block_record {
                   3909:     my ($record) = @_;
                   3910:     my ($setuname,$setudom,$title,$blocks);
                   3911:     if (ref($record) eq 'HASH') {
                   3912:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3913:         $title = &unescape($record->{'event'});
                   3914:         $blocks = $record->{'blocks'};
                   3915:     } else {
                   3916:         my @data = split(/:/,$record,3);
                   3917:         if (scalar(@data) eq 2) {
                   3918:             $title = $data[1];
                   3919:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3920:         } else {
                   3921:             ($setuname,$setudom,$title) = @data;
                   3922:         }
                   3923:         $blocks = { 'com' => 'on' };
                   3924:     }
                   3925:     return ($setuname,$setudom,$title,$blocks);
                   3926: }
                   3927: 
1.854     kalberla 3928: sub blocking_status {
                   3929:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3930:   my %setters;
1.890     droeschl 3931: 
                   3932:   # check for active blocking
1.867     kalberla 3933:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 3934: 
1.890     droeschl 3935:   my $blocked = $startblock && $endblock ? 1 : 0;
                   3936: 
                   3937:   # caller just wants to know whether a block is active
                   3938:   if (!wantarray) { return $blocked; }
                   3939: 
                   3940:   # build a link to a popup window containing the details
                   3941:   my $querystring  = "?activity=$activity";
                   3942:   # $uname and $udom decide whose portfolio the user is trying to look at
                   3943:      $querystring .= "&amp;udom=$udom"      if $udom;
                   3944:      $querystring .= "&amp;uname=$uname"    if $uname;
                   3945: 
                   3946:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 3947:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   3948:         var options = "width=" + w + ",height=" + h + ",";
                   3949:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   3950:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   3951:         var newWin = window.open(url, wdwName, options);
                   3952:         newWin.focus();
                   3953:     }
1.890     droeschl 3954: END_MYBLOCK
1.854     kalberla 3955: 
1.890     droeschl 3956:   $output = Apache::lonhtmlcommon::scripttag($output);
                   3957:   
1.854     kalberla 3958:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 3959:   my $text = mt('Communication Blocked');
                   3960: 
1.867     kalberla 3961:   $output .= <<"END_BLOCK";
                   3962: <div class='LC_comblock'>
1.869     kalberla 3963:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 3964:   title='$text'>
                   3965:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 3966:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 3967:   title='$text'>$text</a>
1.867     kalberla 3968: </div>
                   3969: 
                   3970: END_BLOCK
1.474     raeburn  3971: 
1.854     kalberla 3972:   return ($blocked, $output);
                   3973: }
1.490     raeburn  3974: 
1.60      matthew  3975: ###############################################
                   3976: 
1.682     raeburn  3977: sub check_ip_acc {
                   3978:     my ($acc)=@_;
                   3979:     &Apache::lonxml::debug("acc is $acc");
                   3980:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3981:         return 1;
                   3982:     }
                   3983:     my $allowed=0;
                   3984:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3985: 
                   3986:     my $name;
                   3987:     foreach my $pattern (split(',',$acc)) {
                   3988:         $pattern =~ s/^\s*//;
                   3989:         $pattern =~ s/\s*$//;
                   3990:         if ($pattern =~ /\*$/) {
                   3991:             #35.8.*
                   3992:             $pattern=~s/\*//;
                   3993:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3994:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3995:             #35.8.3.[34-56]
                   3996:             my $low=$2;
                   3997:             my $high=$3;
                   3998:             $pattern=$1;
                   3999:             if ($ip =~ /^\Q$pattern\E/) {
                   4000:                 my $last=(split(/\./,$ip))[3];
                   4001:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4002:             }
                   4003:         } elsif ($pattern =~ /^\*/) {
                   4004:             #*.msu.edu
                   4005:             $pattern=~s/\*//;
                   4006:             if (!defined($name)) {
                   4007:                 use Socket;
                   4008:                 my $netaddr=inet_aton($ip);
                   4009:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4010:             }
                   4011:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4012:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4013:             #127.0.0.1
                   4014:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4015:         } else {
                   4016:             #some.name.com
                   4017:             if (!defined($name)) {
                   4018:                 use Socket;
                   4019:                 my $netaddr=inet_aton($ip);
                   4020:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4021:             }
                   4022:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4023:         }
                   4024:         if ($allowed) { last; }
                   4025:     }
                   4026:     return $allowed;
                   4027: }
                   4028: 
                   4029: ###############################################
                   4030: 
1.60      matthew  4031: =pod
                   4032: 
1.112     bowersj2 4033: =head1 Domain Template Functions
                   4034: 
                   4035: =over 4
                   4036: 
                   4037: =item * &determinedomain()
1.60      matthew  4038: 
                   4039: Inputs: $domain (usually will be undef)
                   4040: 
1.63      www      4041: Returns: Determines which domain should be used for designs
1.60      matthew  4042: 
                   4043: =cut
1.54      www      4044: 
1.60      matthew  4045: ###############################################
1.63      www      4046: sub determinedomain {
                   4047:     my $domain=shift;
1.531     albertel 4048:     if (! $domain) {
1.60      matthew  4049:         # Determine domain if we have not been given one
1.893     raeburn  4050:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4051:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4052:         if ($env{'request.role.domain'}) { 
                   4053:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4054:         }
                   4055:     }
1.63      www      4056:     return $domain;
                   4057: }
                   4058: ###############################################
1.517     raeburn  4059: 
1.518     albertel 4060: sub devalidate_domconfig_cache {
                   4061:     my ($udom)=@_;
                   4062:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4063: }
                   4064: 
                   4065: # ---------------------- Get domain configuration for a domain
                   4066: sub get_domainconf {
                   4067:     my ($udom) = @_;
                   4068:     my $cachetime=1800;
                   4069:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4070:     if (defined($cached)) { return %{$result}; }
                   4071: 
                   4072:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4073: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4074:     my (%designhash,%legacy);
1.518     albertel 4075:     if (keys(%domconfig) > 0) {
                   4076:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4077:             if (keys(%{$domconfig{'login'}})) {
                   4078:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4079:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4080:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4081:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4082:                                 $domconfig{'login'}{$key}{$img};
                   4083:                         }
                   4084:                     } else {
                   4085:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4086:                     }
1.632     raeburn  4087:                 }
                   4088:             } else {
                   4089:                 $legacy{'login'} = 1;
1.518     albertel 4090:             }
1.632     raeburn  4091:         } else {
                   4092:             $legacy{'login'} = 1;
1.518     albertel 4093:         }
                   4094:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4095:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4096:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4097:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4098:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4099:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4100:                         }
1.518     albertel 4101:                     }
                   4102:                 }
1.632     raeburn  4103:             } else {
                   4104:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4105:             }
1.632     raeburn  4106:         } else {
                   4107:             $legacy{'rolecolors'} = 1;
1.518     albertel 4108:         }
1.632     raeburn  4109:         if (keys(%legacy) > 0) {
                   4110:             my %legacyhash = &get_legacy_domconf($udom);
                   4111:             foreach my $item (keys(%legacyhash)) {
                   4112:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4113:                     if ($legacy{'login'}) { 
                   4114:                         $designhash{$item} = $legacyhash{$item};
                   4115:                     }
                   4116:                 } else {
                   4117:                     if ($legacy{'rolecolors'}) {
                   4118:                         $designhash{$item} = $legacyhash{$item};
                   4119:                     }
1.518     albertel 4120:                 }
                   4121:             }
                   4122:         }
1.632     raeburn  4123:     } else {
                   4124:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4125:     }
                   4126:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4127: 				  $cachetime);
                   4128:     return %designhash;
                   4129: }
                   4130: 
1.632     raeburn  4131: sub get_legacy_domconf {
                   4132:     my ($udom) = @_;
                   4133:     my %legacyhash;
                   4134:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4135:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4136:     if (-e $designfile) {
                   4137:         if ( open (my $fh,"<$designfile") ) {
                   4138:             while (my $line = <$fh>) {
                   4139:                 next if ($line =~ /^\#/);
                   4140:                 chomp($line);
                   4141:                 my ($key,$val)=(split(/\=/,$line));
                   4142:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4143:             }
                   4144:             close($fh);
                   4145:         }
                   4146:     }
                   4147:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4148:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4149:     }
                   4150:     return %legacyhash;
                   4151: }
                   4152: 
1.63      www      4153: =pod
                   4154: 
1.112     bowersj2 4155: =item * &domainlogo()
1.63      www      4156: 
                   4157: Inputs: $domain (usually will be undef)
                   4158: 
                   4159: Returns: A link to a domain logo, if the domain logo exists.
                   4160: If the domain logo does not exist, a description of the domain.
                   4161: 
                   4162: =cut
1.112     bowersj2 4163: 
1.63      www      4164: ###############################################
                   4165: sub domainlogo {
1.517     raeburn  4166:     my $domain = &determinedomain(shift);
1.518     albertel 4167:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4168:     # See if there is a logo
                   4169:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4170:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4171:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4172: 	    if ($imgsrc =~ m{^/res/}) {
                   4173: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4174: 		&Apache::lonnet::repcopy($local_name);
                   4175: 	    }
                   4176: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4177:         } 
                   4178:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4179:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4180:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4181:     } else {
1.60      matthew  4182:         return '';
1.59      www      4183:     }
                   4184: }
1.63      www      4185: ##############################################
                   4186: 
                   4187: =pod
                   4188: 
1.112     bowersj2 4189: =item * &designparm()
1.63      www      4190: 
                   4191: Inputs: $which parameter; $domain (usually will be undef)
                   4192: 
                   4193: Returns: value of designparamter $which
                   4194: 
                   4195: =cut
1.112     bowersj2 4196: 
1.397     albertel 4197: 
1.400     albertel 4198: ##############################################
1.397     albertel 4199: sub designparm {
                   4200:     my ($which,$domain)=@_;
                   4201:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4202:         return $env{'environment.color.'.$which};
1.96      www      4203:     }
1.63      www      4204:     $domain=&determinedomain($domain);
1.518     albertel 4205:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4206:     my $output;
1.517     raeburn  4207:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4208:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4209:     } else {
1.520     raeburn  4210:         $output = $defaultdesign{$which};
                   4211:     }
                   4212:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4213:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4214:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4215:             if ($output =~ m{^/res/}) {
                   4216:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4217:                 &Apache::lonnet::repcopy($local_name);
                   4218:             }
1.520     raeburn  4219:             $output = &lonhttpdurl($output);
                   4220:         }
1.63      www      4221:     }
1.520     raeburn  4222:     return $output;
1.63      www      4223: }
1.59      www      4224: 
1.822     bisitz   4225: ##############################################
                   4226: =pod
                   4227: 
1.832     bisitz   4228: =item * &authorspace()
                   4229: 
                   4230: Inputs: ./.
                   4231: 
                   4232: Returns: Path to the Construction Space of the current user's
                   4233:          accessed author space
                   4234:          The author space will be that of the current user
                   4235:          when accessing the own author space
                   4236:          and that of the co-author/assistent co-author
                   4237:          when accessing the co-author's/assistent co-author's
                   4238:          space
                   4239: 
                   4240: =cut
                   4241: 
                   4242: sub authorspace {
                   4243:     my $caname = '';
                   4244:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4245:         (undef,$caname) =
                   4246:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4247:     } else {
                   4248:         $caname = $env{'user.name'};
                   4249:     }
                   4250:     return '/priv/'.$caname.'/';
                   4251: }
                   4252: 
                   4253: ##############################################
                   4254: =pod
                   4255: 
1.822     bisitz   4256: =item * &head_subbox()
                   4257: 
                   4258: Inputs: $content (contains HTML code with page functions, etc.)
                   4259: 
                   4260: Returns: HTML div with $content
                   4261:          To be included in page header
                   4262: 
                   4263: =cut
                   4264: 
                   4265: sub head_subbox {
                   4266:     my ($content)=@_;
                   4267:     my $output =
1.844     bisitz   4268:         '<div id="LC_head_subbox">'
1.822     bisitz   4269:        .$content
                   4270:        .'</div>'
                   4271: }
                   4272: 
                   4273: ##############################################
                   4274: =pod
                   4275: 
                   4276: =item * &CSTR_pageheader()
                   4277: 
                   4278: Inputs: ./.
                   4279: 
                   4280: Returns: HTML div with CSTR path and recent box
                   4281:          To be included on Construction Space pages
                   4282: 
                   4283: =cut
                   4284: 
                   4285: sub CSTR_pageheader {
                   4286:     # this is for resources; directories have customtitle, and crumbs
                   4287:             # and select recent are created in lonpubdir.pm  
                   4288:     my ($uname,$thisdisfn)=
                   4289:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4290:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4291:     $formaction=~s/\/+/\//g;
                   4292: 
                   4293:     my $parentpath = '';
                   4294:     my $lastitem = '';
                   4295:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4296:         $parentpath = $1;
                   4297:         $lastitem = $2;
                   4298:     } else {
                   4299:         $lastitem = $thisdisfn;
                   4300:     }
                   4301:     return
                   4302:          '<div>'
                   4303:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4304:         .'<b>'.&mt('Construction Space:').'</b> '
                   4305:         .'<form name="dirs" method="post" action="'.$formaction
                   4306:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4307:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4308:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4309:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4310:         .'</form>'
                   4311:         .&Apache::lonmenu::constspaceform()
                   4312:         .'</div>';
                   4313: }
                   4314: 
1.60      matthew  4315: ###############################################
                   4316: ###############################################
                   4317: 
                   4318: =pod
                   4319: 
1.112     bowersj2 4320: =back
                   4321: 
1.549     albertel 4322: =head1 HTML Helpers
1.112     bowersj2 4323: 
                   4324: =over 4
                   4325: 
                   4326: =item * &bodytag()
1.60      matthew  4327: 
                   4328: Returns a uniform header for LON-CAPA web pages.
                   4329: 
                   4330: Inputs: 
                   4331: 
1.112     bowersj2 4332: =over 4
                   4333: 
                   4334: =item * $title, A title to be displayed on the page.
                   4335: 
                   4336: =item * $function, the current role (can be undef).
                   4337: 
                   4338: =item * $addentries, extra parameters for the <body> tag.
                   4339: 
                   4340: =item * $bodyonly, if defined, only return the <body> tag.
                   4341: 
                   4342: =item * $domain, if defined, force a given domain.
                   4343: 
                   4344: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4345:             text interface only)
1.60      matthew  4346: 
1.814     bisitz   4347: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4348:                      navigational links
1.317     albertel 4349: 
1.338     albertel 4350: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4351: 
1.361     albertel 4352: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4353:          'Switch To Inline Menu' link
                   4354: 
1.460     albertel 4355: =item * $args, optional argument valid values are
                   4356:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4357:             inherit_jsmath -> when creating popup window in a page,
                   4358:                               should it have jsmath forced on by the
                   4359:                               current page
1.460     albertel 4360: 
1.112     bowersj2 4361: =back
                   4362: 
1.60      matthew  4363: Returns: A uniform header for LON-CAPA web pages.  
                   4364: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4365: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4366: other decorations will be returned.
                   4367: 
                   4368: =cut
                   4369: 
1.54      www      4370: sub bodytag {
1.831     bisitz   4371:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4372:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4373: 
1.460     albertel 4374:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4375: 
1.183     matthew  4376:     $function = &get_users_function() if (!$function);
1.339     albertel 4377:     my $img =    &designparm($function.'.img',$domain);
                   4378:     my $font =   &designparm($function.'.font',$domain);
                   4379:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4380: 
1.803     bisitz   4381:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4382: 		   'bgcolor' => $pgbg,
1.339     albertel 4383: 		   'text'    => $font,
                   4384:                    'alink'   => &designparm($function.'.alink',$domain),
                   4385: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4386: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4387:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4388: 
1.63      www      4389:  # role and realm
1.378     raeburn  4390:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4391:     if ($role  eq 'ca') {
1.479     albertel 4392:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4393:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4394:     } 
1.55      www      4395: # realm
1.258     albertel 4396:     if ($env{'request.course.id'}) {
1.378     raeburn  4397:         if ($env{'request.role'} !~ /^cr/) {
                   4398:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4399:         }
1.898     raeburn  4400:         if ($env{'request.course.sec'}) {
                   4401:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4402:         }   
1.359     albertel 4403: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4404:     } else {
                   4405:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4406:     }
1.433     albertel 4407: 
1.359     albertel 4408:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4409: # Set messages
1.60      matthew  4410:     my $messages=&domainlogo($domain);
1.330     albertel 4411: 
1.438     albertel 4412:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4413: 
1.101     www      4414: # construct main body tag
1.359     albertel 4415:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4416: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4417: 
1.530     albertel 4418:     if ($bodyonly) {
1.60      matthew  4419:         return $bodytag;
1.798     tempelho 4420:     } 
1.359     albertel 4421: 
1.410     albertel 4422:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4423:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4424: 	undef($role);
1.434     albertel 4425:     } else {
                   4426: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4427:     }
1.359     albertel 4428:     
1.762     bisitz   4429:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4430:     #
                   4431:     # Extra info if you are the DC
                   4432:     my $dc_info = '';
                   4433:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4434:                         $env{'course.'.$env{'request.course.id'}.
                   4435:                                  '.domain'}.'/'})) {
                   4436:         my $cid = $env{'request.course.id'};
                   4437:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4438:         $dc_info =~ s/\s+$//;
1.359     albertel 4439:         $dc_info = '('.$dc_info.')';
                   4440:     }
                   4441: 
1.898     raeburn  4442:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4443:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4444: 
1.837     bisitz   4445:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4446:         # No Remote
1.894     droeschl 4447:         if ($env{'request.state'} eq 'construct') {
                   4448:             $forcereg=1;
                   4449:         }
1.359     albertel 4450: 
1.894     droeschl 4451:     #    if ($env{'request.state'} eq 'construct') {
                   4452:     #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4453:     #    }
1.359     albertel 4454: 
1.816     bisitz   4455:         my $titletable = '<table id="LC_title_bar">'
1.894     droeschl 4456:                             ."<tr><td> $titleinfo $dc_info</td>"
                   4457:                             .'</tr></table>';
                   4458: 
                   4459:         if ($no_nav_bar) {
                   4460:             $bodytag .= $titletable;
                   4461:         } else {
                   4462:             $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4463:                 <em>$realm</em> $dc_info</div>| unless $env{'form.inhibitmenu'};
1.816     bisitz   4464: 
1.894     droeschl 4465: #SD $titletable is obsolete
                   4466: #SD            if ($env{'request.state'} eq 'construct') {
                   4467: #SD                $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$titletable);
                   4468: #SD            } else {
                   4469: #SD                $bodytag .= &Apache::lonmenu::menubuttons($forcereg).$titletable;
                   4470: #SD            }
                   4471:                if (   $env{'form.inhibitmenu'} eq 'yes' 
                   4472:                    || $ENV{'REQUEST_URI'} eq '/adm/logout'
                   4473:                    || $env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
                   4474:                    
                   4475:                    return $bodytag;
                   4476:                }
1.852     droeschl 4477: 
1.894     droeschl 4478:                $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4479:                                 Apache::lonmenu::utilityfunctions(),
                   4480:                                 'start');
                   4481:                $bodytag .= Apache::lonmenu::primary_menu();
                   4482:                $bodytag .= Apache::lonmenu::secondary_menu();
                   4483:                #SD remove next line
                   4484:                #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
                   4485:                $bodytag .= Apache::lonmenu::serverform();
                   4486:                $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
                   4487:                $bodytag .= Apache::lonmenu::innerregister($forcereg) if $forcereg;
1.235     raeburn  4488:         }
                   4489:         return $bodytag;
1.94      www      4490:     }
1.95      www      4491: 
1.93      www      4492: #
1.95      www      4493: # Top frame rendering, Remote is up
1.93      www      4494: #
1.359     albertel 4495: 
1.517     raeburn  4496:     my $imgsrc = $img;
                   4497:     if ($img =~ /^\/adm/) {
1.575     albertel 4498:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4499:     }
                   4500:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4501: 
1.305     www      4502:     # Explicit link to get inline menu
1.361     albertel 4503:     my $menu= ($no_inline_link?''
1.883     droeschl 4504: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.853     droeschl 4505:     $bodytag .= qq|<div id="LC_nav_bar">$name $role
                   4506:             <em>$realm</em> $dc_info </div>
1.897     wenzelju 4507:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4508:                 <li>$menu</li>
                   4509:             </ol>| unless $env{'form.inhibitmenu'};
1.245     matthew  4510:     #
1.94      www      4511:     return(<<ENDBODY);
1.60      matthew  4512: $bodytag
1.359     albertel 4513: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4514: <tr><td>$upperleft</td>
                   4515:     <td>$messages&nbsp;</td>
1.54      www      4516: </tr>
1.359     albertel 4517: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4518: </tr>
1.356     albertel 4519: </table>
1.54      www      4520: ENDBODY
1.182     matthew  4521: }
                   4522: 
1.330     albertel 4523: sub make_attr_string {
                   4524:     my ($register,$attr_ref) = @_;
                   4525: 
                   4526:     if ($attr_ref && !ref($attr_ref)) {
                   4527: 	die("addentries Must be a hash ref ".
                   4528: 	    join(':',caller(1))." ".
                   4529: 	    join(':',caller(0))." ");
                   4530:     }
                   4531: 
                   4532:     if ($register) {
1.339     albertel 4533: 	my ($on_load,$on_unload);
                   4534: 	foreach my $key (keys(%{$attr_ref})) {
                   4535: 	    if      (lc($key) eq 'onload') {
                   4536: 		$on_load.=$attr_ref->{$key}.';';
                   4537: 		delete($attr_ref->{$key});
                   4538: 
                   4539: 	    } elsif (lc($key) eq 'onunload') {
                   4540: 		$on_unload.=$attr_ref->{$key}.';';
                   4541: 		delete($attr_ref->{$key});
                   4542: 	    }
                   4543: 	}
                   4544: 	$attr_ref->{'onload'}  =
                   4545: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4546: 	$attr_ref->{'onunload'}=
                   4547: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4548:     }
                   4549: 
                   4550: # Accessibility font enhance
                   4551:     if ($env{'browser.fontenhance'} eq 'on') {
                   4552: 	my $style;
                   4553: 	foreach my $key (keys(%{$attr_ref})) {
                   4554: 	    if (lc($key) eq 'style') {
                   4555: 		$style.=$attr_ref->{$key}.';';
                   4556: 		delete($attr_ref->{$key});
                   4557: 	    }
                   4558: 	}
                   4559: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4560:     }
1.339     albertel 4561: 
1.330     albertel 4562:     my $attr_string;
                   4563:     foreach my $attr (keys(%$attr_ref)) {
                   4564: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4565:     }
                   4566:     return $attr_string;
                   4567: }
                   4568: 
                   4569: 
1.182     matthew  4570: ###############################################
1.251     albertel 4571: ###############################################
                   4572: 
                   4573: =pod
                   4574: 
                   4575: =item * &endbodytag()
                   4576: 
                   4577: Returns a uniform footer for LON-CAPA web pages.
                   4578: 
1.635     raeburn  4579: Inputs: 1 - optional reference to an args hash
                   4580: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4581: a 'Continue' link is not displayed if the page contains an
                   4582: internal redirect in the <head></head> section,
                   4583: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4584: 
                   4585: =cut
                   4586: 
                   4587: sub endbodytag {
1.635     raeburn  4588:     my ($args) = @_;
1.251     albertel 4589:     my $endbodytag='</body>';
1.269     albertel 4590:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4591:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4592:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4593: 	    $endbodytag=
                   4594: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4595: 	        &mt('Continue').'</a>'.
                   4596: 	        $endbodytag;
                   4597:         }
1.315     albertel 4598:     }
1.251     albertel 4599:     return $endbodytag;
                   4600: }
                   4601: 
1.352     albertel 4602: =pod
                   4603: 
                   4604: =item * &standard_css()
                   4605: 
                   4606: Returns a style sheet
                   4607: 
                   4608: Inputs: (all optional)
                   4609:             domain         -> force to color decorate a page for a specific
                   4610:                                domain
                   4611:             function       -> force usage of a specific rolish color scheme
                   4612:             bgcolor        -> override the default page bgcolor
                   4613: 
                   4614: =cut
                   4615: 
1.343     albertel 4616: sub standard_css {
1.345     albertel 4617:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4618:     $function  = &get_users_function() if (!$function);
                   4619:     my $img    = &designparm($function.'.img',   $domain);
                   4620:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4621:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4622:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4623: #second colour for later usage
1.345     albertel 4624:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4625:     my $pgbg_or_bgcolor =
                   4626: 	         $bgcolor ||
1.352     albertel 4627: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4628:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4629:     my $alink  = &designparm($function.'.alink', $domain);
                   4630:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4631:     my $link   = &designparm($function.'.link',  $domain);
                   4632: 
1.704     muellerd 4633:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4634:     my $bgcol = &designparm('login.bgcol',$domain);
                   4635:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4636: 
1.602     albertel 4637:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4638:     my $mono                 = 'monospace';
1.850     bisitz   4639:     my $data_table_head      = $sidebg;
                   4640:     my $data_table_light     = '#FAFAFA';
                   4641:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4642:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4643:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4644:     my $mail_new             = '#FFBB77';
                   4645:     my $mail_new_hover       = '#DD9955';
                   4646:     my $mail_read            = '#BBBB77';
                   4647:     my $mail_read_hover      = '#999944';
                   4648:     my $mail_replied         = '#AAAA88';
                   4649:     my $mail_replied_hover   = '#888855';
                   4650:     my $mail_other           = '#99BBBB';
                   4651:     my $mail_other_hover     = '#669999';
1.391     albertel 4652:     my $table_header         = '#DDDDDD';
1.489     raeburn  4653:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4654:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4655: 
1.608     albertel 4656:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4657: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4658: 	                                                 : '0 3px 0 4px';
1.448     albertel 4659: 
1.523     albertel 4660: 
1.343     albertel 4661:     return <<END;
1.795     www      4662: body {
                   4663:    font-family: $sans;
                   4664:    line-height:130%;
                   4665:    font-size:0.83em;
                   4666:    color:$font;
                   4667: }
                   4668: 
                   4669: a:link, a:visited { 
                   4670:   font-size:100%; 
                   4671: }
                   4672: 
                   4673: a:focus { 
                   4674:   color: red;
                   4675:   background: yellow 
                   4676: }
1.698     harmsja  4677: 
1.795     www      4678: form, .inline { 
                   4679:    display: inline; 
                   4680: }
1.721     harmsja  4681: 
1.795     www      4682: .LC_right {
                   4683:    text-align:right;
                   4684: }
                   4685: 
                   4686: .LC_middle {
                   4687:    vertical-align:middle;
                   4688: }
1.721     harmsja  4689: 
                   4690: /* just for tests */
1.754     droeschl 4691: .LC_400Box {width:400px; }
1.721     harmsja  4692: /* end */
                   4693: 
1.778     bisitz   4694: .LC_filename {
                   4695:   font-family: $mono;
                   4696:   white-space:pre;
                   4697: }
                   4698: 
                   4699: .LC_fileicon {
                   4700:   border: none;
                   4701:   height: 1.3em;
                   4702:   vertical-align: text-bottom;
                   4703:   margin-right: 0.3em;
                   4704:   text-decoration:none;
                   4705: }
                   4706: 
1.350     albertel 4707: .LC_error {
                   4708:   color: red;
                   4709:   font-size: larger;
                   4710: }
1.795     www      4711: 
1.457     albertel 4712: .LC_warning,
                   4713: .LC_diff_removed {
1.733     bisitz   4714:   color: red;
1.394     albertel 4715: }
1.532     albertel 4716: 
                   4717: .LC_info,
1.457     albertel 4718: .LC_success,
                   4719: .LC_diff_added {
1.350     albertel 4720:   color: green;
                   4721: }
1.795     www      4722: 
1.802     bisitz   4723: div.LC_confirm_box {
                   4724:   background-color: #FAFAFA;
                   4725:   border: 1px solid $lg_border_color;
                   4726:   margin-right: 0;
                   4727:   padding: 5px;
                   4728: }
                   4729: 
                   4730: div.LC_confirm_box .LC_error img,
                   4731: div.LC_confirm_box .LC_success img {
                   4732:   vertical-align: middle;
                   4733: }
                   4734: 
1.440     albertel 4735: .LC_icon {
1.771     droeschl 4736:   border: none;
1.790     droeschl 4737:   vertical-align: middle;
1.771     droeschl 4738: }
                   4739: 
1.543     albertel 4740: .LC_docs_spacer {
                   4741:   width: 25px;
                   4742:   height: 1px;
1.771     droeschl 4743:   border: none;
1.543     albertel 4744: }
1.346     albertel 4745: 
1.532     albertel 4746: .LC_internal_info {
1.735     bisitz   4747:   color: #999999;
1.532     albertel 4748: }
                   4749: 
1.794     www      4750: .LC_discussion {
                   4751:    background: $tabbg;
                   4752:    border: 1px solid black;
                   4753:    margin: 2px;
                   4754: }
                   4755: 
                   4756: .LC_disc_action_links_bar {
                   4757:    background: $tabbg;
1.803     bisitz   4758:    border: none;
1.795     www      4759:    margin: 4px;
1.794     www      4760: }
                   4761: 
                   4762: .LC_disc_action_left {
                   4763:    text-align: left;
                   4764: }
                   4765: 
                   4766: .LC_disc_action_right {
                   4767:    text-align: right;
                   4768: }
                   4769: 
                   4770: .LC_disc_new_item {
                   4771:    background: white;
                   4772:    border: 2px solid red;
                   4773:    margin: 2px;
                   4774: }
                   4775: 
                   4776: .LC_disc_old_item {
                   4777:    background: white;
                   4778:    border: 1px solid black;
                   4779:    margin: 2px;
                   4780: }
                   4781: 
1.458     albertel 4782: table.LC_pastsubmission {
                   4783:   border: 1px solid black;
                   4784:   margin: 2px;
                   4785: }
                   4786: 
1.795     www      4787: table#LC_top_nav,
                   4788: table#LC_menubuttons,
                   4789: table#LC_nav_location {
1.345     albertel 4790:   width: 100%;
                   4791:   background: $pgbg;
1.392     albertel 4792:   border: 2px;
1.402     albertel 4793:   border-collapse: separate;
1.803     bisitz   4794:   padding: 0;
1.345     albertel 4795: }
1.392     albertel 4796: 
1.801     tempelho 4797: table#LC_title_bar a {
                   4798:   color: $fontmenu;
                   4799: }
1.836     bisitz   4800: 
1.807     droeschl 4801: table#LC_title_bar {
1.819     tempelho 4802:   clear: both;
1.836     bisitz   4803:   display: none;
1.807     droeschl 4804: }
                   4805: 
1.795     www      4806: table#LC_title_bar,
                   4807: table.LC_breadcrumbs,
1.393     albertel 4808: table#LC_title_bar.LC_with_remote {
1.359     albertel 4809:   width: 100%;
1.392     albertel 4810:   border-color: $pgbg;
                   4811:   border-style: solid;
                   4812:   border-width: $border;
1.379     albertel 4813:   background: $pgbg;
1.801     tempelho 4814:   color: $fontmenu;
1.392     albertel 4815:   border-collapse: collapse;
1.803     bisitz   4816:   padding: 0;
1.819     tempelho 4817:   margin: 0;
1.359     albertel 4818: }
1.795     www      4819: 
1.359     albertel 4820: table#LC_title_bar td {
                   4821:   background: $tabbg;
                   4822: }
1.795     www      4823: 
1.706     harmsja  4824: table#LC_menubuttons img{
1.803     bisitz   4825:   border: none;
1.346     albertel 4826: }
1.795     www      4827: 
1.345     albertel 4828: table#LC_top_nav td {
                   4829:   background: $tabbg;
1.803     bisitz   4830:   border: none;
1.407     albertel 4831:   font-size: small;
1.706     harmsja  4832:   vertical-align:top;
                   4833:   padding:2px 5px 2px 5px;
1.345     albertel 4834: }
1.795     www      4835: 
                   4836: table#LC_top_nav td a,
                   4837: div#LC_top_nav a {
1.345     albertel 4838:   color: $font;
                   4839: }
1.795     www      4840: 
1.364     albertel 4841: table#LC_top_nav td.LC_top_nav_logo {
                   4842:   background: $tabbg;
1.432     albertel 4843:   text-align: left;
1.408     albertel 4844:   white-space: nowrap;
1.432     albertel 4845:   width: 31px;
1.408     albertel 4846: }
1.795     www      4847: 
1.408     albertel 4848: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4849:   border: none;
1.408     albertel 4850:   vertical-align: bottom;
1.364     albertel 4851: }
1.795     www      4852: 
1.777     tempelho 4853: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4854: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4855:   width: 2.0em;
                   4856: }
1.795     www      4857: 
1.442     albertel 4858: table#LC_top_nav td.LC_top_nav_login {
                   4859:   width: 4.0em;
                   4860:   text-align: center;
                   4861: }
1.795     www      4862: 
1.842     droeschl 4863: .LC_breadcrumbs_component {
                   4864:     float: right;
                   4865:     margin: 0 1em;
1.357     albertel 4866: }
1.842     droeschl 4867: .LC_breadcrumbs_component img {
                   4868:     vertical-align: middle;
1.777     tempelho 4869: }
1.795     www      4870: 
1.383     albertel 4871: td.LC_table_cell_checkbox {
                   4872:   text-align: center;
                   4873: }
1.795     www      4874: 
1.779     bisitz   4875: table#LC_mainmenu td.LC_mainmenu_column {
                   4876:     vertical-align: top;
1.777     tempelho 4877: }
1.522     albertel 4878: 
1.795     www      4879: .LC_fontsize_small {
1.705     tempelho 4880:  font-size: 70%;
                   4881: }
                   4882: 
1.844     bisitz   4883: #LC_breadcrumbs {
1.819     tempelho 4884:  clear:both;
                   4885:  background: $sidebg;
1.822     bisitz   4886:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4887:  line-height: 32px; 
1.822     bisitz   4888:  margin: 0;
1.819     tempelho 4889:  padding: 0;
                   4890: }
1.862     bisitz   4891: 
1.839     droeschl 4892: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   4893: #LC_remote #LC_breadcrumbs {
1.839     droeschl 4894:     display:none;
                   4895: }
1.819     tempelho 4896: 
1.844     bisitz   4897: #LC_head_subbox {
1.822     bisitz   4898:  clear:both;
                   4899:  background: #F8F8F8; /* $sidebg; */
                   4900:  border-bottom: 1px solid $lg_border_color;
                   4901:  margin: 0 0 10px 0;
                   4902:  padding: 5px;
                   4903: }
                   4904: 
1.795     www      4905: .LC_fontsize_medium {
1.705     tempelho 4906:  font-size: 85%;
                   4907: }
                   4908: 
1.795     www      4909: .LC_fontsize_large {
1.705     tempelho 4910:  font-size: 120%;
                   4911: }
                   4912: 
1.346     albertel 4913: .LC_menubuttons_inline_text {
                   4914:   color: $font;
1.698     harmsja  4915:   font-size: 90%;
1.701     harmsja  4916:   padding-left:3px;
1.346     albertel 4917: }
                   4918: 
1.526     www      4919: .LC_menubuttons_link {
                   4920:   text-decoration: none;
                   4921: }
1.795     www      4922: 
1.522     albertel 4923: .LC_menubuttons_category {
1.521     www      4924:   color: $font;
1.526     www      4925:   background: $pgbg;
1.521     www      4926:   font-size: larger;
                   4927:   font-weight: bold;
                   4928: }
                   4929: 
1.346     albertel 4930: td.LC_menubuttons_text {
1.779     bisitz   4931:  	color: $font;
1.346     albertel 4932: }
1.706     harmsja  4933: 
1.346     albertel 4934: .LC_current_location {
                   4935:   background: $tabbg;
                   4936: }
1.795     www      4937: 
1.346     albertel 4938: .LC_new_mail {
1.634     www      4939:   background: $tabbg;
1.346     albertel 4940:   font-weight: bold;
                   4941: }
1.347     albertel 4942: 
1.795     www      4943: table.LC_data_table,
                   4944: table.LC_mail_list {
1.347     albertel 4945:   border: 1px solid #000000;
1.402     albertel 4946:   border-collapse: separate;
1.426     albertel 4947:   border-spacing: 1px;
1.610     albertel 4948:   background: $pgbg;
1.347     albertel 4949: }
1.795     www      4950: 
1.422     albertel 4951: .LC_data_table_dense {
                   4952:   font-size: small;
                   4953: }
1.795     www      4954: 
1.507     raeburn  4955: table.LC_nested_outer {
                   4956:   border: 1px solid #000000;
1.589     raeburn  4957:   border-collapse: collapse;
1.803     bisitz   4958:   border-spacing: 0;
1.507     raeburn  4959:   width: 100%;
                   4960: }
1.795     www      4961: 
1.879     raeburn  4962: table.LC_innerpickbox,
1.507     raeburn  4963: table.LC_nested {
1.803     bisitz   4964:   border: none;
1.589     raeburn  4965:   border-collapse: collapse;
1.803     bisitz   4966:   border-spacing: 0;
1.507     raeburn  4967:   width: 100%;
                   4968: }
1.795     www      4969: 
                   4970: table.LC_data_table tr th, 
                   4971: table.LC_calendar tr th, 
                   4972: table.LC_mail_list tr th,
1.879     raeburn  4973: table.LC_prior_tries tr th,
                   4974: table.LC_innerpickbox tr th {
1.349     albertel 4975:   font-weight: bold;
                   4976:   background-color: $data_table_head;
1.801     tempelho 4977:   color:$fontmenu;
1.701     harmsja  4978:   font-size:90%;
1.347     albertel 4979: }
1.795     www      4980: 
1.879     raeburn  4981: table.LC_innerpickbox tr th,
                   4982: table.LC_innerpickbox tr td {
                   4983:   vertical-align: top;
                   4984: }
                   4985: 
1.711     raeburn  4986: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4987:   background-color: #CCCCCC;
1.711     raeburn  4988:   font-weight: bold;
                   4989:   text-align: left;
                   4990: }
1.795     www      4991: 
1.779     bisitz   4992: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4993: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4994:   background-color: $data_table_light;
1.425     albertel 4995:   padding: 2px;
1.900     bisitz   4996:   vertical-align: top;
1.347     albertel 4997: }
1.795     www      4998: 
1.610     albertel 4999: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   5000: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5001:   background-color: $data_table_dark;
1.709     bisitz   5002:   padding: 2px;
1.900     bisitz   5003:   vertical-align: top;
1.347     albertel 5004: }
1.795     www      5005: 
1.425     albertel 5006: table.LC_data_table tr.LC_data_table_highlight td {
                   5007:   background-color: $data_table_darker;
                   5008: }
1.795     www      5009: 
1.639     raeburn  5010: table.LC_data_table tr td.LC_leftcol_header {
                   5011:   background-color: $data_table_head;
                   5012:   font-weight: bold;
                   5013: }
1.795     www      5014: 
1.451     albertel 5015: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5016: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5017:   background-color: #FFFFFF;
1.421     albertel 5018:   font-weight: bold;
                   5019:   font-style: italic;
                   5020:   text-align: center;
                   5021:   padding: 8px;
1.347     albertel 5022: }
1.795     www      5023: 
1.890     droeschl 5024: table.LC_caption {
                   5025: }
                   5026: 
1.507     raeburn  5027: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5028:   padding: 4ex
                   5029: }
1.795     www      5030: 
1.507     raeburn  5031: table.LC_nested_outer tr th {
                   5032:   font-weight: bold;
1.801     tempelho 5033:   color:$fontmenu;
1.507     raeburn  5034:   background-color: $data_table_head;
1.701     harmsja  5035:   font-size: small;
1.507     raeburn  5036:   border-bottom: 1px solid #000000;
                   5037: }
1.795     www      5038: 
1.507     raeburn  5039: table.LC_nested_outer tr td.LC_subheader {
                   5040:   background-color: $data_table_head;
                   5041:   font-weight: bold;
                   5042:   font-size: small;
                   5043:   border-bottom: 1px solid #000000;
                   5044:   text-align: right;
1.451     albertel 5045: }
1.795     www      5046: 
1.507     raeburn  5047: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5048:   background-color: #CCCCCC;
1.451     albertel 5049:   font-weight: bold;
                   5050:   font-size: small;
1.507     raeburn  5051:   text-align: center;
                   5052: }
1.795     www      5053: 
1.589     raeburn  5054: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5055: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5056:   text-align: left;
1.451     albertel 5057: }
1.795     www      5058: 
1.507     raeburn  5059: table.LC_nested td {
1.735     bisitz   5060:   background-color: #FFFFFF;
1.451     albertel 5061:   font-size: small;
1.507     raeburn  5062: }
1.795     www      5063: 
1.507     raeburn  5064: table.LC_nested_outer tr th.LC_right_item,
                   5065: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5066: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5067: table.LC_nested tr td.LC_right_item {
1.451     albertel 5068:   text-align: right;
                   5069: }
                   5070: 
1.507     raeburn  5071: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5072:   background-color: #EEEEEE;
1.451     albertel 5073: }
                   5074: 
1.473     raeburn  5075: table.LC_createuser {
                   5076: }
                   5077: 
                   5078: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5079:   font-size: small;
1.473     raeburn  5080: }
                   5081: 
                   5082: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5083:   background-color: #CCCCCC;
1.473     raeburn  5084:   font-weight: bold;
                   5085:   text-align: center;
                   5086: }
                   5087: 
1.349     albertel 5088: table.LC_calendar {
                   5089:   border: 1px solid #000000;
                   5090:   border-collapse: collapse;
                   5091: }
1.795     www      5092: 
1.349     albertel 5093: table.LC_calendar_pickdate {
                   5094:   font-size: xx-small;
                   5095: }
1.795     www      5096: 
1.349     albertel 5097: table.LC_calendar tr td {
                   5098:   border: 1px solid #000000;
                   5099:   vertical-align: top;
                   5100: }
1.795     www      5101: 
1.349     albertel 5102: table.LC_calendar tr td.LC_calendar_day_empty {
                   5103:   background-color: $data_table_dark;
                   5104: }
1.795     www      5105: 
1.779     bisitz   5106: table.LC_calendar tr td.LC_calendar_day_current {
                   5107:   background-color: $data_table_highlight;
1.777     tempelho 5108: }
1.795     www      5109: 
1.349     albertel 5110: table.LC_mail_list tr.LC_mail_new {
                   5111:   background-color: $mail_new;
                   5112: }
1.795     www      5113: 
1.349     albertel 5114: table.LC_mail_list tr.LC_mail_new:hover {
                   5115:   background-color: $mail_new_hover;
                   5116: }
1.795     www      5117: 
                   5118: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5119: }
1.795     www      5120: 
                   5121: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5122: }
1.795     www      5123: 
1.349     albertel 5124: table.LC_mail_list tr.LC_mail_read {
                   5125:   background-color: $mail_read;
                   5126: }
1.795     www      5127: 
1.349     albertel 5128: table.LC_mail_list tr.LC_mail_read:hover {
                   5129:   background-color: $mail_read_hover;
                   5130: }
1.795     www      5131: 
1.349     albertel 5132: table.LC_mail_list tr.LC_mail_replied {
                   5133:   background-color: $mail_replied;
                   5134: }
1.795     www      5135: 
1.349     albertel 5136: table.LC_mail_list tr.LC_mail_replied:hover {
                   5137:   background-color: $mail_replied_hover;
                   5138: }
1.795     www      5139: 
1.349     albertel 5140: table.LC_mail_list tr.LC_mail_other {
                   5141:   background-color: $mail_other;
                   5142: }
1.795     www      5143: 
1.349     albertel 5144: table.LC_mail_list tr.LC_mail_other:hover {
                   5145:   background-color: $mail_other_hover;
                   5146: }
1.494     raeburn  5147: 
1.777     tempelho 5148: table.LC_data_table tr > td.LC_browser_file,
                   5149: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5150:   background: #AAEE77;
1.389     albertel 5151: }
1.795     www      5152: 
1.777     tempelho 5153: table.LC_data_table tr > td.LC_browser_file_locked,
                   5154: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5155:   background: #FFAA99;
1.387     albertel 5156: }
1.795     www      5157: 
1.777     tempelho 5158: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5159:   background: #888888;
1.779     bisitz   5160: }
1.795     www      5161: 
1.777     tempelho 5162: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5163: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5164:   background: #F8F866;
1.777     tempelho 5165: }
1.795     www      5166: 
1.696     bisitz   5167: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5168:   background: #E0E8FF;
1.387     albertel 5169: }
1.696     bisitz   5170: 
1.707     bisitz   5171: table.LC_data_table tr > td.LC_roles_is {
                   5172: /*  background: #77FF77; */
                   5173: }
1.795     www      5174: 
1.707     bisitz   5175: table.LC_data_table tr > td.LC_roles_future {
                   5176:   background: #FFFF77;
                   5177: }
1.795     www      5178: 
1.707     bisitz   5179: table.LC_data_table tr > td.LC_roles_will {
                   5180:   background: #FFAA77;
                   5181: }
1.795     www      5182: 
1.707     bisitz   5183: table.LC_data_table tr > td.LC_roles_expired {
                   5184:   background: #FF7777;
                   5185: }
1.795     www      5186: 
1.707     bisitz   5187: table.LC_data_table tr > td.LC_roles_will_not {
                   5188:   background: #AAFF77;
                   5189: }
1.795     www      5190: 
1.707     bisitz   5191: table.LC_data_table tr > td.LC_roles_selected {
                   5192:   background: #11CC55;
                   5193: }
                   5194: 
1.388     albertel 5195: span.LC_current_location {
1.701     harmsja  5196:   font-size:larger;
1.388     albertel 5197:   background: $pgbg;
                   5198: }
1.387     albertel 5199: 
1.395     albertel 5200: span.LC_parm_menu_item {
                   5201:   font-size: larger;
                   5202: }
1.795     www      5203: 
1.395     albertel 5204: span.LC_parm_scope_all {
                   5205:   color: red;
                   5206: }
1.795     www      5207: 
1.395     albertel 5208: span.LC_parm_scope_folder {
                   5209:   color: green;
                   5210: }
1.795     www      5211: 
1.395     albertel 5212: span.LC_parm_scope_resource {
                   5213:   color: orange;
                   5214: }
1.795     www      5215: 
1.395     albertel 5216: span.LC_parm_part {
                   5217:   color: blue;
                   5218: }
1.795     www      5219: 
1.395     albertel 5220: span.LC_parm_folder, span.LC_parm_symb {
                   5221:   font-size: x-small;
                   5222:   font-family: $mono;
                   5223:   color: #AAAAAA;
                   5224: }
                   5225: 
1.795     www      5226: td.LC_parm_overview_level_menu,
                   5227: td.LC_parm_overview_map_menu,
                   5228: td.LC_parm_overview_parm_selectors,
                   5229: td.LC_parm_overview_restrictions  {
1.396     albertel 5230:   border: 1px solid black;
                   5231:   border-collapse: collapse;
                   5232: }
1.795     www      5233: 
1.396     albertel 5234: table.LC_parm_overview_restrictions td {
                   5235:   border-width: 1px 4px 1px 4px;
                   5236:   border-style: solid;
                   5237:   border-color: $pgbg;
                   5238:   text-align: center;
                   5239: }
1.795     www      5240: 
1.396     albertel 5241: table.LC_parm_overview_restrictions th {
                   5242:   background: $tabbg;
                   5243:   border-width: 1px 4px 1px 4px;
                   5244:   border-style: solid;
                   5245:   border-color: $pgbg;
                   5246: }
1.795     www      5247: 
1.398     albertel 5248: table#LC_helpmenu {
1.803     bisitz   5249:   border: none;
1.398     albertel 5250:   height: 55px;
1.803     bisitz   5251:   border-spacing: 0;
1.398     albertel 5252: }
                   5253: 
                   5254: table#LC_helpmenu fieldset legend {
                   5255:   font-size: larger;
                   5256: }
1.795     www      5257: 
1.397     albertel 5258: table#LC_helpmenu_links {
                   5259:   width: 100%;
                   5260:   border: 1px solid black;
                   5261:   background: $pgbg;
1.803     bisitz   5262:   padding: 0;
1.397     albertel 5263:   border-spacing: 1px;
                   5264: }
1.795     www      5265: 
1.397     albertel 5266: table#LC_helpmenu_links tr td {
                   5267:   padding: 1px;
                   5268:   background: $tabbg;
1.399     albertel 5269:   text-align: center;
                   5270:   font-weight: bold;
1.397     albertel 5271: }
1.396     albertel 5272: 
1.795     www      5273: table#LC_helpmenu_links a:link,
                   5274: table#LC_helpmenu_links a:visited,
1.397     albertel 5275: table#LC_helpmenu_links a:active {
                   5276:   text-decoration: none;
                   5277:   color: $font;
                   5278: }
1.795     www      5279: 
1.397     albertel 5280: table#LC_helpmenu_links a:hover {
                   5281:   text-decoration: underline;
                   5282:   color: $vlink;
                   5283: }
1.396     albertel 5284: 
1.417     albertel 5285: .LC_chrt_popup_exists {
                   5286:   border: 1px solid #339933;
                   5287:   margin: -1px;
                   5288: }
1.795     www      5289: 
1.417     albertel 5290: .LC_chrt_popup_up {
                   5291:   border: 1px solid yellow;
                   5292:   margin: -1px;
                   5293: }
1.795     www      5294: 
1.417     albertel 5295: .LC_chrt_popup {
                   5296:   border: 1px solid #8888FF;
                   5297:   background: #CCCCFF;
                   5298: }
1.795     www      5299: 
1.421     albertel 5300: table.LC_pick_box {
                   5301:   border-collapse: separate;
                   5302:   background: white;
                   5303:   border: 1px solid black;
                   5304:   border-spacing: 1px;
                   5305: }
1.795     www      5306: 
1.421     albertel 5307: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5308:   background: $sidebg;
1.421     albertel 5309:   font-weight: bold;
1.900     bisitz   5310:   text-align: left;
1.740     bisitz   5311:   vertical-align: top;
1.421     albertel 5312:   width: 184px;
                   5313:   padding: 8px;
                   5314: }
1.795     www      5315: 
1.579     raeburn  5316: table.LC_pick_box td.LC_pick_box_value {
                   5317:   text-align: left;
                   5318:   padding: 8px;
                   5319: }
1.795     www      5320: 
1.579     raeburn  5321: table.LC_pick_box td.LC_pick_box_select {
                   5322:   text-align: left;
                   5323:   padding: 8px;
                   5324: }
1.795     www      5325: 
1.424     albertel 5326: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5327:   padding: 0;
1.421     albertel 5328:   height: 1px;
                   5329:   background: black;
                   5330: }
1.795     www      5331: 
1.421     albertel 5332: table.LC_pick_box td.LC_pick_box_submit {
                   5333:   text-align: right;
                   5334: }
1.795     www      5335: 
1.579     raeburn  5336: table.LC_pick_box td.LC_evenrow_value {
                   5337:   text-align: left;
                   5338:   padding: 8px;
                   5339:   background-color: $data_table_light;
                   5340: }
1.795     www      5341: 
1.579     raeburn  5342: table.LC_pick_box td.LC_oddrow_value {
                   5343:   text-align: left;
                   5344:   padding: 8px;
                   5345:   background-color: $data_table_light;
                   5346: }
1.795     www      5347: 
1.579     raeburn  5348: span.LC_helpform_receipt_cat {
                   5349:   font-weight: bold;
                   5350: }
1.795     www      5351: 
1.424     albertel 5352: table.LC_group_priv_box {
                   5353:   background: white;
                   5354:   border: 1px solid black;
                   5355:   border-spacing: 1px;
                   5356: }
1.795     www      5357: 
1.424     albertel 5358: table.LC_group_priv_box td.LC_pick_box_title {
                   5359:   background: $tabbg;
                   5360:   font-weight: bold;
                   5361:   text-align: right;
                   5362:   width: 184px;
                   5363: }
1.795     www      5364: 
1.424     albertel 5365: table.LC_group_priv_box td.LC_groups_fixed {
                   5366:   background: $data_table_light;
                   5367:   text-align: center;
                   5368: }
1.795     www      5369: 
1.424     albertel 5370: table.LC_group_priv_box td.LC_groups_optional {
                   5371:   background: $data_table_dark;
                   5372:   text-align: center;
                   5373: }
1.795     www      5374: 
1.424     albertel 5375: table.LC_group_priv_box td.LC_groups_functionality {
                   5376:   background: $data_table_darker;
                   5377:   text-align: center;
                   5378:   font-weight: bold;
                   5379: }
1.795     www      5380: 
1.424     albertel 5381: table.LC_group_priv td {
                   5382:   text-align: left;
1.803     bisitz   5383:   padding: 0;
1.424     albertel 5384: }
                   5385: 
1.421     albertel 5386: table.LC_notify_front_page {
                   5387:   background: white;
                   5388:   border: 1px solid black;
                   5389:   padding: 8px;
                   5390: }
1.795     www      5391: 
1.421     albertel 5392: table.LC_notify_front_page td {
                   5393:   padding: 8px;
                   5394: }
1.795     www      5395: 
1.424     albertel 5396: .LC_navbuttons {
                   5397:   margin: 2ex 0ex 2ex 0ex;
                   5398: }
1.795     www      5399: 
1.423     albertel 5400: .LC_topic_bar {
                   5401:   font-weight: bold;
                   5402:   width: 100%;
                   5403:   background: $tabbg;
                   5404:   vertical-align: middle;
                   5405:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5406:   padding: 3px;
1.423     albertel 5407: }
1.795     www      5408: 
1.423     albertel 5409: .LC_topic_bar span {
                   5410:   vertical-align: middle;
                   5411: }
1.795     www      5412: 
1.423     albertel 5413: .LC_topic_bar img {
                   5414:   vertical-align: bottom;
                   5415: }
1.795     www      5416: 
1.423     albertel 5417: table.LC_course_group_status {
                   5418:   margin: 20px;
                   5419: }
1.795     www      5420: 
1.423     albertel 5421: table.LC_status_selector td {
                   5422:   vertical-align: top;
                   5423:   text-align: center;
1.424     albertel 5424:   padding: 4px;
                   5425: }
1.795     www      5426: 
1.599     albertel 5427: div.LC_feedback_link {
1.616     albertel 5428:   clear: both;
1.829     kalberla 5429:   background: $sidebg;
1.779     bisitz   5430:   width: 100%;
1.829     kalberla 5431:   padding-bottom: 10px;
                   5432:   border: 1px $tabbg solid;
1.833     kalberla 5433:   height: 22px;
                   5434:   line-height: 22px;
                   5435:   padding-top: 5px;
                   5436: }
                   5437: 
                   5438: div.LC_feedback_link img {
                   5439:   height: 22px;
1.867     kalberla 5440:   vertical-align:middle;
1.829     kalberla 5441: }
                   5442: 
                   5443: div.LC_feedback_link a{
                   5444:   text-decoration: none;
1.489     raeburn  5445: }
1.795     www      5446: 
1.867     kalberla 5447: div.LC_comblock {
                   5448:   display:inline; 
                   5449:   color:$font;
                   5450:   font-size:90%;
                   5451: }
                   5452: 
                   5453: div.LC_feedback_link div.LC_comblock {
                   5454:   padding-left:5px;
                   5455: }
                   5456: 
                   5457: div.LC_feedback_link div.LC_comblock a {
                   5458:   color:$font;
                   5459: }
                   5460: 
1.489     raeburn  5461: span.LC_feedback_link {
1.858     bisitz   5462:   /* background: $feedback_link_bg; */
1.599     albertel 5463:   font-size: larger;
                   5464: }
1.795     www      5465: 
1.599     albertel 5466: span.LC_message_link {
1.858     bisitz   5467:   /* background: $feedback_link_bg; */
1.599     albertel 5468:   font-size: larger;
                   5469:   position: absolute;
                   5470:   right: 1em;
1.489     raeburn  5471: }
1.421     albertel 5472: 
1.515     albertel 5473: table.LC_prior_tries {
1.524     albertel 5474:   border: 1px solid #000000;
                   5475:   border-collapse: separate;
                   5476:   border-spacing: 1px;
1.515     albertel 5477: }
1.523     albertel 5478: 
1.515     albertel 5479: table.LC_prior_tries td {
1.524     albertel 5480:   padding: 2px;
1.515     albertel 5481: }
1.523     albertel 5482: 
                   5483: .LC_answer_correct {
1.795     www      5484:   background: lightgreen;
                   5485:   color: darkgreen;
                   5486:   padding: 6px;
1.523     albertel 5487: }
1.795     www      5488: 
1.523     albertel 5489: .LC_answer_charged_try {
1.797     www      5490:   background: #FFAAAA;
1.795     www      5491:   color: darkred;
                   5492:   padding: 6px;
1.523     albertel 5493: }
1.795     www      5494: 
1.779     bisitz   5495: .LC_answer_not_charged_try,
1.523     albertel 5496: .LC_answer_no_grade,
                   5497: .LC_answer_late {
1.795     www      5498:   background: lightyellow;
1.523     albertel 5499:   color: black;
1.795     www      5500:   padding: 6px;
1.523     albertel 5501: }
1.795     www      5502: 
1.523     albertel 5503: .LC_answer_previous {
1.795     www      5504:   background: lightblue;
                   5505:   color: darkblue;
                   5506:   padding: 6px;
1.523     albertel 5507: }
1.795     www      5508: 
1.779     bisitz   5509: .LC_answer_no_message {
1.777     tempelho 5510:   background: #FFFFFF;
                   5511:   color: black;
1.795     www      5512:   padding: 6px;
1.779     bisitz   5513: }
1.795     www      5514: 
1.779     bisitz   5515: .LC_answer_unknown {
                   5516:   background: orange;
                   5517:   color: black;
1.795     www      5518:   padding: 6px;
1.777     tempelho 5519: }
1.795     www      5520: 
1.529     albertel 5521: span.LC_prior_numerical,
                   5522: span.LC_prior_string,
                   5523: span.LC_prior_custom,
                   5524: span.LC_prior_reaction,
                   5525: span.LC_prior_math {
1.523     albertel 5526:   font-family: monospace;
                   5527:   white-space: pre;
                   5528: }
                   5529: 
1.525     albertel 5530: span.LC_prior_string {
                   5531:   font-family: monospace;
                   5532:   white-space: pre;
                   5533: }
                   5534: 
1.523     albertel 5535: table.LC_prior_option {
                   5536:   width: 100%;
                   5537:   border-collapse: collapse;
                   5538: }
1.795     www      5539: 
                   5540: table.LC_prior_rank, 
                   5541: table.LC_prior_match {
1.528     albertel 5542:   border-collapse: collapse;
                   5543: }
1.795     www      5544: 
1.528     albertel 5545: table.LC_prior_option tr td,
                   5546: table.LC_prior_rank tr td,
                   5547: table.LC_prior_match tr td {
1.524     albertel 5548:   border: 1px solid #000000;
1.515     albertel 5549: }
                   5550: 
1.855     bisitz   5551: .LC_nobreak {
1.544     albertel 5552:   white-space: nowrap;
1.519     raeburn  5553: }
                   5554: 
1.576     raeburn  5555: span.LC_cusr_emph {
                   5556:   font-style: italic;
                   5557: }
                   5558: 
1.633     raeburn  5559: span.LC_cusr_subheading {
                   5560:   font-weight: normal;
                   5561:   font-size: 85%;
                   5562: }
                   5563: 
1.545     albertel 5564: table.LC_docs_documents {
                   5565:   background: #BBBBBB;
1.803     bisitz   5566:   border-width: 0;
1.545     albertel 5567:   border-collapse: collapse;
                   5568: }
1.795     www      5569: 
1.777     tempelho 5570: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5571:   border: 2px solid black;
                   5572:   padding: 4px;
1.777     tempelho 5573: }
1.795     www      5574: 
1.861     bisitz   5575: div.LC_docs_entry_move {
1.859     bisitz   5576:   border: 1px solid #BBBBBB;
1.545     albertel 5577:   background: #DDDDDD;
1.861     bisitz   5578:   width: 22px;
1.859     bisitz   5579:   padding: 1px;
                   5580:   margin: 0;
1.545     albertel 5581: }
                   5582: 
1.861     bisitz   5583: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5584: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5585:   background: #DDDDDD;
                   5586:   font-size: x-small;
                   5587: }
1.795     www      5588: 
1.861     bisitz   5589: .LC_docs_entry_parameter {
                   5590:   white-space: nowrap;
                   5591: }
                   5592: 
1.544     albertel 5593: .LC_docs_copy {
1.545     albertel 5594:   color: #000099;
1.544     albertel 5595: }
1.795     www      5596: 
1.544     albertel 5597: .LC_docs_cut {
1.545     albertel 5598:   color: #550044;
1.544     albertel 5599: }
1.795     www      5600: 
1.544     albertel 5601: .LC_docs_rename {
1.545     albertel 5602:   color: #009900;
1.544     albertel 5603: }
1.795     www      5604: 
1.544     albertel 5605: .LC_docs_remove {
1.545     albertel 5606:   color: #990000;
                   5607: }
                   5608: 
1.547     albertel 5609: .LC_docs_reinit_warn,
                   5610: .LC_docs_ext_edit {
                   5611:   font-size: x-small;
                   5612: }
                   5613: 
1.545     albertel 5614: table.LC_docs_adddocs td,
                   5615: table.LC_docs_adddocs th {
                   5616:   border: 1px solid #BBBBBB;
                   5617:   padding: 4px;
                   5618:   background: #DDDDDD;
1.543     albertel 5619: }
                   5620: 
1.584     albertel 5621: table.LC_sty_begin {
                   5622:   background: #BBFFBB;
                   5623: }
1.795     www      5624: 
1.584     albertel 5625: table.LC_sty_end {
                   5626:   background: #FFBBBB;
                   5627: }
                   5628: 
1.589     raeburn  5629: table.LC_double_column {
1.803     bisitz   5630:   border-width: 0;
1.589     raeburn  5631:   border-collapse: collapse;
                   5632:   width: 100%;
                   5633:   padding: 2px;
                   5634: }
                   5635: 
                   5636: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5637:   top: 2px;
1.589     raeburn  5638:   left: 2px;
                   5639:   width: 47%;
                   5640:   vertical-align: top;
                   5641: }
                   5642: 
                   5643: table.LC_double_column tr td.LC_right_col {
                   5644:   top: 2px;
1.779     bisitz   5645:   right: 2px;
1.589     raeburn  5646:   width: 47%;
                   5647:   vertical-align: top;
                   5648: }
                   5649: 
1.591     raeburn  5650: div.LC_left_float {
                   5651:   float: left;
                   5652:   padding-right: 5%;
1.597     albertel 5653:   padding-bottom: 4px;
1.591     raeburn  5654: }
                   5655: 
                   5656: div.LC_clear_float_header {
1.597     albertel 5657:   padding-bottom: 2px;
1.591     raeburn  5658: }
                   5659: 
                   5660: div.LC_clear_float_footer {
1.597     albertel 5661:   padding-top: 10px;
1.591     raeburn  5662:   clear: both;
                   5663: }
                   5664: 
1.597     albertel 5665: div.LC_grade_show_user {
                   5666:   margin-top: 20px;
                   5667:   border: 1px solid black;
                   5668: }
1.795     www      5669: 
1.597     albertel 5670: div.LC_grade_user_name {
                   5671:   background: #DDDDEE;
                   5672:   border-bottom: 1px solid black;
1.705     tempelho 5673:   font-weight: bold;
                   5674:   font-size: large;
1.597     albertel 5675: }
1.795     www      5676: 
1.597     albertel 5677: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5678:   background: #DDEEDD;
                   5679: }
                   5680: 
                   5681: div.LC_grade_show_problem,
                   5682: div.LC_grade_submissions,
                   5683: div.LC_grade_message_center,
                   5684: div.LC_grade_info_links,
                   5685: div.LC_grade_assign {
                   5686:   margin: 5px;
                   5687:   width: 99%;
                   5688:   background: #FFFFFF;
                   5689: }
1.795     www      5690: 
1.597     albertel 5691: div.LC_grade_show_problem_header,
                   5692: div.LC_grade_submissions_header,
                   5693: div.LC_grade_message_center_header,
                   5694: div.LC_grade_assign_header {
1.705     tempelho 5695:   font-weight: bold;
                   5696:   font-size: large;
1.597     albertel 5697: }
1.795     www      5698: 
1.597     albertel 5699: div.LC_grade_show_problem_problem,
                   5700: div.LC_grade_submissions_body,
                   5701: div.LC_grade_message_center_body,
                   5702: div.LC_grade_assign_body {
                   5703:   border: 1px solid black;
                   5704:   width: 99%;
                   5705:   background: #FFFFFF;
                   5706: }
1.795     www      5707: 
1.598     albertel 5708: span.LC_grade_check_note {
1.705     tempelho 5709:   font-weight: normal;
                   5710:   font-size: medium;
1.598     albertel 5711:   display: inline;
                   5712:   position: absolute;
                   5713:   right: 1em;
                   5714: }
1.597     albertel 5715: 
1.613     albertel 5716: table.LC_scantron_action {
                   5717:   width: 100%;
                   5718: }
1.795     www      5719: 
1.613     albertel 5720: table.LC_scantron_action tr th {
1.698     harmsja  5721:   font-weight:bold;
                   5722:   font-style:normal;
1.613     albertel 5723: }
1.795     www      5724: 
1.779     bisitz   5725: .LC_edit_problem_header,
1.614     albertel 5726: div.LC_edit_problem_footer {
1.705     tempelho 5727:   font-weight: normal;
                   5728:   font-size:  medium;
1.602     albertel 5729:   margin: 2px;
1.600     albertel 5730: }
1.795     www      5731: 
1.600     albertel 5732: div.LC_edit_problem_header,
1.602     albertel 5733: div.LC_edit_problem_header div,
1.614     albertel 5734: div.LC_edit_problem_footer,
                   5735: div.LC_edit_problem_footer div,
1.602     albertel 5736: div.LC_edit_problem_editxml_header,
                   5737: div.LC_edit_problem_editxml_header div {
1.600     albertel 5738:   margin-top: 5px;
                   5739: }
1.795     www      5740: 
1.600     albertel 5741: div.LC_edit_problem_header_title {
1.705     tempelho 5742:   font-weight: bold;
                   5743:   font-size: larger;
1.602     albertel 5744:   background: $tabbg;
                   5745:   padding: 3px;
                   5746: }
1.795     www      5747: 
1.602     albertel 5748: table.LC_edit_problem_header_title {
1.705     tempelho 5749:   font-size: larger;
                   5750:   font-weight:  bold;
1.602     albertel 5751:   width: 100%;
                   5752:   border-color: $pgbg;
                   5753:   border-style: solid;
                   5754:   border-width: $border;
1.600     albertel 5755:   background: $tabbg;
1.602     albertel 5756:   border-collapse: collapse;
1.803     bisitz   5757:   padding: 0;
1.602     albertel 5758: }
                   5759: 
                   5760: div.LC_edit_problem_discards {
                   5761:   float: left;
                   5762:   padding-bottom: 5px;
                   5763: }
1.795     www      5764: 
1.602     albertel 5765: div.LC_edit_problem_saves {
                   5766:   float: right;
                   5767:   padding-bottom: 5px;
1.600     albertel 5768: }
1.795     www      5769: 
1.679     riegler  5770: img.stift{
1.803     bisitz   5771:   border-width: 0;
                   5772:   vertical-align: middle;
1.677     riegler  5773: }
1.680     riegler  5774: 
1.681     riegler  5775: table#LC_mainmenu{
                   5776:  margin-top:10px;
                   5777:  width:80%;
                   5778: }
                   5779: 
1.680     riegler  5780: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5781:   vertical-align: top;
                   5782:   width: 45%;
                   5783: }
1.795     www      5784: 
1.779     bisitz   5785: .LC_mainmenu_fieldset_category {
                   5786:   color: $font;
                   5787:   background: $pgbg;
                   5788:   font-size: small;
                   5789:   font-weight: bold;
1.777     tempelho 5790: }
1.795     www      5791: 
1.716     raeburn  5792: div.LC_createcourse {
                   5793:     margin: 10px 10px 10px 10px;
                   5794: }
                   5795: 
1.693     droeschl 5796: /* ---- Remove when done ----
                   5797: # The following styles is part of the redesign of LON-CAPA and are
                   5798: # subject to change during this project.
                   5799: # Don't rely on their current functionality as they might be 
                   5800: # changed or removed.
                   5801: # --------------------------*/
                   5802: 
1.698     harmsja  5803: a:hover,
1.897     wenzelju 5804: ol.LC_primary_menu a:hover,
1.721     harmsja  5805: ol#LC_MenuBreadcrumbs a:hover,
                   5806: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5807: ul#LC_secondary_menu a:hover,
1.721     harmsja  5808: .LC_FormSectionClearButton input:hover
1.795     www      5809: ul.LC_TabContent   li:hover a {
1.698     harmsja  5810: 	color:#BF2317;
                   5811:         text-decoration:none;
1.693     droeschl 5812: }
                   5813: 
1.779     bisitz   5814: h1 {
1.813     bisitz   5815: 	padding: 0;
1.693     droeschl 5816: 	line-height:130%;
                   5817: }
1.698     harmsja  5818: 
1.795     www      5819: h2,h3,h4,h5,h6 {
1.803     bisitz   5820: 	margin: 5px 0 5px 0;
                   5821: 	padding: 0;
1.721     harmsja  5822: 	line-height:130%;
1.693     droeschl 5823: }
1.795     www      5824: 
                   5825: .LC_hcell {
1.698     harmsja  5826:         padding:3px 15px 3px 15px;
1.803     bisitz   5827:         margin: 0;
1.703     harmsja  5828: 	background-color:$tabbg;
1.801     tempelho 5829: 	color:$fontmenu;
1.779     bisitz   5830: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5831: }
1.795     www      5832: 
1.840     bisitz   5833: .LC_Box > .LC_hcell {
1.847     tempelho 5834:     margin: 0 -10px 10px -10px;
1.835     bisitz   5835: }
                   5836: 
1.721     harmsja  5837: .LC_noBorder {
1.803     bisitz   5838:         border: 0;
1.698     harmsja  5839: }
1.693     droeschl 5840: 
1.761     tempelho 5841: .LC_Right {
                   5842:         float: right;
1.803     bisitz   5843:         margin: 0;
                   5844:         padding: 0;
1.761     tempelho 5845: }
                   5846: 
1.721     harmsja  5847: .LC_FormSectionClearButton input {
1.779     bisitz   5848:         background-color:transparent;
1.803     bisitz   5849:         border: none;
1.698     harmsja  5850:         cursor:pointer;
                   5851:         text-decoration:underline;
1.693     droeschl 5852: }
1.763     bisitz   5853: 
                   5854: .LC_help_open_topic {
                   5855:         color: #FFFFFF;
                   5856:         background-color: #EEEEFF;
                   5857:         margin: 1px;
                   5858:         padding: 4px;
                   5859:         border: 1px solid #000033;
                   5860:         white-space: nowrap;
1.783     amueller 5861: /*		vertical-align: middle; */
1.759     neumanie 5862: }
1.693     droeschl 5863: 
1.698     harmsja  5864: dl,ul,div,fieldset {
1.803     bisitz   5865: 	margin: 10px 10px 10px 0;
1.806     bisitz   5866: /*	overflow: hidden; */
1.693     droeschl 5867: }
1.795     www      5868: 
1.838     bisitz   5869: fieldset > legend {
                   5870:     font-weight: bold;
                   5871:     padding: 0 5px 0 5px;
                   5872: }
                   5873: 
1.813     bisitz   5874: #LC_nav_bar {
1.807     droeschl 5875:     float: left;
1.852     droeschl 5876:     margin: 0.2em 0 0 0;
1.807     droeschl 5877: }
                   5878: 
1.813     bisitz   5879: #LC_nav_bar em{
1.807     droeschl 5880:     font-weight: bold;
                   5881:     font-style: normal;
                   5882: }
                   5883: 
1.897     wenzelju 5884: ol.LC_primary_menu {
1.807     droeschl 5885:     float: right;
1.852     droeschl 5886:     margin: 0.2em 0 0 0;
1.807     droeschl 5887: }
                   5888: 
1.852     droeschl 5889: ol#LC_PathBreadcrumbs {
1.803     bisitz   5890: 	margin: 0;
1.693     droeschl 5891: }
                   5892: 
1.897     wenzelju 5893: ol.LC_primary_menu li {
1.693     droeschl 5894: 	display: inline;
1.803     bisitz   5895: 	padding: 5px 5px 0 10px;
1.693     droeschl 5896: 	vertical-align: top;
                   5897: }
                   5898: 
1.897     wenzelju 5899: ol.LC_primary_menu li img {
1.693     droeschl 5900: 	vertical-align: bottom;
                   5901: }
                   5902: 
1.897     wenzelju 5903: ol.LC_primary_menu a {
1.693     droeschl 5904: 	font-size: 90%;
                   5905: 	color: RGB(80, 80, 80);
                   5906: 	text-decoration: none;
                   5907: }
1.795     www      5908: 
1.897     wenzelju 5909: ul#LC_secondary_menu {
1.807     droeschl 5910:     clear: both;
1.808     droeschl 5911:     color: $fontmenu;
                   5912:     background: $tabbg;
                   5913:     list-style: none;
                   5914:     padding: 0;
                   5915:     margin: 0;
                   5916:     width: 100%;
                   5917: }
                   5918: 
1.897     wenzelju 5919: ul#LC_secondary_menu li {
1.808     droeschl 5920:     font-weight: bold;
                   5921:     line-height: 1.8em;
                   5922:     padding: 0 0.8em; 
                   5923:     border-right: 1px solid black;
                   5924:     display: inline;
                   5925:     vertical-align: middle;
1.807     droeschl 5926: }
                   5927: 
1.847     tempelho 5928: ul.LC_TabContent {
1.721     harmsja  5929: 	display:block;
1.847     tempelho 5930: 	background: $sidebg;
1.858     bisitz   5931: 	border-bottom: solid 1px $lg_border_color;
1.721     harmsja  5932: 	list-style:none;
1.870     tempelho 5933: 	margin: 0 -10px;
1.803     bisitz   5934: 	padding: 0;
1.693     droeschl 5935: }
                   5936: 
1.795     www      5937: ul.LC_TabContent li,
                   5938: ul.LC_TabContentBigger li {
1.741     harmsja  5939: 	float:left;
                   5940: }
1.795     www      5941: 
1.897     wenzelju 5942: ul#LC_secondary_menu li a {
1.808     droeschl 5943:     color: $fontmenu;
1.693     droeschl 5944: 	text-decoration: none;
                   5945: }
1.795     www      5946: 
1.721     harmsja  5947: ul.LC_TabContent {
1.847     tempelho 5948: 	min-height:1.5em;
1.721     harmsja  5949: }
1.795     www      5950: 
                   5951: ul.LC_TabContent li {
1.741     harmsja  5952: 	vertical-align:middle;
1.803     bisitz   5953: 	padding: 0 10px 0 10px;
1.745     ehlerst  5954: 	background-color:$tabbg;
                   5955: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5956: }
1.795     www      5957: 
1.847     tempelho 5958: ul.LC_TabContent .right {
                   5959: 	float:right;
                   5960: }
                   5961: 
1.795     www      5962: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5963: 	color:rgb(47,47,47);
                   5964: 	text-decoration:none;
                   5965: 	font-size:95%;
                   5966: 	font-weight:bold;
1.761     tempelho 5967: 	padding-right: 16px;
1.721     harmsja  5968: }
1.795     www      5969: 
                   5970: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5971:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.841     tempelho 5972: 	border-bottom:solid 2px #FFFFFF;
1.761     tempelho 5973: 	padding-right: 16px;
1.744     ehlerst  5974: }
1.795     www      5975: 
1.870     tempelho 5976: #maincoursedoc {
                   5977: 	clear:both;
                   5978: }
                   5979: 
                   5980: ul.LC_TabContentBigger {
                   5981:         display:block;
                   5982:         list-style:none;
                   5983:         padding: 0;
                   5984: }
                   5985: 
1.795     www      5986: ul.LC_TabContentBigger li {
1.870     tempelho 5987:         vertical-align:bottom;
                   5988:         height: 30px;
                   5989:         font-size:110%;
                   5990:         font-weight:bold;
                   5991:         color: #737373;
1.841     tempelho 5992: }
                   5993: 
1.870     tempelho 5994: 
                   5995: ul.LC_TabContentBigger li a {
                   5996:         background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   5997: 	height: 30px;
                   5998: 	line-height: 30px;
                   5999: 	text-align: center;
                   6000: 	display: block;
                   6001: 	text-decoration: none;
1.741     harmsja  6002: }
1.795     www      6003: 
1.870     tempelho 6004: ul.LC_TabContentBigger li:hover a, 
                   6005: ul.LC_TabContentBigger li.active a {
                   6006: 	background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
1.857     tempelho 6007: 	color:$font;
1.870     tempelho 6008: 	text-decoration: underline;
1.744     ehlerst  6009: }
1.795     www      6010: 
1.870     tempelho 6011: 
                   6012: ul.LC_TabContentBigger li b {
                   6013: 	background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6014: 	display: block;
                   6015: 	float: left;
                   6016: 	padding: 0 30px;
                   6017: }
                   6018: 
                   6019: ul.LC_TabContentBigger li:hover b,
                   6020: ul.LC_TabContentBigger li.active b {
                   6021:         background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6022:         color:$font;
                   6023: 	border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6024: }
1.693     droeschl 6025: 
1.870     tempelho 6026: 
1.862     bisitz   6027: ul.LC_CourseBreadcrumbs {
                   6028:   background: $sidebg;
                   6029:   line-height: 32px;
                   6030:   padding-left: 10px;
                   6031:   margin: 0 0 10px 0;
                   6032:   list-style-position: inside;
                   6033: 
                   6034: }
                   6035: 
1.795     www      6036: ol#LC_MenuBreadcrumbs, 
1.862     bisitz   6037: ol#LC_PathBreadcrumbs {
1.693     droeschl 6038: 	padding-left: 10px;
1.819     tempelho 6039: 	margin: 0;
1.693     droeschl 6040: 	list-style-position: inside;
                   6041: }
                   6042: 
1.795     www      6043: ol#LC_MenuBreadcrumbs li, 
                   6044: ol#LC_PathBreadcrumbs li, 
1.862     bisitz   6045: ul.LC_CourseBreadcrumbs li {
1.842     droeschl 6046:     display: inline;
                   6047:     white-space: nowrap;
1.693     droeschl 6048: }
                   6049: 
1.823     bisitz   6050: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6051: ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 6052: 	text-decoration: none;
                   6053: 	font-size:90%;
                   6054: }
1.795     www      6055: 
                   6056: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6057: 	text-decoration:none;
                   6058: 	font-size:100%;
                   6059: 	font-weight:bold;
1.693     droeschl 6060: }
1.795     www      6061: 
1.840     bisitz   6062: .LC_Box {
1.835     bisitz   6063:     border: solid 1px $lg_border_color;
                   6064:     padding: 0 10px 10px 10px;
1.746     neumanie 6065: }
1.795     www      6066: 
                   6067: .LC_AboutMe_Image {
1.747     neumanie 6068: 	float:left;
                   6069: 	margin-right:10px;
                   6070: }
1.795     www      6071: 
                   6072: .LC_Clear_AboutMe_Image {
1.747     neumanie 6073: 	clear:left;
                   6074: }
1.795     www      6075: 
1.721     harmsja  6076: dl.LC_ListStyleClean dt {
1.693     droeschl 6077: 	padding-right: 5px;
                   6078: 	display: table-header-group;
                   6079: }
                   6080: 
1.721     harmsja  6081: dl.LC_ListStyleClean dd {
1.693     droeschl 6082: 	display: table-row;
                   6083: }
                   6084: 
1.721     harmsja  6085: .LC_ListStyleClean,
                   6086: .LC_ListStyleSimple,
                   6087: .LC_ListStyleNormal,
1.777     tempelho 6088: .LC_ListStyle_Border,
1.795     www      6089: .LC_ListStyleSpecial {
1.693     droeschl 6090: 	/*display:block;	*/
                   6091: 	list-style-position: inside;
                   6092: 	list-style-type: none;
                   6093: 	overflow: hidden;
1.803     bisitz   6094: 	padding: 0;
1.693     droeschl 6095: }
                   6096: 
1.721     harmsja  6097: .LC_ListStyleSimple li,
                   6098: .LC_ListStyleSimple dd,
                   6099: .LC_ListStyleNormal li,
                   6100: .LC_ListStyleNormal dd,
                   6101: .LC_ListStyleSpecial li,
1.795     www      6102: .LC_ListStyleSpecial dd {
1.803     bisitz   6103: 	margin: 0;
1.693     droeschl 6104: 	padding: 5px 5px 5px 10px;
                   6105: 	clear: both;
                   6106: }
                   6107: 
1.721     harmsja  6108: .LC_ListStyleClean li,
                   6109: .LC_ListStyleClean dd {
1.803     bisitz   6110: 	padding-top: 0;
                   6111: 	padding-bottom: 0;
1.693     droeschl 6112: }
                   6113: 
1.721     harmsja  6114: .LC_ListStyleSimple dd,
1.795     www      6115: .LC_ListStyleSimple li {
1.698     harmsja  6116: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6117: }
                   6118: 
1.721     harmsja  6119: .LC_ListStyleSpecial li,
                   6120: .LC_ListStyleSpecial dd {
1.693     droeschl 6121: 	list-style-type: none;
                   6122: 	background-color: RGB(220, 220, 220);
                   6123: 	margin-bottom: 4px;
                   6124: }
                   6125: 
1.721     harmsja  6126: table.LC_SimpleTable {
1.698     harmsja  6127: 	margin:5px;
                   6128: 	border:solid 1px $lg_border_color;
1.795     www      6129: }
1.693     droeschl 6130: 
1.721     harmsja  6131: table.LC_SimpleTable tr {
1.803     bisitz   6132: 	padding: 0;
1.698     harmsja  6133: 	border:solid 1px $lg_border_color;
1.693     droeschl 6134: }
1.795     www      6135: 
                   6136: table.LC_SimpleTable thead {
1.698     harmsja  6137: 	 background:rgb(220,220,220);
1.693     droeschl 6138: }
                   6139: 
1.721     harmsja  6140: div.LC_columnSection {
1.693     droeschl 6141: 	display: block;
                   6142: 	clear: both;
                   6143: 	overflow: hidden;
1.803     bisitz   6144: 	margin: 0;
1.693     droeschl 6145: }
                   6146: 
1.721     harmsja  6147: div.LC_columnSection>* {
1.693     droeschl 6148: 	float: left;
1.803     bisitz   6149: 	margin: 10px 20px 10px 0;
1.747     neumanie 6150: 	overflow:hidden;
1.693     droeschl 6151: }
1.721     harmsja  6152: 
1.694     tempelho 6153: .LC_loginpage_container {
                   6154: 	text-align:left;
                   6155: 	margin : 0 auto;
1.785     tempelho 6156: 	width:90%;
1.694     tempelho 6157: 	padding: 10px;
                   6158: 	height: auto;
1.712     muellerd 6159: 	background-color:#FFFFFF;
1.694     tempelho 6160: 	border:1px solid #CCCCCC;
                   6161: }
                   6162: 
                   6163: 
                   6164: .LC_loginpage_loginContainer {
                   6165: 	float:left;
1.712     muellerd 6166: 	width: 182px;
1.785     tempelho 6167: 	padding: 2px;
1.712     muellerd 6168: 	border:1px solid #CCCCCC;
                   6169: 	background-color:$loginbg;
1.694     tempelho 6170: }
                   6171: 
1.795     www      6172: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6173: 	margin-top: 0;
1.712     muellerd 6174: 	display:block;
                   6175: 	background:$bgcol;
                   6176: 	color:$textcol;
                   6177: 	padding-left:5px;
                   6178: }
1.785     tempelho 6179: 
1.694     tempelho 6180: .LC_loginpage_loginInfo {
                   6181: 	float:left;
1.785     tempelho 6182: 	width:182px;
1.694     tempelho 6183: 	border:1px solid #CCCCCC;
1.785     tempelho 6184: 	padding:2px;
1.712     muellerd 6185: }
                   6186: 
1.694     tempelho 6187: .LC_loginpage_space {
1.754     droeschl 6188: 	clear: both;
                   6189: 	margin-bottom: 20px;
1.694     tempelho 6190: 	border-bottom: 1px solid #CCCCCC;
                   6191: }
                   6192: 
1.785     tempelho 6193: .LC_loginpage_floatLeft {
                   6194: 	float: left;
                   6195: 	width: 200px;
                   6196: 	margin: 0;
                   6197: }
                   6198: 
1.795     www      6199: table em {
1.754     droeschl 6200: 	font-weight: bold;
                   6201: 	font-style: normal;
1.748     schulted 6202: }
1.795     www      6203: 
1.779     bisitz   6204: table.LC_tableBrowseRes,
1.795     www      6205: table.LC_tableOfContent {
1.769     schulted 6206:         border:none;
1.858     bisitz   6207: 	border-spacing: 1px;
1.754     droeschl 6208: 	padding: 3px;
                   6209: 	background-color: #FFFFFF;
                   6210: 	font-size: 90%;
1.753     droeschl 6211: }
1.789     droeschl 6212: 
                   6213: table.LC_tableOfContent{
                   6214:     border-collapse: collapse;
                   6215: }
                   6216: 
1.771     droeschl 6217: table.LC_tableBrowseRes a,
1.768     schulted 6218: table.LC_tableOfContent a {
1.771     droeschl 6219:         background-color: transparent;
1.753     droeschl 6220: 	text-decoration: none;
                   6221: }
                   6222: 
1.771     droeschl 6223: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6224: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6225: 	background-color: #EEEEEE;
1.753     droeschl 6226: }
                   6227: 
1.795     www      6228: table.LC_tableOfContent img {
1.753     droeschl 6229: 	border: none;
                   6230: 	height: 1.3em;
                   6231: 	vertical-align: text-bottom;
                   6232: 	margin-right: 0.3em;
                   6233: }
1.757     schulted 6234: 
1.795     www      6235: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6236: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6237: }
                   6238: 
1.795     www      6239: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6240: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6241: }
                   6242: 
1.795     www      6243: a#LC_content_toolbar_closenav {
1.774     ehlerst  6244: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6245: }
                   6246: 
1.795     www      6247: a#LC_content_toolbar_everything {
1.774     ehlerst  6248: 	background-image:url(/res/adm/pages/show-all.gif);
                   6249: }
                   6250: 
1.795     www      6251: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6252: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6253: }
                   6254: 
1.795     www      6255: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6256: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6257: }
                   6258: 
1.795     www      6259: a#LC_content_toolbar_changefolder {
1.757     schulted 6260: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6261: }
                   6262: 
1.795     www      6263: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6264: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6265: }
                   6266: 
1.795     www      6267: ul#LC_toolbar li a:hover {
1.757     schulted 6268: 	background-position: bottom center;
                   6269: }
                   6270: 
1.795     www      6271: ul#LC_toolbar {
1.803     bisitz   6272: 	padding: 0;
1.757     schulted 6273: 	margin: 2px;
                   6274: 	list-style:none;
                   6275: 	position:relative;
                   6276: 	background-color:white;
                   6277: }
                   6278: 
1.795     www      6279: ul#LC_toolbar li {
1.757     schulted 6280: 	border:1px solid white;
1.803     bisitz   6281: 	padding: 0;
1.757     schulted 6282: 	margin: 0;
1.795     www      6283:         float: left;
1.767     droeschl 6284: 	display:inline;
1.757     schulted 6285: 	vertical-align:middle;
1.795     www      6286: } 
1.757     schulted 6287: 
1.783     amueller 6288: 
1.795     www      6289: a.LC_toolbarItem {
1.767     droeschl 6290: 	display:block;
1.803     bisitz   6291: 	padding: 0;
                   6292: 	margin: 0;
1.757     schulted 6293: 	height: 32px;
                   6294: 	width: 32px;
1.779     bisitz   6295: 	color:white;
1.803     bisitz   6296: 	border: none;
1.757     schulted 6297: 	background-repeat:no-repeat;
                   6298: 	background-color:transparent;
                   6299: }
                   6300: 
1.843     bisitz   6301: ul.LC_funclist li {
1.782     bisitz   6302:   float: left;
                   6303:   white-space: nowrap;
                   6304:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6305:   margin: 0 15px 15px 10px;
1.782     bisitz   6306: }
                   6307: 
1.757     schulted 6308: 
1.343     albertel 6309: END
                   6310: }
                   6311: 
1.306     albertel 6312: =pod
                   6313: 
                   6314: =item * &headtag()
                   6315: 
                   6316: Returns a uniform footer for LON-CAPA web pages.
                   6317: 
1.307     albertel 6318: Inputs: $title - optional title for the head
                   6319:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6320:         $args - optional arguments
1.319     albertel 6321:             force_register - if is true call registerurl so the remote is 
                   6322:                              informed
1.415     albertel 6323:             redirect       -> array ref of
                   6324:                                    1- seconds before redirect occurs
                   6325:                                    2- url to redirect to
                   6326:                                    3- whether the side effect should occur
1.315     albertel 6327:                            (side effect of setting 
                   6328:                                $env{'internal.head.redirect'} to the url 
                   6329:                                redirected too)
1.352     albertel 6330:             domain         -> force to color decorate a page for a specific
                   6331:                                domain
                   6332:             function       -> force usage of a specific rolish color scheme
                   6333:             bgcolor        -> override the default page bgcolor
1.460     albertel 6334:             no_auto_mt_title
                   6335:                            -> prevent &mt()ing the title arg
1.464     albertel 6336: 
1.306     albertel 6337: =cut
                   6338: 
                   6339: sub headtag {
1.313     albertel 6340:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6341:     
1.363     albertel 6342:     my $function = $args->{'function'} || &get_users_function();
                   6343:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6344:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6345:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6346: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6347: 		   #time(),
1.418     albertel 6348: 		   $env{'environment.color.timestamp'},
1.363     albertel 6349: 		   $function,$domain,$bgcolor);
                   6350: 
1.369     www      6351:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6352: 
1.308     albertel 6353:     my $result =
                   6354: 	'<head>'.
1.461     albertel 6355: 	&font_settings();
1.319     albertel 6356: 
1.461     albertel 6357:     if (!$args->{'frameset'}) {
                   6358: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6359:     }
1.319     albertel 6360:     if ($args->{'force_register'}) {
                   6361: 	$result .= &Apache::lonmenu::registerurl(1);
                   6362:     }
1.436     albertel 6363:     if (!$args->{'no_nav_bar'} 
                   6364: 	&& !$args->{'only_body'}
                   6365: 	&& !$args->{'frameset'}) {
                   6366: 	$result .= &help_menu_js();
                   6367:     }
1.319     albertel 6368: 
1.314     albertel 6369:     if (ref($args->{'redirect'})) {
1.414     albertel 6370: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6371: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6372: 	if (!$inhibit_continue) {
                   6373: 	    $env{'internal.head.redirect'} = $url;
                   6374: 	}
1.313     albertel 6375: 	$result.=<<ADDMETA
                   6376: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6377: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6378: ADDMETA
                   6379:     }
1.306     albertel 6380:     if (!defined($title)) {
                   6381: 	$title = 'The LearningOnline Network with CAPA';
                   6382:     }
1.460     albertel 6383:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6384:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6385: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6386: 	.$head_extra;
1.306     albertel 6387:     return $result;
                   6388: }
                   6389: 
                   6390: =pod
                   6391: 
1.340     albertel 6392: =item * &font_settings()
                   6393: 
                   6394: Returns neccessary <meta> to set the proper encoding
                   6395: 
                   6396: Inputs: none
                   6397: 
                   6398: =cut
                   6399: 
                   6400: sub font_settings {
                   6401:     my $headerstring='';
1.647     www      6402:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6403: 	$headerstring.=
                   6404: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6405:     }
                   6406:     return $headerstring;
                   6407: }
                   6408: 
1.341     albertel 6409: =pod
                   6410: 
                   6411: =item * &xml_begin()
                   6412: 
                   6413: Returns the needed doctype and <html>
                   6414: 
                   6415: Inputs: none
                   6416: 
                   6417: =cut
                   6418: 
                   6419: sub xml_begin {
                   6420:     my $output='';
                   6421: 
1.592     albertel 6422:     if ($env{'internal.start_page'}==1) {
                   6423: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6424:     }
1.342     albertel 6425: 
1.341     albertel 6426:     if ($env{'browser.mathml'}) {
                   6427: 	$output='<?xml version="1.0"?>'
                   6428:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6429: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6430:             
                   6431: #	    .'<!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">] >'
                   6432: 	    .'<!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">'
                   6433:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6434: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6435:     } else {
1.849     bisitz   6436: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6437:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6438:     }
                   6439:     return $output;
                   6440: }
1.340     albertel 6441: 
                   6442: =pod
                   6443: 
1.306     albertel 6444: =item * &endheadtag()
                   6445: 
                   6446: Returns a uniform </head> for LON-CAPA web pages.
                   6447: 
                   6448: Inputs: none
                   6449: 
                   6450: =cut
                   6451: 
                   6452: sub endheadtag {
                   6453:     return '</head>';
                   6454: }
                   6455: 
                   6456: =pod
                   6457: 
                   6458: =item * &head()
                   6459: 
                   6460: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6461: 
1.648     raeburn  6462: Inputs:
                   6463: 
                   6464: =over 4
                   6465: 
                   6466: $title - optional title for the page
                   6467: 
                   6468: $head_extra - optional extra HTML to put inside the <head>
                   6469: 
                   6470: =back
1.405     albertel 6471: 
1.306     albertel 6472: =cut
                   6473: 
                   6474: sub head {
1.325     albertel 6475:     my ($title,$head_extra,$args) = @_;
                   6476:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6477: }
                   6478: 
                   6479: =pod
                   6480: 
                   6481: =item * &start_page()
                   6482: 
                   6483: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6484: 
1.648     raeburn  6485: Inputs:
                   6486: 
                   6487: =over 4
                   6488: 
                   6489: $title - optional title for the page
                   6490: 
                   6491: $head_extra - optional extra HTML to incude inside the <head>
                   6492: 
                   6493: $args - additional optional args supported are:
                   6494: 
                   6495: =over 8
                   6496: 
                   6497:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6498:                                     arg on
1.814     bisitz   6499:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6500:              add_entries    -> additional attributes to add to the  <body>
                   6501:              domain         -> force to color decorate a page for a 
1.317     albertel 6502:                                     specific domain
1.648     raeburn  6503:              function       -> force usage of a specific rolish color
1.317     albertel 6504:                                     scheme
1.648     raeburn  6505:              redirect       -> see &headtag()
                   6506:              bgcolor        -> override the default page bg color
                   6507:              js_ready       -> return a string ready for being used in 
1.317     albertel 6508:                                     a javascript writeln
1.648     raeburn  6509:              html_encode    -> return a string ready for being used in 
1.320     albertel 6510:                                     a html attribute
1.648     raeburn  6511:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6512:                                     $forcereg arg
1.648     raeburn  6513:              frameset       -> if true will start with a <frameset>
1.330     albertel 6514:                                     rather than <body>
1.648     raeburn  6515:              skip_phases    -> hash ref of 
1.338     albertel 6516:                                     head -> skip the <html><head> generation
                   6517:                                     body -> skip all <body> generation
1.648     raeburn  6518:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6519:                                     'Switch To Inline Menu' link
1.648     raeburn  6520:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6521:              inherit_jsmath -> when creating popup window in a page,
                   6522:                                     should it have jsmath forced on by the
                   6523:                                     current page
1.867     kalberla 6524:              bread_crumbs ->             Array containing breadcrumbs
                   6525:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6526: 
1.648     raeburn  6527: =back
1.460     albertel 6528: 
1.648     raeburn  6529: =back
1.562     albertel 6530: 
1.306     albertel 6531: =cut
                   6532: 
                   6533: sub start_page {
1.309     albertel 6534:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6535:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6536:     my %head_args;
1.352     albertel 6537:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6538: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6539: 		     'no_auto_mt_title') {
1.319     albertel 6540: 	if (defined($args->{$arg})) {
1.324     raeburn  6541: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6542: 	}
1.313     albertel 6543:     }
1.319     albertel 6544: 
1.315     albertel 6545:     $env{'internal.start_page'}++;
1.338     albertel 6546:     my $result;
                   6547:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6548: 	$result.=
1.341     albertel 6549: 	    &xml_begin().
1.338     albertel 6550: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6551:     }
                   6552:     
                   6553:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6554: 	if ($args->{'frameset'}) {
                   6555: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6556: 						$args->{'add_entries'});
                   6557: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6558:         } else {
                   6559:             $result .=
                   6560:                 &bodytag($title, 
                   6561:                          $args->{'function'},       $args->{'add_entries'},
                   6562:                          $args->{'only_body'},      $args->{'domain'},
                   6563:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6564:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6565:                          $args);
                   6566:         }
1.330     albertel 6567:     }
1.338     albertel 6568: 
1.315     albertel 6569:     if ($args->{'js_ready'}) {
1.713     kaisler  6570: 		$result = &js_ready($result);
1.315     albertel 6571:     }
1.320     albertel 6572:     if ($args->{'html_encode'}) {
1.713     kaisler  6573: 		$result = &html_encode($result);
                   6574:     }
                   6575: 
1.813     bisitz   6576:     # Preparation for new and consistent functionlist at top of screen
                   6577:     # if ($args->{'functionlist'}) {
                   6578:     #            $result .= &build_functionlist();
                   6579:     #}
                   6580: 
                   6581:     # Don't add anything more if only_body wanted
                   6582:     return $result if $args->{'only_body'};
                   6583: 
                   6584:     #Breadcrumbs
1.758     kaisler  6585:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6586: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6587: 		#if any br links exists, add them to the breadcrumbs
                   6588: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6589: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6590: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6591: 			}
                   6592: 		}
                   6593: 
                   6594: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6595: 		if(exists($args->{'bread_crumbs_component'})){
                   6596: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6597: 		}else{
                   6598: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6599: 		}
1.320     albertel 6600:     }
1.315     albertel 6601:     return $result;
1.306     albertel 6602: }
                   6603: 
1.330     albertel 6604: 
1.306     albertel 6605: =pod
                   6606: 
                   6607: =item * &head()
                   6608: 
                   6609: Returns a complete </body></html> section for LON-CAPA web pages.
                   6610: 
1.315     albertel 6611: Inputs:         $args - additional optional args supported are:
                   6612:                  js_ready     -> return a string ready for being used in 
                   6613:                                  a javascript writeln
1.320     albertel 6614:                  html_encode  -> return a string ready for being used in 
                   6615:                                  a html attribute
1.330     albertel 6616:                  frameset     -> if true will start with a <frameset>
                   6617:                                  rather than <body>
1.493     albertel 6618:                  dicsussion   -> if true will get discussion from
                   6619:                                   lonxml::xmlend
                   6620:                                  (you can pass the target and parser arguments
                   6621:                                   through optional 'target' and 'parser' args
                   6622:                                   to this routine)
1.306     albertel 6623: 
                   6624: =cut
                   6625: 
                   6626: sub end_page {
1.315     albertel 6627:     my ($args) = @_;
                   6628:     $env{'internal.end_page'}++;
1.330     albertel 6629:     my $result;
1.335     albertel 6630:     if ($args->{'discussion'}) {
                   6631: 	my ($target,$parser);
                   6632: 	if (ref($args->{'discussion'})) {
                   6633: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6634: 				$args->{'discussion'}{'parser'});
                   6635: 	}
                   6636: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6637:     }
                   6638: 
1.330     albertel 6639:     if ($args->{'frameset'}) {
                   6640: 	$result .= '</frameset>';
                   6641:     } else {
1.635     raeburn  6642: 	$result .= &endbodytag($args);
1.330     albertel 6643:     }
                   6644:     $result .= "\n</html>";
                   6645: 
1.315     albertel 6646:     if ($args->{'js_ready'}) {
1.317     albertel 6647: 	$result = &js_ready($result);
1.315     albertel 6648:     }
1.335     albertel 6649: 
1.320     albertel 6650:     if ($args->{'html_encode'}) {
                   6651: 	$result = &html_encode($result);
                   6652:     }
1.335     albertel 6653: 
1.315     albertel 6654:     return $result;
                   6655: }
                   6656: 
1.320     albertel 6657: sub html_encode {
                   6658:     my ($result) = @_;
                   6659: 
1.322     albertel 6660:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6661:     
                   6662:     return $result;
                   6663: }
1.317     albertel 6664: sub js_ready {
                   6665:     my ($result) = @_;
                   6666: 
1.323     albertel 6667:     $result =~ s/[\n\r]/ /xmsg;
                   6668:     $result =~ s/\\/\\\\/xmsg;
                   6669:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6670:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6671:     
                   6672:     return $result;
                   6673: }
                   6674: 
1.315     albertel 6675: sub validate_page {
                   6676:     if (  exists($env{'internal.start_page'})
1.316     albertel 6677: 	  &&     $env{'internal.start_page'} > 1) {
                   6678: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6679: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6680: 				 $ENV{'request.filename'});
1.315     albertel 6681:     }
                   6682:     if (  exists($env{'internal.end_page'})
1.316     albertel 6683: 	  &&     $env{'internal.end_page'} > 1) {
                   6684: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6685: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6686: 				 $env{'request.filename'});
1.315     albertel 6687:     }
                   6688:     if (     exists($env{'internal.start_page'})
                   6689: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6690: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6691: 				 $env{'request.filename'});
1.315     albertel 6692:     }
                   6693:     if (   ! exists($env{'internal.start_page'})
                   6694: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6695: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6696: 				 $env{'request.filename'});
1.315     albertel 6697:     }
1.306     albertel 6698: }
1.315     albertel 6699: 
1.318     albertel 6700: sub simple_error_page {
                   6701:     my ($r,$title,$msg) = @_;
                   6702:     my $page =
                   6703: 	&Apache::loncommon::start_page($title).
                   6704: 	&mt($msg).
                   6705: 	&Apache::loncommon::end_page();
                   6706:     if (ref($r)) {
                   6707: 	$r->print($page);
1.327     albertel 6708: 	return;
1.318     albertel 6709:     }
                   6710:     return $page;
                   6711: }
1.347     albertel 6712: 
                   6713: {
1.610     albertel 6714:     my @row_count;
1.347     albertel 6715:     sub start_data_table {
1.422     albertel 6716: 	my ($add_class) = @_;
                   6717: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6718: 	unshift(@row_count,0);
1.422     albertel 6719: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6720:     }
                   6721: 
                   6722:     sub end_data_table {
1.610     albertel 6723: 	shift(@row_count);
1.389     albertel 6724: 	return '</table>'."\n";;
1.347     albertel 6725:     }
                   6726: 
                   6727:     sub start_data_table_row {
1.422     albertel 6728: 	my ($add_class) = @_;
1.610     albertel 6729: 	$row_count[0]++;
                   6730: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6731: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 6732: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6733:     }
1.471     banghart 6734:     
                   6735:     sub continue_data_table_row {
                   6736: 	my ($add_class) = @_;
1.610     albertel 6737: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6738: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 6739: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6740:     }
1.347     albertel 6741: 
                   6742:     sub end_data_table_row {
1.389     albertel 6743: 	return '</tr>'."\n";;
1.347     albertel 6744:     }
1.367     www      6745: 
1.421     albertel 6746:     sub start_data_table_empty_row {
1.707     bisitz   6747: #	$row_count[0]++;
1.421     albertel 6748: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6749:     }
                   6750: 
                   6751:     sub end_data_table_empty_row {
                   6752: 	return '</tr>'."\n";;
                   6753:     }
                   6754: 
1.367     www      6755:     sub start_data_table_header_row {
1.389     albertel 6756: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6757:     }
                   6758: 
                   6759:     sub end_data_table_header_row {
1.389     albertel 6760: 	return '</tr>'."\n";;
1.367     www      6761:     }
1.890     droeschl 6762: 
                   6763:     sub data_table_caption {
                   6764:         my $caption = shift;
                   6765:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6766:     }
1.347     albertel 6767: }
                   6768: 
1.548     albertel 6769: =pod
                   6770: 
                   6771: =item * &inhibit_menu_check($arg)
                   6772: 
                   6773: Checks for a inhibitmenu state and generates output to preserve it
                   6774: 
                   6775: Inputs:         $arg - can be any of
                   6776:                      - undef - in which case the return value is a string 
                   6777:                                to add  into arguments list of a uri
                   6778:                      - 'input' - in which case the return value is a HTML
                   6779:                                  <form> <input> field of type hidden to
                   6780:                                  preserve the value
                   6781:                      - a url - in which case the return value is the url with
                   6782:                                the neccesary cgi args added to preserve the
                   6783:                                inhibitmenu state
                   6784:                      - a ref to a url - no return value, but the string is
                   6785:                                         updated to include the neccessary cgi
                   6786:                                         args to preserve the inhibitmenu state
                   6787: 
                   6788: =cut
                   6789: 
                   6790: sub inhibit_menu_check {
                   6791:     my ($arg) = @_;
                   6792:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6793:     if ($arg eq 'input') {
                   6794: 	if ($env{'form.inhibitmenu'}) {
                   6795: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6796: 	} else {
                   6797: 	    return
                   6798: 	}
                   6799:     }
                   6800:     if ($env{'form.inhibitmenu'}) {
                   6801: 	if (ref($arg)) {
                   6802: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6803: 	} elsif ($arg eq '') {
                   6804: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6805: 	} else {
                   6806: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6807: 	}
                   6808:     }
                   6809:     if (!ref($arg)) {
                   6810: 	return $arg;
                   6811:     }
                   6812: }
                   6813: 
1.251     albertel 6814: ###############################################
1.182     matthew  6815: 
                   6816: =pod
                   6817: 
1.549     albertel 6818: =back
                   6819: 
                   6820: =head1 User Information Routines
                   6821: 
                   6822: =over 4
                   6823: 
1.405     albertel 6824: =item * &get_users_function()
1.182     matthew  6825: 
                   6826: Used by &bodytag to determine the current users primary role.
                   6827: Returns either 'student','coordinator','admin', or 'author'.
                   6828: 
                   6829: =cut
                   6830: 
                   6831: ###############################################
                   6832: sub get_users_function {
1.815     tempelho 6833:     my $function = 'norole';
1.818     tempelho 6834:     if ($env{'request.role'}=~/^(st)/) {
                   6835:         $function='student';
                   6836:     }
1.258     albertel 6837:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6838:         $function='coordinator';
                   6839:     }
1.258     albertel 6840:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6841:         $function='admin';
                   6842:     }
1.826     bisitz   6843:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6844:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6845:         $function='author';
                   6846:     }
                   6847:     return $function;
1.54      www      6848: }
1.99      www      6849: 
                   6850: ###############################################
                   6851: 
1.233     raeburn  6852: =pod
                   6853: 
1.821     raeburn  6854: =item * &show_course()
                   6855: 
                   6856: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6857: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6858: 
                   6859: Inputs:
                   6860: None
                   6861: 
                   6862: Outputs:
                   6863: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6864: 
                   6865: =cut
                   6866: 
                   6867: ###############################################
                   6868: sub show_course {
                   6869:     my $course = !$env{'user.adv'};
                   6870:     if (!$env{'user.adv'}) {
                   6871:         foreach my $env (keys(%env)) {
                   6872:             next if ($env !~ m/^user\.priv\./);
                   6873:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6874:                 $course = 0;
                   6875:                 last;
                   6876:             }
                   6877:         }
                   6878:     }
                   6879:     return $course;
                   6880: }
                   6881: 
                   6882: ###############################################
                   6883: 
                   6884: =pod
                   6885: 
1.542     raeburn  6886: =item * &check_user_status()
1.274     raeburn  6887: 
                   6888: Determines current status of supplied role for a
                   6889: specific user. Roles can be active, previous or future.
                   6890: 
                   6891: Inputs: 
                   6892: user's domain, user's username, course's domain,
1.375     raeburn  6893: course's number, optional section ID.
1.274     raeburn  6894: 
                   6895: Outputs:
                   6896: role status: active, previous or future. 
                   6897: 
                   6898: =cut
                   6899: 
                   6900: sub check_user_status {
1.412     raeburn  6901:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6902:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6903:     my @uroles = keys %userinfo;
                   6904:     my $srchstr;
                   6905:     my $active_chk = 'none';
1.412     raeburn  6906:     my $now = time;
1.274     raeburn  6907:     if (@uroles > 0) {
1.412     raeburn  6908:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6909:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6910:         } else {
1.412     raeburn  6911:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6912:         }
                   6913:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6914:             my $role_end = 0;
                   6915:             my $role_start = 0;
                   6916:             $active_chk = 'active';
1.412     raeburn  6917:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6918:                 $role_end = $1;
                   6919:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6920:                     $role_start = $1;
1.274     raeburn  6921:                 }
                   6922:             }
                   6923:             if ($role_start > 0) {
1.412     raeburn  6924:                 if ($now < $role_start) {
1.274     raeburn  6925:                     $active_chk = 'future';
                   6926:                 }
                   6927:             }
                   6928:             if ($role_end > 0) {
1.412     raeburn  6929:                 if ($now > $role_end) {
1.274     raeburn  6930:                     $active_chk = 'previous';
                   6931:                 }
                   6932:             }
                   6933:         }
                   6934:     }
                   6935:     return $active_chk;
                   6936: }
                   6937: 
                   6938: ###############################################
                   6939: 
                   6940: =pod
                   6941: 
1.405     albertel 6942: =item * &get_sections()
1.233     raeburn  6943: 
                   6944: Determines all the sections for a course including
                   6945: sections with students and sections containing other roles.
1.419     raeburn  6946: Incoming parameters: 
                   6947: 
                   6948: 1. domain
                   6949: 2. course number 
                   6950: 3. reference to array containing roles for which sections should 
                   6951: be gathered (optional).
                   6952: 4. reference to array containing status types for which sections 
                   6953: should be gathered (optional).
                   6954: 
                   6955: If the third argument is undefined, sections are gathered for any role. 
                   6956: If the fourth argument is undefined, sections are gathered for any status.
                   6957: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6958:  
1.374     raeburn  6959: Returns section hash (keys are section IDs, values are
                   6960: number of users in each section), subject to the
1.419     raeburn  6961: optional roles filter, optional status filter 
1.233     raeburn  6962: 
                   6963: =cut
                   6964: 
                   6965: ###############################################
                   6966: sub get_sections {
1.419     raeburn  6967:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6968:     if (!defined($cdom) || !defined($cnum)) {
                   6969:         my $cid =  $env{'request.course.id'};
                   6970: 
                   6971: 	return if (!defined($cid));
                   6972: 
                   6973:         $cdom = $env{'course.'.$cid.'.domain'};
                   6974:         $cnum = $env{'course.'.$cid.'.num'};
                   6975:     }
                   6976: 
                   6977:     my %sectioncount;
1.419     raeburn  6978:     my $now = time;
1.240     albertel 6979: 
1.366     albertel 6980:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6981: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6982: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6983: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6984:         my $start_index = &Apache::loncoursedata::CL_START();
                   6985:         my $end_index = &Apache::loncoursedata::CL_END();
                   6986:         my $status;
1.366     albertel 6987: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6988: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6989: 				                     $data->[$status_index],
                   6990:                                                      $data->[$start_index],
                   6991:                                                      $data->[$end_index]);
                   6992:             if ($stu_status eq 'Active') {
                   6993:                 $status = 'active';
                   6994:             } elsif ($end < $now) {
                   6995:                 $status = 'previous';
                   6996:             } elsif ($start > $now) {
                   6997:                 $status = 'future';
                   6998:             } 
                   6999: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7000:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7001:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7002: 		    $sectioncount{$section}++;
                   7003:                 }
1.240     albertel 7004: 	    }
                   7005: 	}
                   7006:     }
                   7007:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7008:     foreach my $user (sort(keys(%courseroles))) {
                   7009: 	if ($user !~ /^(\w{2})/) { next; }
                   7010: 	my ($role) = ($user =~ /^(\w{2})/);
                   7011: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7012: 	my ($section,$status);
1.240     albertel 7013: 	if ($role eq 'cr' &&
                   7014: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7015: 	    $section=$1;
                   7016: 	}
                   7017: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7018: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7019:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7020:         if ($end == -1 && $start == -1) {
                   7021:             next; #deleted role
                   7022:         }
                   7023:         if (!defined($possible_status)) { 
                   7024:             $sectioncount{$section}++;
                   7025:         } else {
                   7026:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7027:                 $status = 'active';
                   7028:             } elsif ($end < $now) {
                   7029:                 $status = 'future';
                   7030:             } elsif ($start > $now) {
                   7031:                 $status = 'previous';
                   7032:             }
                   7033:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7034:                 $sectioncount{$section}++;
                   7035:             }
                   7036:         }
1.233     raeburn  7037:     }
1.366     albertel 7038:     return %sectioncount;
1.233     raeburn  7039: }
                   7040: 
1.274     raeburn  7041: ###############################################
1.294     raeburn  7042: 
                   7043: =pod
1.405     albertel 7044: 
                   7045: =item * &get_course_users()
                   7046: 
1.275     raeburn  7047: Retrieves usernames:domains for users in the specified course
                   7048: with specific role(s), and access status. 
                   7049: 
                   7050: Incoming parameters:
1.277     albertel 7051: 1. course domain
                   7052: 2. course number
                   7053: 3. access status: users must have - either active, 
1.275     raeburn  7054: previous, future, or all.
1.277     albertel 7055: 4. reference to array of permissible roles
1.288     raeburn  7056: 5. reference to array of section restrictions (optional)
                   7057: 6. reference to results object (hash of hashes).
                   7058: 7. reference to optional userdata hash
1.609     raeburn  7059: 8. reference to optional statushash
1.630     raeburn  7060: 9. flag if privileged users (except those set to unhide in
                   7061:    course settings) should be excluded    
1.609     raeburn  7062: Keys of top level results hash are roles.
1.275     raeburn  7063: Keys of inner hashes are username:domain, with 
                   7064: values set to access type.
1.288     raeburn  7065: Optional userdata hash returns an array with arguments in the 
                   7066: same order as loncoursedata::get_classlist() for student data.
                   7067: 
1.609     raeburn  7068: Optional statushash returns
                   7069: 
1.288     raeburn  7070: Entries for end, start, section and status are blank because
                   7071: of the possibility of multiple values for non-student roles.
                   7072: 
1.275     raeburn  7073: =cut
1.405     albertel 7074: 
1.275     raeburn  7075: ###############################################
1.405     albertel 7076: 
1.275     raeburn  7077: sub get_course_users {
1.630     raeburn  7078:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7079:     my %idx = ();
1.419     raeburn  7080:     my %seclists;
1.288     raeburn  7081: 
                   7082:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7083:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7084:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7085:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7086:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7087:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7088:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7089:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7090: 
1.290     albertel 7091:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7092:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7093:         my $now = time;
1.277     albertel 7094:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7095:             my $match = 0;
1.412     raeburn  7096:             my $secmatch = 0;
1.419     raeburn  7097:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7098:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7099:             if ($section eq '') {
                   7100:                 $section = 'none';
                   7101:             }
1.291     albertel 7102:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7103:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7104:                     $secmatch = 1;
                   7105:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7106:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7107:                         $secmatch = 1;
                   7108:                     }
                   7109:                 } else {  
1.419     raeburn  7110: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7111: 		        $secmatch = 1;
                   7112:                     }
1.290     albertel 7113: 		}
1.412     raeburn  7114:                 if (!$secmatch) {
                   7115:                     next;
                   7116:                 }
1.419     raeburn  7117:             }
1.275     raeburn  7118:             if (defined($$types{'active'})) {
1.288     raeburn  7119:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7120:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7121:                     $match = 1;
1.275     raeburn  7122:                 }
                   7123:             }
                   7124:             if (defined($$types{'previous'})) {
1.609     raeburn  7125:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7126:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7127:                     $match = 1;
1.275     raeburn  7128:                 }
                   7129:             }
                   7130:             if (defined($$types{'future'})) {
1.609     raeburn  7131:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7132:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7133:                     $match = 1;
1.275     raeburn  7134:                 }
                   7135:             }
1.609     raeburn  7136:             if ($match) {
                   7137:                 push(@{$seclists{$student}},$section);
                   7138:                 if (ref($userdata) eq 'HASH') {
                   7139:                     $$userdata{$student} = $$classlist{$student};
                   7140:                 }
                   7141:                 if (ref($statushash) eq 'HASH') {
                   7142:                     $statushash->{$student}{'st'}{$section} = $status;
                   7143:                 }
1.288     raeburn  7144:             }
1.275     raeburn  7145:         }
                   7146:     }
1.412     raeburn  7147:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7148:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7149:         my $now = time;
1.609     raeburn  7150:         my %displaystatus = ( previous => 'Expired',
                   7151:                               active   => 'Active',
                   7152:                               future   => 'Future',
                   7153:                             );
1.630     raeburn  7154:         my %nothide;
                   7155:         if ($hidepriv) {
                   7156:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7157:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7158:                 if ($user !~ /:/) {
                   7159:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7160:                 } else {
                   7161:                     $nothide{$user} = 1;
                   7162:                 }
                   7163:             }
                   7164:         }
1.439     raeburn  7165:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7166:             my $match = 0;
1.412     raeburn  7167:             my $secmatch = 0;
1.439     raeburn  7168:             my $status;
1.412     raeburn  7169:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7170:             $user =~ s/:$//;
1.439     raeburn  7171:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7172:             if ($end == -1 || $start == -1) {
                   7173:                 next;
                   7174:             }
                   7175:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7176:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7177:                 my ($uname,$udom) = split(/:/,$user);
                   7178:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7179:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7180:                         $secmatch = 1;
                   7181:                     } elsif ($usec eq '') {
1.420     albertel 7182:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7183:                             $secmatch = 1;
                   7184:                         }
                   7185:                     } else {
                   7186:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7187:                             $secmatch = 1;
                   7188:                         }
                   7189:                     }
                   7190:                     if (!$secmatch) {
                   7191:                         next;
                   7192:                     }
1.288     raeburn  7193:                 }
1.419     raeburn  7194:                 if ($usec eq '') {
                   7195:                     $usec = 'none';
                   7196:                 }
1.275     raeburn  7197:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7198:                     if ($hidepriv) {
                   7199:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7200:                             (!$nothide{$uname.':'.$udom})) {
                   7201:                             next;
                   7202:                         }
                   7203:                     }
1.503     raeburn  7204:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7205:                         $status = 'previous';
                   7206:                     } elsif ($start > $now) {
                   7207:                         $status = 'future';
                   7208:                     } else {
                   7209:                         $status = 'active';
                   7210:                     }
1.277     albertel 7211:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7212:                         if ($status eq $type) {
1.420     albertel 7213:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7214:                                 push(@{$$users{$role}{$user}},$type);
                   7215:                             }
1.288     raeburn  7216:                             $match = 1;
                   7217:                         }
                   7218:                     }
1.419     raeburn  7219:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7220:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7221: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7222:                         }
1.420     albertel 7223:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7224:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7225:                         }
1.609     raeburn  7226:                         if (ref($statushash) eq 'HASH') {
                   7227:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7228:                         }
1.275     raeburn  7229:                     }
                   7230:                 }
                   7231:             }
                   7232:         }
1.290     albertel 7233:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7234:             if ((defined($cdom)) && (defined($cnum))) {
                   7235:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7236:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7237:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7238:                     next if ($owner eq '');
                   7239:                     my ($ownername,$ownerdom);
                   7240:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7241:                         $ownername = $1;
                   7242:                         $ownerdom = $2;
                   7243:                     } else {
                   7244:                         $ownername = $owner;
                   7245:                         $ownerdom = $cdom;
                   7246:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7247:                     }
                   7248:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7249:                     if (defined($userdata) && 
1.609     raeburn  7250: 			!exists($$userdata{$owner})) {
                   7251: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7252:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7253:                             push(@{$seclists{$owner}},'none');
                   7254:                         }
                   7255:                         if (ref($statushash) eq 'HASH') {
                   7256:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7257:                         }
1.290     albertel 7258: 		    }
1.279     raeburn  7259:                 }
                   7260:             }
                   7261:         }
1.419     raeburn  7262:         foreach my $user (keys(%seclists)) {
                   7263:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7264:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7265:         }
1.275     raeburn  7266:     }
                   7267:     return;
                   7268: }
                   7269: 
1.288     raeburn  7270: sub get_user_info {
                   7271:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7272:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7273: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7274:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7275:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7276:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7277:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7278:     return;
                   7279: }
1.275     raeburn  7280: 
1.472     raeburn  7281: ###############################################
                   7282: 
                   7283: =pod
                   7284: 
                   7285: =item * &get_user_quota()
                   7286: 
                   7287: Retrieves quota assigned for storage of portfolio files for a user  
                   7288: 
                   7289: Incoming parameters:
                   7290: 1. user's username
                   7291: 2. user's domain
                   7292: 
                   7293: Returns:
1.536     raeburn  7294: 1. Disk quota (in Mb) assigned to student.
                   7295: 2. (Optional) Type of setting: custom or default
                   7296:    (individually assigned or default for user's 
                   7297:    institutional status).
                   7298: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7299:    or student - types as defined in localenroll::inst_usertypes 
                   7300:    for user's domain, which determines default quota for user.
                   7301: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7302: 
                   7303: If a value has been stored in the user's environment, 
1.536     raeburn  7304: it will return that, otherwise it returns the maximal default
                   7305: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7306: 
                   7307: =cut
                   7308: 
                   7309: ###############################################
                   7310: 
                   7311: 
                   7312: sub get_user_quota {
                   7313:     my ($uname,$udom) = @_;
1.536     raeburn  7314:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7315:     if (!defined($udom)) {
                   7316:         $udom = $env{'user.domain'};
                   7317:     }
                   7318:     if (!defined($uname)) {
                   7319:         $uname = $env{'user.name'};
                   7320:     }
                   7321:     if (($udom eq '' || $uname eq '') ||
                   7322:         ($udom eq 'public') && ($uname eq 'public')) {
                   7323:         $quota = 0;
1.536     raeburn  7324:         $quotatype = 'default';
                   7325:         $defquota = 0; 
1.472     raeburn  7326:     } else {
1.536     raeburn  7327:         my $inststatus;
1.472     raeburn  7328:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7329:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7330:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7331:         } else {
1.536     raeburn  7332:             my %userenv = 
                   7333:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7334:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7335:             my ($tmp) = keys(%userenv);
                   7336:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7337:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7338:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7339:             } else {
                   7340:                 undef(%userenv);
                   7341:             }
                   7342:         }
1.536     raeburn  7343:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7344:         if ($quota eq '') {
1.536     raeburn  7345:             $quota = $defquota;
                   7346:             $quotatype = 'default';
                   7347:         } else {
                   7348:             $quotatype = 'custom';
1.472     raeburn  7349:         }
                   7350:     }
1.536     raeburn  7351:     if (wantarray) {
                   7352:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7353:     } else {
                   7354:         return $quota;
                   7355:     }
1.472     raeburn  7356: }
                   7357: 
                   7358: ###############################################
                   7359: 
                   7360: =pod
                   7361: 
                   7362: =item * &default_quota()
                   7363: 
1.536     raeburn  7364: Retrieves default quota assigned for storage of user portfolio files,
                   7365: given an (optional) user's institutional status.
1.472     raeburn  7366: 
                   7367: Incoming parameters:
                   7368: 1. domain
1.536     raeburn  7369: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7370:    status types (e.g., faculty, staff, student etc.)
                   7371:    which apply to the user for whom the default is being retrieved.
                   7372:    If the institutional status string in undefined, the domain
                   7373:    default quota will be returned. 
1.472     raeburn  7374: 
                   7375: Returns:
                   7376: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7377: 2. (Optional) institutional type which determined the value of the
                   7378:    default quota.
1.472     raeburn  7379: 
                   7380: If a value has been stored in the domain's configuration db,
                   7381: it will return that, otherwise it returns 20 (for backwards 
                   7382: compatibility with domains which have not set up a configuration
                   7383: db file; the original statically defined portfolio quota was 20 Mb). 
                   7384: 
1.536     raeburn  7385: If the user's status includes multiple types (e.g., staff and student),
                   7386: the largest default quota which applies to the user determines the
                   7387: default quota returned.
                   7388: 
1.780     raeburn  7389: =back
                   7390: 
1.472     raeburn  7391: =cut
                   7392: 
                   7393: ###############################################
                   7394: 
                   7395: 
                   7396: sub default_quota {
1.536     raeburn  7397:     my ($udom,$inststatus) = @_;
                   7398:     my ($defquota,$settingstatus);
                   7399:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7400:                                             ['quotas'],$udom);
                   7401:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7402:         if ($inststatus ne '') {
1.765     raeburn  7403:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7404:             foreach my $item (@statuses) {
1.711     raeburn  7405:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7406:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7407:                         if ($defquota eq '') {
                   7408:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7409:                             $settingstatus = $item;
                   7410:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7411:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7412:                             $settingstatus = $item;
                   7413:                         }
                   7414:                     }
                   7415:                 } else {
                   7416:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7417:                         if ($defquota eq '') {
                   7418:                             $defquota = $quotahash{'quotas'}{$item};
                   7419:                             $settingstatus = $item;
                   7420:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7421:                             $defquota = $quotahash{'quotas'}{$item};
                   7422:                             $settingstatus = $item;
                   7423:                         }
1.536     raeburn  7424:                     }
                   7425:                 }
                   7426:             }
                   7427:         }
                   7428:         if ($defquota eq '') {
1.711     raeburn  7429:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7430:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7431:             } else {
                   7432:                 $defquota = $quotahash{'quotas'}{'default'};
                   7433:             }
1.536     raeburn  7434:             $settingstatus = 'default';
                   7435:         }
                   7436:     } else {
                   7437:         $settingstatus = 'default';
                   7438:         $defquota = 20;
                   7439:     }
                   7440:     if (wantarray) {
                   7441:         return ($defquota,$settingstatus);
1.472     raeburn  7442:     } else {
1.536     raeburn  7443:         return $defquota;
1.472     raeburn  7444:     }
                   7445: }
                   7446: 
1.384     raeburn  7447: sub get_secgrprole_info {
                   7448:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7449:     my %sections_count = &get_sections($cdom,$cnum);
                   7450:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7451:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7452:     my @groups = sort(keys(%curr_groups));
                   7453:     my $allroles = [];
                   7454:     my $rolehash;
                   7455:     my $accesshash = {
                   7456:                      active => 'Currently has access',
                   7457:                      future => 'Will have future access',
                   7458:                      previous => 'Previously had access',
                   7459:                   };
                   7460:     if ($needroles) {
                   7461:         $rolehash = {'all' => 'all'};
1.385     albertel 7462:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7463: 	if (&Apache::lonnet::error(%user_roles)) {
                   7464: 	    undef(%user_roles);
                   7465: 	}
                   7466:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7467:             my ($role)=split(/\:/,$item,2);
                   7468:             if ($role eq 'cr') { next; }
                   7469:             if ($role =~ /^cr/) {
                   7470:                 $$rolehash{$role} = (split('/',$role))[3];
                   7471:             } else {
                   7472:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7473:             }
                   7474:         }
                   7475:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7476:             push(@{$allroles},$key);
                   7477:         }
                   7478:         push (@{$allroles},'st');
                   7479:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7480:     }
                   7481:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7482: }
                   7483: 
1.555     raeburn  7484: sub user_picker {
1.627     raeburn  7485:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7486:     my $currdom = $dom;
                   7487:     my %curr_selected = (
                   7488:                         srchin => 'dom',
1.580     raeburn  7489:                         srchby => 'lastname',
1.555     raeburn  7490:                       );
                   7491:     my $srchterm;
1.625     raeburn  7492:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7493:         if ($srch->{'srchby'} ne '') {
                   7494:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7495:         }
                   7496:         if ($srch->{'srchin'} ne '') {
                   7497:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7498:         }
                   7499:         if ($srch->{'srchtype'} ne '') {
                   7500:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7501:         }
                   7502:         if ($srch->{'srchdomain'} ne '') {
                   7503:             $currdom = $srch->{'srchdomain'};
                   7504:         }
                   7505:         $srchterm = $srch->{'srchterm'};
                   7506:     }
                   7507:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7508:                     'usr'       => 'Search criteria',
1.563     raeburn  7509:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7510:                     'uname'     => 'username',
                   7511:                     'lastname'  => 'last name',
1.555     raeburn  7512:                     'lastfirst' => 'last name, first name',
1.558     albertel 7513:                     'crs'       => 'in this course',
1.576     raeburn  7514:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7515:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7516:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7517:                     'exact'     => 'is',
                   7518:                     'contains'  => 'contains',
1.569     raeburn  7519:                     'begins'    => 'begins with',
1.571     raeburn  7520:                     'youm'      => "You must include some text to search for.",
                   7521:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7522:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7523:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7524:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7525:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7526:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7527:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7528:                                        );
1.563     raeburn  7529:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7530:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7531: 
                   7532:     my @srchins = ('crs','dom','alc','instd');
                   7533: 
                   7534:     foreach my $option (@srchins) {
                   7535:         # FIXME 'alc' option unavailable until 
                   7536:         #       loncreateuser::print_user_query_page()
                   7537:         #       has been completed.
                   7538:         next if ($option eq 'alc');
1.880     raeburn  7539:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7540:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7541:         if ($curr_selected{'srchin'} eq $option) {
                   7542:             $srchinsel .= ' 
                   7543:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7544:         } else {
                   7545:             $srchinsel .= '
                   7546:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7547:         }
1.555     raeburn  7548:     }
1.563     raeburn  7549:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7550: 
                   7551:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7552:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7553:         if ($curr_selected{'srchby'} eq $option) {
                   7554:             $srchbysel .= '
                   7555:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7556:         } else {
                   7557:             $srchbysel .= '
                   7558:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7559:          }
                   7560:     }
                   7561:     $srchbysel .= "\n  </select>\n";
                   7562: 
                   7563:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7564:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7565:         if ($curr_selected{'srchtype'} eq $option) {
                   7566:             $srchtypesel .= '
                   7567:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7568:         } else {
                   7569:             $srchtypesel .= '
                   7570:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7571:         }
                   7572:     }
                   7573:     $srchtypesel .= "\n  </select>\n";
                   7574: 
1.558     albertel 7575:     my ($newuserscript,$new_user_create);
1.556     raeburn  7576: 
                   7577:     if ($forcenewuser) {
1.576     raeburn  7578:         if (ref($srch) eq 'HASH') {
                   7579:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7580:                 if ($cancreate) {
                   7581:                     $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>';
                   7582:                 } else {
1.799     bisitz   7583:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7584:                     my %usertypetext = (
                   7585:                         official   => 'institutional',
                   7586:                         unofficial => 'non-institutional',
                   7587:                     );
1.799     bisitz   7588:                     $new_user_create = '<p class="LC_warning">'
                   7589:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7590:                                       .' '
                   7591:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7592:                                           ,'<a href="'.$helplink.'">','</a>')
                   7593:                                       .'</p><br />';
1.627     raeburn  7594:                 }
1.576     raeburn  7595:             }
                   7596:         }
                   7597: 
1.556     raeburn  7598:         $newuserscript = <<"ENDSCRIPT";
                   7599: 
1.570     raeburn  7600: function setSearch(createnew,callingForm) {
1.556     raeburn  7601:     if (createnew == 1) {
1.570     raeburn  7602:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7603:             if (callingForm.srchby.options[i].value == 'uname') {
                   7604:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7605:             }
                   7606:         }
1.570     raeburn  7607:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7608:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7609: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7610:             }
                   7611:         }
1.570     raeburn  7612:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7613:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7614:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7615:             }
                   7616:         }
1.570     raeburn  7617:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7618:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7619:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7620:             }
                   7621:         }
                   7622:     }
                   7623: }
                   7624: ENDSCRIPT
1.558     albertel 7625: 
1.556     raeburn  7626:     }
                   7627: 
1.555     raeburn  7628:     my $output = <<"END_BLOCK";
1.556     raeburn  7629: <script type="text/javascript">
1.824     bisitz   7630: // <![CDATA[
1.570     raeburn  7631: function validateEntry(callingForm) {
1.558     albertel 7632: 
1.556     raeburn  7633:     var checkok = 1;
1.558     albertel 7634:     var srchin;
1.570     raeburn  7635:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7636: 	if ( callingForm.srchin[i].checked ) {
                   7637: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7638: 	}
                   7639:     }
                   7640: 
1.570     raeburn  7641:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7642:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7643:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7644:     var srchterm =  callingForm.srchterm.value;
                   7645:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7646:     var msg = "";
                   7647: 
                   7648:     if (srchterm == "") {
                   7649:         checkok = 0;
1.571     raeburn  7650:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7651:     }
                   7652: 
1.569     raeburn  7653:     if (srchtype== 'begins') {
                   7654:         if (srchterm.length < 2) {
                   7655:             checkok = 0;
1.571     raeburn  7656:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7657:         }
                   7658:     }
                   7659: 
1.556     raeburn  7660:     if (srchtype== 'contains') {
                   7661:         if (srchterm.length < 3) {
                   7662:             checkok = 0;
1.571     raeburn  7663:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7664:         }
                   7665:     }
                   7666:     if (srchin == 'instd') {
                   7667:         if (srchdomain == '') {
                   7668:             checkok = 0;
1.571     raeburn  7669:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7670:         }
                   7671:     }
                   7672:     if (srchin == 'dom') {
                   7673:         if (srchdomain == '') {
                   7674:             checkok = 0;
1.571     raeburn  7675:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7676:         }
                   7677:     }
                   7678:     if (srchby == 'lastfirst') {
                   7679:         if (srchterm.indexOf(",") == -1) {
                   7680:             checkok = 0;
1.571     raeburn  7681:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7682:         }
                   7683:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7684:             checkok = 0;
1.571     raeburn  7685:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7686:         }
                   7687:     }
                   7688:     if (checkok == 0) {
1.571     raeburn  7689:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7690:         return;
                   7691:     }
                   7692:     if (checkok == 1) {
1.570     raeburn  7693:         callingForm.submit();
1.556     raeburn  7694:     }
                   7695: }
                   7696: 
                   7697: $newuserscript
                   7698: 
1.824     bisitz   7699: // ]]>
1.556     raeburn  7700: </script>
1.558     albertel 7701: 
                   7702: $new_user_create
                   7703: 
1.555     raeburn  7704: END_BLOCK
1.558     albertel 7705: 
1.876     raeburn  7706:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7707:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7708:                $domform.
                   7709:                &Apache::lonhtmlcommon::row_closure().
                   7710:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7711:                $srchbysel.
                   7712:                $srchtypesel. 
                   7713:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7714:                $srchinsel.
                   7715:                &Apache::lonhtmlcommon::row_closure(1). 
                   7716:                &Apache::lonhtmlcommon::end_pick_box().
                   7717:                '<br />';
1.555     raeburn  7718:     return $output;
                   7719: }
                   7720: 
1.612     raeburn  7721: sub user_rule_check {
1.615     raeburn  7722:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7723:     my $response;
                   7724:     if (ref($usershash) eq 'HASH') {
                   7725:         foreach my $user (keys(%{$usershash})) {
                   7726:             my ($uname,$udom) = split(/:/,$user);
                   7727:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7728:             my ($id,$newuser);
1.612     raeburn  7729:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7730:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7731:                 $id = $usershash->{$user}->{'id'};
                   7732:             }
                   7733:             my $inst_response;
                   7734:             if (ref($checks) eq 'HASH') {
                   7735:                 if (defined($checks->{'username'})) {
1.615     raeburn  7736:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7737:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7738:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7739:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7740:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7741:                 }
1.615     raeburn  7742:             } else {
                   7743:                 ($inst_response,%{$inst_results->{$user}}) =
                   7744:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7745:                 return;
1.612     raeburn  7746:             }
1.615     raeburn  7747:             if (!$got_rules->{$udom}) {
1.612     raeburn  7748:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7749:                                                   ['usercreation'],$udom);
                   7750:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7751:                     foreach my $item ('username','id') {
1.612     raeburn  7752:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7753:                             $$curr_rules{$udom}{$item} = 
                   7754:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7755:                         }
                   7756:                     }
                   7757:                 }
1.615     raeburn  7758:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7759:             }
1.612     raeburn  7760:             foreach my $item (keys(%{$checks})) {
                   7761:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7762:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7763:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7764:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7765:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7766:                                 if ($rule_check{$rule}) {
                   7767:                                     $$rulematch{$user}{$item} = $rule;
                   7768:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7769:                                         if (ref($inst_results) eq 'HASH') {
                   7770:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7771:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7772:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7773:                                                 }
1.612     raeburn  7774:                                             }
                   7775:                                         }
1.615     raeburn  7776:                                     }
                   7777:                                     last;
1.585     raeburn  7778:                                 }
                   7779:                             }
                   7780:                         }
                   7781:                     }
                   7782:                 }
                   7783:             }
                   7784:         }
                   7785:     }
1.612     raeburn  7786:     return;
                   7787: }
                   7788: 
                   7789: sub user_rule_formats {
                   7790:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7791:     my %text = ( 
                   7792:                  'username' => 'Usernames',
                   7793:                  'id'       => 'IDs',
                   7794:                );
                   7795:     my $output;
                   7796:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7797:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7798:         if (@{$ruleorder} > 0) {
                   7799:             $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>';
                   7800:             foreach my $rule (@{$ruleorder}) {
                   7801:                 if (ref($curr_rules) eq 'ARRAY') {
                   7802:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7803:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7804:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7805:                                         $rules->{$rule}{'desc'}.'</li>';
                   7806:                         }
                   7807:                     }
                   7808:                 }
                   7809:             }
                   7810:             $output .= '</ul>';
                   7811:         }
                   7812:     }
                   7813:     return $output;
                   7814: }
                   7815: 
                   7816: sub instrule_disallow_msg {
1.615     raeburn  7817:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7818:     my $response;
                   7819:     my %text = (
                   7820:                   item   => 'username',
                   7821:                   items  => 'usernames',
                   7822:                   match  => 'matches',
                   7823:                   do     => 'does',
                   7824:                   action => 'a username',
                   7825:                   one    => 'one',
                   7826:                );
                   7827:     if ($count > 1) {
                   7828:         $text{'item'} = 'usernames';
                   7829:         $text{'match'} ='match';
                   7830:         $text{'do'} = 'do';
                   7831:         $text{'action'} = 'usernames',
                   7832:         $text{'one'} = 'ones';
                   7833:     }
                   7834:     if ($checkitem eq 'id') {
                   7835:         $text{'items'} = 'IDs';
                   7836:         $text{'item'} = 'ID';
                   7837:         $text{'action'} = 'an ID';
1.615     raeburn  7838:         if ($count > 1) {
                   7839:             $text{'item'} = 'IDs';
                   7840:             $text{'action'} = 'IDs';
                   7841:         }
1.612     raeburn  7842:     }
1.674     bisitz   7843:     $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  7844:     if ($mode eq 'upload') {
                   7845:         if ($checkitem eq 'username') {
                   7846:             $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'}.");
                   7847:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7848:             $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  7849:         }
1.669     raeburn  7850:     } elsif ($mode eq 'selfcreate') {
                   7851:         if ($checkitem eq 'id') {
                   7852:             $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.");
                   7853:         }
1.615     raeburn  7854:     } else {
                   7855:         if ($checkitem eq 'username') {
                   7856:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7857:         } elsif ($checkitem eq 'id') {
                   7858:             $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.");
                   7859:         }
1.612     raeburn  7860:     }
                   7861:     return $response;
1.585     raeburn  7862: }
                   7863: 
1.624     raeburn  7864: sub personal_data_fieldtitles {
                   7865:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7866:                         id => 'Student/Employee ID',
                   7867:                         permanentemail => 'E-mail address',
                   7868:                         lastname => 'Last Name',
                   7869:                         firstname => 'First Name',
                   7870:                         middlename => 'Middle Name',
                   7871:                         generation => 'Generation',
                   7872:                         gen => 'Generation',
1.765     raeburn  7873:                         inststatus => 'Affiliation',
1.624     raeburn  7874:                    );
                   7875:     return %fieldtitles;
                   7876: }
                   7877: 
1.642     raeburn  7878: sub sorted_inst_types {
                   7879:     my ($dom) = @_;
                   7880:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7881:     my $othertitle = &mt('All users');
                   7882:     if ($env{'request.course.id'}) {
1.668     raeburn  7883:         $othertitle  = &mt('Any users');
1.642     raeburn  7884:     }
                   7885:     my @types;
                   7886:     if (ref($order) eq 'ARRAY') {
                   7887:         @types = @{$order};
                   7888:     }
                   7889:     if (@types == 0) {
                   7890:         if (ref($usertypes) eq 'HASH') {
                   7891:             @types = sort(keys(%{$usertypes}));
                   7892:         }
                   7893:     }
                   7894:     if (keys(%{$usertypes}) > 0) {
                   7895:         $othertitle = &mt('Other users');
                   7896:     }
                   7897:     return ($othertitle,$usertypes,\@types);
                   7898: }
                   7899: 
1.645     raeburn  7900: sub get_institutional_codes {
                   7901:     my ($settings,$allcourses,$LC_code) = @_;
                   7902: # Get complete list of course sections to update
                   7903:     my @currsections = ();
                   7904:     my @currxlists = ();
                   7905:     my $coursecode = $$settings{'internal.coursecode'};
                   7906: 
                   7907:     if ($$settings{'internal.sectionnums'} ne '') {
                   7908:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7909:     }
                   7910: 
                   7911:     if ($$settings{'internal.crosslistings'} ne '') {
                   7912:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7913:     }
                   7914: 
                   7915:     if (@currxlists > 0) {
                   7916:         foreach (@currxlists) {
                   7917:             if (m/^([^:]+):(\w*)$/) {
                   7918:                 unless (grep/^$1$/,@{$allcourses}) {
                   7919:                     push @{$allcourses},$1;
                   7920:                     $$LC_code{$1} = $2;
                   7921:                 }
                   7922:             }
                   7923:         }
                   7924:     }
                   7925:  
                   7926:     if (@currsections > 0) {
                   7927:         foreach (@currsections) {
                   7928:             if (m/^(\w+):(\w*)$/) {
                   7929:                 my $sec = $coursecode.$1;
                   7930:                 my $lc_sec = $2;
                   7931:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7932:                     push @{$allcourses},$sec;
                   7933:                     $$LC_code{$sec} = $lc_sec;
                   7934:                 }
                   7935:             }
                   7936:         }
                   7937:     }
                   7938:     return;
                   7939: }
                   7940: 
1.112     bowersj2 7941: =pod
                   7942: 
1.780     raeburn  7943: =head1 Slot Helpers
                   7944: 
                   7945: =over 4
                   7946: 
                   7947: =item * sorted_slots()
                   7948: 
                   7949: Sorts an array of slot names in order of slot start time (earliest first). 
                   7950: 
                   7951: Inputs:
                   7952: 
                   7953: =over 4
                   7954: 
                   7955: slotsarr  - Reference to array of unsorted slot names.
                   7956: 
                   7957: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7958: 
1.549     albertel 7959: =back
                   7960: 
1.780     raeburn  7961: Returns:
                   7962: 
                   7963: =over 4
                   7964: 
                   7965: sorted   - An array of slot names sorted by the start time of the slot.
                   7966: 
                   7967: =back
                   7968: 
                   7969: =back
                   7970: 
                   7971: =cut
                   7972: 
                   7973: 
                   7974: sub sorted_slots {
                   7975:     my ($slotsarr,$slots) = @_;
                   7976:     my @sorted;
                   7977:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7978:         @sorted =
                   7979:             sort {
                   7980:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7981:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7982:                      }
                   7983:                      if (ref($slots->{$a})) { return -1;}
                   7984:                      if (ref($slots->{$b})) { return 1;}
                   7985:                      return 0;
                   7986:                  } @{$slotsarr};
                   7987:     }
                   7988:     return @sorted;
                   7989: }
                   7990: 
                   7991: 
                   7992: =pod
                   7993: 
1.549     albertel 7994: =head1 HTTP Helpers
                   7995: 
                   7996: =over 4
                   7997: 
1.648     raeburn  7998: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 7999: 
1.258     albertel 8000: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8001: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8002: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8003: 
                   8004: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8005: $possible_names is an ref to an array of form element names.  As an example:
                   8006: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8007: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8008: 
                   8009: =cut
1.1       albertel 8010: 
1.6       albertel 8011: sub get_unprocessed_cgi {
1.25      albertel 8012:   my ($query,$possible_names)= @_;
1.26      matthew  8013:   # $Apache::lonxml::debug=1;
1.356     albertel 8014:   foreach my $pair (split(/&/,$query)) {
                   8015:     my ($name, $value) = split(/=/,$pair);
1.369     www      8016:     $name = &unescape($name);
1.25      albertel 8017:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8018:       $value =~ tr/+/ /;
                   8019:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8020:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8021:     }
1.16      harris41 8022:   }
1.6       albertel 8023: }
                   8024: 
1.112     bowersj2 8025: =pod
                   8026: 
1.648     raeburn  8027: =item * &cacheheader() 
1.112     bowersj2 8028: 
                   8029: returns cache-controlling header code
                   8030: 
                   8031: =cut
                   8032: 
1.7       albertel 8033: sub cacheheader {
1.258     albertel 8034:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8035:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8036:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8037:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8038:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8039:     return $output;
1.7       albertel 8040: }
                   8041: 
1.112     bowersj2 8042: =pod
                   8043: 
1.648     raeburn  8044: =item * &no_cache($r) 
1.112     bowersj2 8045: 
                   8046: specifies header code to not have cache
                   8047: 
                   8048: =cut
                   8049: 
1.9       albertel 8050: sub no_cache {
1.216     albertel 8051:     my ($r) = @_;
                   8052:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8053: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8054:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8055:     $r->no_cache(1);
                   8056:     $r->header_out("Expires" => $date);
                   8057:     $r->header_out("Pragma" => "no-cache");
1.123     www      8058: }
                   8059: 
                   8060: sub content_type {
1.181     albertel 8061:     my ($r,$type,$charset) = @_;
1.299     foxr     8062:     if ($r) {
                   8063: 	#  Note that printout.pl calls this with undef for $r.
                   8064: 	&no_cache($r);
                   8065:     }
1.258     albertel 8066:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8067:     unless ($charset) {
                   8068: 	$charset=&Apache::lonlocal::current_encoding;
                   8069:     }
                   8070:     if ($charset) { $type.='; charset='.$charset; }
                   8071:     if ($r) {
                   8072: 	$r->content_type($type);
                   8073:     } else {
                   8074: 	print("Content-type: $type\n\n");
                   8075:     }
1.9       albertel 8076: }
1.25      albertel 8077: 
1.112     bowersj2 8078: =pod
                   8079: 
1.648     raeburn  8080: =item * &add_to_env($name,$value) 
1.112     bowersj2 8081: 
1.258     albertel 8082: adds $name to the %env hash with value
1.112     bowersj2 8083: $value, if $name already exists, the entry is converted to an array
                   8084: reference and $value is added to the array.
                   8085: 
                   8086: =cut
                   8087: 
1.25      albertel 8088: sub add_to_env {
                   8089:   my ($name,$value)=@_;
1.258     albertel 8090:   if (defined($env{$name})) {
                   8091:     if (ref($env{$name})) {
1.25      albertel 8092:       #already have multiple values
1.258     albertel 8093:       push(@{ $env{$name} },$value);
1.25      albertel 8094:     } else {
                   8095:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8096:       my $first=$env{$name};
                   8097:       undef($env{$name});
                   8098:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8099:     }
                   8100:   } else {
1.258     albertel 8101:     $env{$name}=$value;
1.25      albertel 8102:   }
1.31      albertel 8103: }
1.149     albertel 8104: 
                   8105: =pod
                   8106: 
1.648     raeburn  8107: =item * &get_env_multiple($name) 
1.149     albertel 8108: 
1.258     albertel 8109: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8110: values may be defined and end up as an array ref.
                   8111: 
                   8112: returns an array of values
                   8113: 
                   8114: =cut
                   8115: 
                   8116: sub get_env_multiple {
                   8117:     my ($name) = @_;
                   8118:     my @values;
1.258     albertel 8119:     if (defined($env{$name})) {
1.149     albertel 8120:         # exists is it an array
1.258     albertel 8121:         if (ref($env{$name})) {
                   8122:             @values=@{ $env{$name} };
1.149     albertel 8123:         } else {
1.258     albertel 8124:             $values[0]=$env{$name};
1.149     albertel 8125:         }
                   8126:     }
                   8127:     return(@values);
                   8128: }
                   8129: 
1.660     raeburn  8130: sub ask_for_embedded_content {
                   8131:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8132:     my $upload_output = '
                   8133:    <form name="upload_embedded" action="'.$actionurl.'"
                   8134:                   method="post" enctype="multipart/form-data">';
                   8135:     $upload_output .= $state;
1.661     raeburn  8136:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8137: 
                   8138:     my $num = 0;
                   8139:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8140:         $upload_output .= &start_data_table_row().
                   8141:             '<td>'.$embed_file.'</td><td>';
                   8142:         if ($args->{'ignore_remote_references'}
                   8143:             && $embed_file =~ m{^\w+://}) {
                   8144:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8145:         } elsif ($args->{'error_on_invalid_names'}
                   8146:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8147: 
                   8148:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8149: 
                   8150:         } else {
                   8151:             $upload_output .='
1.661     raeburn  8152:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8153:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8154:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8155:             $upload_output .=
                   8156:                 "\n\t\t".
                   8157:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8158:                 $attrib.'" />';
                   8159:             if (exists($$codebase{$embed_file})) {
                   8160:                 $upload_output .=
                   8161:                     "\n\t\t".
                   8162:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8163:                     &escape($$codebase{$embed_file}).'" />';
                   8164:             }
                   8165:         }
                   8166:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8167:         $num++;
                   8168:     }
                   8169:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8170:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8171:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8172:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8173:    </form>';
                   8174:     return $upload_output;
                   8175: }
                   8176: 
1.661     raeburn  8177: sub upload_embedded {
                   8178:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8179:         $current_disk_usage) = @_;
                   8180:     my $output;
                   8181:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8182:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8183:         my $orig_uploaded_filename =
                   8184:             $env{'form.embedded_item_'.$i.'.filename'};
                   8185: 
                   8186:         $env{'form.embedded_orig_'.$i} =
                   8187:             &unescape($env{'form.embedded_orig_'.$i});
                   8188:         my ($path,$fname) =
                   8189:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8190:         # no path, whole string is fname
                   8191:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8192: 
                   8193:         $path = $env{'form.currentpath'}.$path;
                   8194:         $fname = &Apache::lonnet::clean_filename($fname);
                   8195:         # See if there is anything left
                   8196:         next if ($fname eq '');
                   8197: 
                   8198:         # Check if file already exists as a file or directory.
                   8199:         my ($state,$msg);
                   8200:         if ($context eq 'portfolio') {
                   8201:             my $port_path = $dirpath;
                   8202:             if ($group ne '') {
                   8203:                 $port_path = "groups/$group/$port_path";
                   8204:             }
                   8205:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8206:                                               $dir_root,$port_path,$disk_quota,
                   8207:                                               $current_disk_usage,$uname,$udom);
                   8208:             if ($state eq 'will_exceed_quota'
                   8209:                 || $state eq 'file_locked'
                   8210:                 || $state eq 'file_exists' ) {
                   8211:                 $output .= $msg;
                   8212:                 next;
                   8213:             }
                   8214:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8215:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8216:             if ($state eq 'exists') {
                   8217:                 $output .= $msg;
                   8218:                 next;
                   8219:             }
                   8220:         }
                   8221:         # Check if extension is valid
                   8222:         if (($fname =~ /\.(\w+)$/) &&
                   8223:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8224:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8225:             next;
                   8226:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8227:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8228:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8229:             next;
                   8230:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8231:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8232:             next;
                   8233:         }
                   8234: 
                   8235:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8236:         if ($context eq 'portfolio') {
                   8237:             my $result=
                   8238:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8239:                                                 $dirpath.$path);
                   8240:             if ($result !~ m|^/uploaded/|) {
                   8241:                 $output .= '<span class="LC_error">'
                   8242:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8243:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8244:                       .'</span><br />';
                   8245:                 next;
                   8246:             } else {
                   8247:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8248:                            $path.$fname.'</span>').'</p>';     
                   8249:             }
                   8250:         } else {
                   8251: # Save the file
                   8252:             my $target = $env{'form.embedded_item_'.$i};
                   8253:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8254:             my $dest = $fullpath.$fname;
                   8255:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8256:             my @parts=split(/\//,$fullpath);
                   8257:             my $count;
                   8258:             my $filepath = $dir_root;
                   8259:             for ($count=4;$count<=$#parts;$count++) {
                   8260:                 $filepath .= "/$parts[$count]";
                   8261:                 if ((-e $filepath)!=1) {
                   8262:                     mkdir($filepath,0770);
                   8263:                 }
                   8264:             }
                   8265:             my $fh;
                   8266:             if (!open($fh,'>'.$dest)) {
                   8267:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8268:                 $output .= '<span class="LC_error">'.
                   8269:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8270:                            '</span><br />';
                   8271:             } else {
                   8272:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8273:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8274:                     $output .= '<span class="LC_error">'.
                   8275:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8276:                               '</span><br />';
                   8277:                 } else {
                   8278:                     if ($context eq 'testbank') {
                   8279:                         $output .= &mt('Embedded file uploaded successfully:').
                   8280:                                    '&nbsp;<a href="'.$url.'">'.
                   8281:                                    $orig_uploaded_filename.'</a><br />';
                   8282:                     } else {
1.705     tempelho 8283:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8284:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8285:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8286:                     }
                   8287:                 }
                   8288:                 close($fh);
                   8289:             }
                   8290:         }
                   8291:     }
                   8292:     return $output;
                   8293: }
                   8294: 
                   8295: sub check_for_existing {
                   8296:     my ($path,$fname,$element) = @_;
                   8297:     my ($state,$msg);
                   8298:     if (-d $path.'/'.$fname) {
                   8299:         $state = 'exists';
                   8300:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8301:     } elsif (-e $path.'/'.$fname) {
                   8302:         $state = 'exists';
                   8303:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8304:     }
                   8305:     if ($state eq 'exists') {
                   8306:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8307:     }
                   8308:     return ($state,$msg);
                   8309: }
                   8310: 
                   8311: sub check_for_upload {
                   8312:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8313:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8314:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8315:     my $getpropath = 1;
                   8316:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8317:                                             $getpropath);
                   8318:     my $found_file = 0;
                   8319:     my $locked_file = 0;
                   8320:     foreach my $line (@dir_list) {
                   8321:         my ($file_name)=split(/\&/,$line,2);
                   8322:         if ($file_name eq $fname){
                   8323:             $file_name = $path.$file_name;
                   8324:             if ($group ne '') {
                   8325:                 $file_name = $group.$file_name;
                   8326:             }
                   8327:             $found_file = 1;
                   8328:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8329:                 $locked_file = 1;
                   8330:             }
                   8331:         }
                   8332:     }
                   8333:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8334:         my $msg = '<span class="LC_error">'.
                   8335:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8336:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8337:         return ('will_exceed_quota',$msg);
                   8338:     } elsif ($found_file) {
                   8339:         if ($locked_file) {
                   8340:             my $msg = '<span class="LC_error">';
                   8341:             $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>');
                   8342:             $msg .= '</span><br />';
                   8343:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8344:             return ('file_locked',$msg);
                   8345:         } else {
                   8346:             my $msg = '<span class="LC_error">';
                   8347:             $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'});
                   8348:             $msg .= '</span>';
                   8349:             $msg .= '<br />';
                   8350:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8351:             return ('file_exists',$msg);
                   8352:         }
                   8353:     }
                   8354: }
                   8355: 
1.31      albertel 8356: 
1.41      ng       8357: =pod
1.45      matthew  8358: 
1.464     albertel 8359: =back
1.41      ng       8360: 
1.112     bowersj2 8361: =head1 CSV Upload/Handling functions
1.38      albertel 8362: 
1.41      ng       8363: =over 4
                   8364: 
1.648     raeburn  8365: =item * &upfile_store($r)
1.41      ng       8366: 
                   8367: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8368: needs $env{'form.upfile'}
1.41      ng       8369: returns $datatoken to be put into hidden field
                   8370: 
                   8371: =cut
1.31      albertel 8372: 
                   8373: sub upfile_store {
                   8374:     my $r=shift;
1.258     albertel 8375:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8376:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8377:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8378:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8379: 
1.258     albertel 8380:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8381: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8382:     {
1.158     raeburn  8383:         my $datafile = $r->dir_config('lonDaemons').
                   8384:                            '/tmp/'.$datatoken.'.tmp';
                   8385:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8386:             print $fh $env{'form.upfile'};
1.158     raeburn  8387:             close($fh);
                   8388:         }
1.31      albertel 8389:     }
                   8390:     return $datatoken;
                   8391: }
                   8392: 
1.56      matthew  8393: =pod
                   8394: 
1.648     raeburn  8395: =item * &load_tmp_file($r)
1.41      ng       8396: 
                   8397: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8398: needs $env{'form.datatoken'},
                   8399: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8400: 
                   8401: =cut
1.31      albertel 8402: 
                   8403: sub load_tmp_file {
                   8404:     my $r=shift;
                   8405:     my @studentdata=();
                   8406:     {
1.158     raeburn  8407:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8408:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8409:         if ( open(my $fh,"<$studentfile") ) {
                   8410:             @studentdata=<$fh>;
                   8411:             close($fh);
                   8412:         }
1.31      albertel 8413:     }
1.258     albertel 8414:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8415: }
                   8416: 
1.56      matthew  8417: =pod
                   8418: 
1.648     raeburn  8419: =item * &upfile_record_sep()
1.41      ng       8420: 
                   8421: Separate uploaded file into records
                   8422: returns array of records,
1.258     albertel 8423: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8424: 
                   8425: =cut
1.31      albertel 8426: 
                   8427: sub upfile_record_sep {
1.258     albertel 8428:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8429:     } else {
1.248     albertel 8430: 	my @records;
1.258     albertel 8431: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8432: 	    if ($line=~/^\s*$/) { next; }
                   8433: 	    push(@records,$line);
                   8434: 	}
                   8435: 	return @records;
1.31      albertel 8436:     }
                   8437: }
                   8438: 
1.56      matthew  8439: =pod
                   8440: 
1.648     raeburn  8441: =item * &record_sep($record)
1.41      ng       8442: 
1.258     albertel 8443: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8444: 
                   8445: =cut
                   8446: 
1.263     www      8447: sub takeleft {
                   8448:     my $index=shift;
                   8449:     return substr('0000'.$index,-4,4);
                   8450: }
                   8451: 
1.31      albertel 8452: sub record_sep {
                   8453:     my $record=shift;
                   8454:     my %components=();
1.258     albertel 8455:     if ($env{'form.upfiletype'} eq 'xml') {
                   8456:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8457:         my $i=0;
1.356     albertel 8458:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8459:             $field=~s/^(\"|\')//;
                   8460:             $field=~s/(\"|\')$//;
1.263     www      8461:             $components{&takeleft($i)}=$field;
1.31      albertel 8462:             $i++;
                   8463:         }
1.258     albertel 8464:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8465:         my $i=0;
1.356     albertel 8466:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8467:             $field=~s/^(\"|\')//;
                   8468:             $field=~s/(\"|\')$//;
1.263     www      8469:             $components{&takeleft($i)}=$field;
1.31      albertel 8470:             $i++;
                   8471:         }
                   8472:     } else {
1.561     www      8473:         my $separator=',';
1.480     banghart 8474:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8475:             $separator=';';
1.480     banghart 8476:         }
1.31      albertel 8477:         my $i=0;
1.561     www      8478: # the character we are looking for to indicate the end of a quote or a record 
                   8479:         my $looking_for=$separator;
                   8480: # do not add the characters to the fields
                   8481:         my $ignore=0;
                   8482: # we just encountered a separator (or the beginning of the record)
                   8483:         my $just_found_separator=1;
                   8484: # store the field we are working on here
                   8485:         my $field='';
                   8486: # work our way through all characters in record
                   8487:         foreach my $character ($record=~/(.)/g) {
                   8488:             if ($character eq $looking_for) {
                   8489:                if ($character ne $separator) {
                   8490: # Found the end of a quote, again looking for separator
                   8491:                   $looking_for=$separator;
                   8492:                   $ignore=1;
                   8493:                } else {
                   8494: # Found a separator, store away what we got
                   8495:                   $components{&takeleft($i)}=$field;
                   8496: 	          $i++;
                   8497:                   $just_found_separator=1;
                   8498:                   $ignore=0;
                   8499:                   $field='';
                   8500:                }
                   8501:                next;
                   8502:             }
                   8503: # single or double quotation marks after a separator indicate beginning of a quote
                   8504: # we are now looking for the end of the quote and need to ignore separators
                   8505:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8506:                $looking_for=$character;
                   8507:                next;
                   8508:             }
                   8509: # ignore would be true after we reached the end of a quote
                   8510:             if ($ignore) { next; }
                   8511:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8512:             $field.=$character;
                   8513:             $just_found_separator=0; 
1.31      albertel 8514:         }
1.561     www      8515: # catch the very last entry, since we never encountered the separator
                   8516:         $components{&takeleft($i)}=$field;
1.31      albertel 8517:     }
                   8518:     return %components;
                   8519: }
                   8520: 
1.144     matthew  8521: ######################################################
                   8522: ######################################################
                   8523: 
1.56      matthew  8524: =pod
                   8525: 
1.648     raeburn  8526: =item * &upfile_select_html()
1.41      ng       8527: 
1.144     matthew  8528: Return HTML code to select a file from the users machine and specify 
                   8529: the file type.
1.41      ng       8530: 
                   8531: =cut
                   8532: 
1.144     matthew  8533: ######################################################
                   8534: ######################################################
1.31      albertel 8535: sub upfile_select_html {
1.144     matthew  8536:     my %Types = (
                   8537:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8538:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8539:                  space => &mt('Space separated'),
                   8540:                  tab   => &mt('Tabulator separated'),
                   8541: #                 xml   => &mt('HTML/XML'),
                   8542:                  );
                   8543:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8544:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8545:     foreach my $type (sort(keys(%Types))) {
                   8546:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8547:     }
                   8548:     $Str .= "</select>\n";
                   8549:     return $Str;
1.31      albertel 8550: }
                   8551: 
1.301     albertel 8552: sub get_samples {
                   8553:     my ($records,$toget) = @_;
                   8554:     my @samples=({});
                   8555:     my $got=0;
                   8556:     foreach my $rec (@$records) {
                   8557: 	my %temp = &record_sep($rec);
                   8558: 	if (! grep(/\S/, values(%temp))) { next; }
                   8559: 	if (%temp) {
                   8560: 	    $samples[$got]=\%temp;
                   8561: 	    $got++;
                   8562: 	    if ($got == $toget) { last; }
                   8563: 	}
                   8564:     }
                   8565:     return \@samples;
                   8566: }
                   8567: 
1.144     matthew  8568: ######################################################
                   8569: ######################################################
                   8570: 
1.56      matthew  8571: =pod
                   8572: 
1.648     raeburn  8573: =item * &csv_print_samples($r,$records)
1.41      ng       8574: 
                   8575: Prints a table of sample values from each column uploaded $r is an
                   8576: Apache Request ref, $records is an arrayref from
                   8577: &Apache::loncommon::upfile_record_sep
                   8578: 
                   8579: =cut
                   8580: 
1.144     matthew  8581: ######################################################
                   8582: ######################################################
1.31      albertel 8583: sub csv_print_samples {
                   8584:     my ($r,$records) = @_;
1.662     bisitz   8585:     my $samples = &get_samples($records,5);
1.301     albertel 8586: 
1.594     raeburn  8587:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8588:               &start_data_table_header_row());
1.356     albertel 8589:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8590:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8591:     $r->print(&end_data_table_header_row());
1.301     albertel 8592:     foreach my $hash (@$samples) {
1.594     raeburn  8593: 	$r->print(&start_data_table_row());
1.356     albertel 8594: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8595: 	    $r->print('<td>');
1.356     albertel 8596: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8597: 	    $r->print('</td>');
                   8598: 	}
1.594     raeburn  8599: 	$r->print(&end_data_table_row());
1.31      albertel 8600:     }
1.594     raeburn  8601:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8602: }
                   8603: 
1.144     matthew  8604: ######################################################
                   8605: ######################################################
                   8606: 
1.56      matthew  8607: =pod
                   8608: 
1.648     raeburn  8609: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8610: 
                   8611: Prints a table to create associations between values and table columns.
1.144     matthew  8612: 
1.41      ng       8613: $r is an Apache Request ref,
                   8614: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8615: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8616: 
                   8617: =cut
                   8618: 
1.144     matthew  8619: ######################################################
                   8620: ######################################################
1.31      albertel 8621: sub csv_print_select_table {
                   8622:     my ($r,$records,$d) = @_;
1.301     albertel 8623:     my $i=0;
                   8624:     my $samples = &get_samples($records,1);
1.144     matthew  8625:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8626: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8627:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8628:               '<th>'.&mt('Column').'</th>'.
                   8629:               &end_data_table_header_row()."\n");
1.356     albertel 8630:     foreach my $array_ref (@$d) {
                   8631: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8632: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8633: 
1.875     bisitz   8634: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8635: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8636: 	$r->print('<option value="none"></option>');
1.356     albertel 8637: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8638: 	    $r->print('<option value="'.$sample.'"'.
                   8639:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8640:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8641: 	}
1.594     raeburn  8642: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8643: 	$i++;
                   8644:     }
1.594     raeburn  8645:     $r->print(&end_data_table());
1.31      albertel 8646:     $i--;
                   8647:     return $i;
                   8648: }
1.56      matthew  8649: 
1.144     matthew  8650: ######################################################
                   8651: ######################################################
                   8652: 
1.56      matthew  8653: =pod
1.31      albertel 8654: 
1.648     raeburn  8655: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8656: 
                   8657: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8658: 
                   8659: $r is an Apache Request ref,
                   8660: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8661: $d is an array of 2 element arrays (internal name, displayed name)
                   8662: 
                   8663: =cut
                   8664: 
1.144     matthew  8665: ######################################################
                   8666: ######################################################
1.31      albertel 8667: sub csv_samples_select_table {
                   8668:     my ($r,$records,$d) = @_;
                   8669:     my $i=0;
1.144     matthew  8670:     #
1.662     bisitz   8671:     my $max_samples = 5;
                   8672:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8673:     $r->print(&start_data_table().
                   8674:               &start_data_table_header_row().'<th>'.
                   8675:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8676:               &end_data_table_header_row());
1.301     albertel 8677: 
                   8678:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8679: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8680: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8681: 	foreach my $option (@$d) {
                   8682: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8683: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8684:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8685:                       $display.'</option>');
1.31      albertel 8686: 	}
                   8687: 	$r->print('</select></td><td>');
1.662     bisitz   8688: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8689: 	    if (defined($samples->[$line]{$key})) { 
                   8690: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8691: 	    }
                   8692: 	}
1.594     raeburn  8693: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8694: 	$i++;
                   8695:     }
1.594     raeburn  8696:     $r->print(&end_data_table());
1.31      albertel 8697:     $i--;
                   8698:     return($i);
1.115     matthew  8699: }
                   8700: 
1.144     matthew  8701: ######################################################
                   8702: ######################################################
                   8703: 
1.115     matthew  8704: =pod
                   8705: 
1.648     raeburn  8706: =item * &clean_excel_name($name)
1.115     matthew  8707: 
                   8708: Returns a replacement for $name which does not contain any illegal characters.
                   8709: 
                   8710: =cut
                   8711: 
1.144     matthew  8712: ######################################################
                   8713: ######################################################
1.115     matthew  8714: sub clean_excel_name {
                   8715:     my ($name) = @_;
                   8716:     $name =~ s/[:\*\?\/\\]//g;
                   8717:     if (length($name) > 31) {
                   8718:         $name = substr($name,0,31);
                   8719:     }
                   8720:     return $name;
1.25      albertel 8721: }
1.84      albertel 8722: 
1.85      albertel 8723: =pod
                   8724: 
1.648     raeburn  8725: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8726: 
                   8727: Returns either 1 or undef
                   8728: 
                   8729: 1 if the part is to be hidden, undef if it is to be shown
                   8730: 
                   8731: Arguments are:
                   8732: 
                   8733: $id the id of the part to be checked
                   8734: $symb, optional the symb of the resource to check
                   8735: $udom, optional the domain of the user to check for
                   8736: $uname, optional the username of the user to check for
                   8737: 
                   8738: =cut
1.84      albertel 8739: 
                   8740: sub check_if_partid_hidden {
                   8741:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8742:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8743: 					 $symb,$udom,$uname);
1.141     albertel 8744:     my $truth=1;
                   8745:     #if the string starts with !, then the list is the list to show not hide
                   8746:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8747:     my @hiddenlist=split(/,/,$hiddenparts);
                   8748:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8749: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8750:     }
1.141     albertel 8751:     return !$truth;
1.84      albertel 8752: }
1.127     matthew  8753: 
1.138     matthew  8754: 
                   8755: ############################################################
                   8756: ############################################################
                   8757: 
                   8758: =pod
                   8759: 
1.157     matthew  8760: =back 
                   8761: 
1.138     matthew  8762: =head1 cgi-bin script and graphing routines
                   8763: 
1.157     matthew  8764: =over 4
                   8765: 
1.648     raeburn  8766: =item * &get_cgi_id()
1.138     matthew  8767: 
                   8768: Inputs: none
                   8769: 
                   8770: Returns an id which can be used to pass environment variables
                   8771: to various cgi-bin scripts.  These environment variables will
                   8772: be removed from the users environment after a given time by
                   8773: the routine &Apache::lonnet::transfer_profile_to_env.
                   8774: 
                   8775: =cut
                   8776: 
                   8777: ############################################################
                   8778: ############################################################
1.152     albertel 8779: my $uniq=0;
1.136     matthew  8780: sub get_cgi_id {
1.154     albertel 8781:     $uniq=($uniq+1)%100000;
1.280     albertel 8782:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8783: }
                   8784: 
1.127     matthew  8785: ############################################################
                   8786: ############################################################
                   8787: 
                   8788: =pod
                   8789: 
1.648     raeburn  8790: =item * &DrawBarGraph()
1.127     matthew  8791: 
1.138     matthew  8792: Facilitates the plotting of data in a (stacked) bar graph.
                   8793: Puts plot definition data into the users environment in order for 
                   8794: graph.png to plot it.  Returns an <img> tag for the plot.
                   8795: The bars on the plot are labeled '1','2',...,'n'.
                   8796: 
                   8797: Inputs:
                   8798: 
                   8799: =over 4
                   8800: 
                   8801: =item $Title: string, the title of the plot
                   8802: 
                   8803: =item $xlabel: string, text describing the X-axis of the plot
                   8804: 
                   8805: =item $ylabel: string, text describing the Y-axis of the plot
                   8806: 
                   8807: =item $Max: scalar, the maximum Y value to use in the plot
                   8808: If $Max is < any data point, the graph will not be rendered.
                   8809: 
1.140     matthew  8810: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8811: they are plotted.  If undefined, default values will be used.
                   8812: 
1.178     matthew  8813: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8814: 
1.138     matthew  8815: =item @Values: An array of array references.  Each array reference holds data
                   8816: to be plotted in a stacked bar chart.
                   8817: 
1.239     matthew  8818: =item If the final element of @Values is a hash reference the key/value
                   8819: pairs will be added to the graph definition.
                   8820: 
1.138     matthew  8821: =back
                   8822: 
                   8823: Returns:
                   8824: 
                   8825: An <img> tag which references graph.png and the appropriate identifying
                   8826: information for the plot.
                   8827: 
1.127     matthew  8828: =cut
                   8829: 
                   8830: ############################################################
                   8831: ############################################################
1.134     matthew  8832: sub DrawBarGraph {
1.178     matthew  8833:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8834:     #
                   8835:     if (! defined($colors)) {
                   8836:         $colors = ['#33ff00', 
                   8837:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8838:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8839:                   ]; 
                   8840:     }
1.228     matthew  8841:     my $extra_settings = {};
                   8842:     if (ref($Values[-1]) eq 'HASH') {
                   8843:         $extra_settings = pop(@Values);
                   8844:     }
1.127     matthew  8845:     #
1.136     matthew  8846:     my $identifier = &get_cgi_id();
                   8847:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8848:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8849:         return '';
                   8850:     }
1.225     matthew  8851:     #
                   8852:     my @Labels;
                   8853:     if (defined($labels)) {
                   8854:         @Labels = @$labels;
                   8855:     } else {
                   8856:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8857:             push (@Labels,$i+1);
                   8858:         }
                   8859:     }
                   8860:     #
1.129     matthew  8861:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8862:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8863:     my %ValuesHash;
                   8864:     my $NumSets=1;
                   8865:     foreach my $array (@Values) {
                   8866:         next if (! ref($array));
1.136     matthew  8867:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8868:             join(',',@$array);
1.129     matthew  8869:     }
1.127     matthew  8870:     #
1.136     matthew  8871:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8872:     if ($NumBars < 3) {
                   8873:         $width = 120+$NumBars*32;
1.220     matthew  8874:         $xskip = 1;
1.225     matthew  8875:         $bar_width = 30;
                   8876:     } elsif ($NumBars < 5) {
                   8877:         $width = 120+$NumBars*20;
                   8878:         $xskip = 1;
                   8879:         $bar_width = 20;
1.220     matthew  8880:     } elsif ($NumBars < 10) {
1.136     matthew  8881:         $width = 120+$NumBars*15;
                   8882:         $xskip = 1;
                   8883:         $bar_width = 15;
                   8884:     } elsif ($NumBars <= 25) {
                   8885:         $width = 120+$NumBars*11;
                   8886:         $xskip = 5;
                   8887:         $bar_width = 8;
                   8888:     } elsif ($NumBars <= 50) {
                   8889:         $width = 120+$NumBars*8;
                   8890:         $xskip = 5;
                   8891:         $bar_width = 4;
                   8892:     } else {
                   8893:         $width = 120+$NumBars*8;
                   8894:         $xskip = 5;
                   8895:         $bar_width = 4;
                   8896:     }
                   8897:     #
1.137     matthew  8898:     $Max = 1 if ($Max < 1);
                   8899:     if ( int($Max) < $Max ) {
                   8900:         $Max++;
                   8901:         $Max = int($Max);
                   8902:     }
1.127     matthew  8903:     $Title  = '' if (! defined($Title));
                   8904:     $xlabel = '' if (! defined($xlabel));
                   8905:     $ylabel = '' if (! defined($ylabel));
1.369     www      8906:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8907:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8908:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8909:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8910:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8911:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8912:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8913:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8914:     $ValuesHash{$id.'.height'}   = $height;
                   8915:     $ValuesHash{$id.'.width'}    = $width;
                   8916:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8917:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8918:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8919:     #
1.228     matthew  8920:     # Deal with other parameters
                   8921:     while (my ($key,$value) = each(%$extra_settings)) {
                   8922:         $ValuesHash{$id.'.'.$key} = $value;
                   8923:     }
                   8924:     #
1.646     raeburn  8925:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8926:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8927: }
                   8928: 
                   8929: ############################################################
                   8930: ############################################################
                   8931: 
                   8932: =pod
                   8933: 
1.648     raeburn  8934: =item * &DrawXYGraph()
1.137     matthew  8935: 
1.138     matthew  8936: Facilitates the plotting of data in an XY graph.
                   8937: Puts plot definition data into the users environment in order for 
                   8938: graph.png to plot it.  Returns an <img> tag for the plot.
                   8939: 
                   8940: Inputs:
                   8941: 
                   8942: =over 4
                   8943: 
                   8944: =item $Title: string, the title of the plot
                   8945: 
                   8946: =item $xlabel: string, text describing the X-axis of the plot
                   8947: 
                   8948: =item $ylabel: string, text describing the Y-axis of the plot
                   8949: 
                   8950: =item $Max: scalar, the maximum Y value to use in the plot
                   8951: If $Max is < any data point, the graph will not be rendered.
                   8952: 
                   8953: =item $colors: Array ref containing the hex color codes for the data to be 
                   8954: plotted in.  If undefined, default values will be used.
                   8955: 
                   8956: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8957: 
                   8958: =item $Ydata: Array ref containing Array refs.  
1.185     www      8959: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8960: 
                   8961: =item %Values: hash indicating or overriding any default values which are 
                   8962: passed to graph.png.  
                   8963: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8964: 
                   8965: =back
                   8966: 
                   8967: Returns:
                   8968: 
                   8969: An <img> tag which references graph.png and the appropriate identifying
                   8970: information for the plot.
                   8971: 
1.137     matthew  8972: =cut
                   8973: 
                   8974: ############################################################
                   8975: ############################################################
                   8976: sub DrawXYGraph {
                   8977:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8978:     #
                   8979:     # Create the identifier for the graph
                   8980:     my $identifier = &get_cgi_id();
                   8981:     my $id = 'cgi.'.$identifier;
                   8982:     #
                   8983:     $Title  = '' if (! defined($Title));
                   8984:     $xlabel = '' if (! defined($xlabel));
                   8985:     $ylabel = '' if (! defined($ylabel));
                   8986:     my %ValuesHash = 
                   8987:         (
1.369     www      8988:          $id.'.title'  => &escape($Title),
                   8989:          $id.'.xlabel' => &escape($xlabel),
                   8990:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8991:          $id.'.y_max_value'=> $Max,
                   8992:          $id.'.labels'     => join(',',@$Xlabels),
                   8993:          $id.'.PlotType'   => 'XY',
                   8994:          );
                   8995:     #
                   8996:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   8997:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8998:     }
                   8999:     #
                   9000:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9001:         return '';
                   9002:     }
                   9003:     my $NumSets=1;
1.138     matthew  9004:     foreach my $array (@{$Ydata}){
1.137     matthew  9005:         next if (! ref($array));
                   9006:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9007:     }
1.138     matthew  9008:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9009:     #
                   9010:     # Deal with other parameters
                   9011:     while (my ($key,$value) = each(%Values)) {
                   9012:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9013:     }
                   9014:     #
1.646     raeburn  9015:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9016:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9017: }
                   9018: 
                   9019: ############################################################
                   9020: ############################################################
                   9021: 
                   9022: =pod
                   9023: 
1.648     raeburn  9024: =item * &DrawXYYGraph()
1.138     matthew  9025: 
                   9026: Facilitates the plotting of data in an XY graph with two Y axes.
                   9027: Puts plot definition data into the users environment in order for 
                   9028: graph.png to plot it.  Returns an <img> tag for the plot.
                   9029: 
                   9030: Inputs:
                   9031: 
                   9032: =over 4
                   9033: 
                   9034: =item $Title: string, the title of the plot
                   9035: 
                   9036: =item $xlabel: string, text describing the X-axis of the plot
                   9037: 
                   9038: =item $ylabel: string, text describing the Y-axis of the plot
                   9039: 
                   9040: =item $colors: Array ref containing the hex color codes for the data to be 
                   9041: plotted in.  If undefined, default values will be used.
                   9042: 
                   9043: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9044: 
                   9045: =item $Ydata1: The first data set
                   9046: 
                   9047: =item $Min1: The minimum value of the left Y-axis
                   9048: 
                   9049: =item $Max1: The maximum value of the left Y-axis
                   9050: 
                   9051: =item $Ydata2: The second data set
                   9052: 
                   9053: =item $Min2: The minimum value of the right Y-axis
                   9054: 
                   9055: =item $Max2: The maximum value of the left Y-axis
                   9056: 
                   9057: =item %Values: hash indicating or overriding any default values which are 
                   9058: passed to graph.png.  
                   9059: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9060: 
                   9061: =back
                   9062: 
                   9063: Returns:
                   9064: 
                   9065: An <img> tag which references graph.png and the appropriate identifying
                   9066: information for the plot.
1.136     matthew  9067: 
                   9068: =cut
                   9069: 
                   9070: ############################################################
                   9071: ############################################################
1.137     matthew  9072: sub DrawXYYGraph {
                   9073:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9074:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9075:     #
                   9076:     # Create the identifier for the graph
                   9077:     my $identifier = &get_cgi_id();
                   9078:     my $id = 'cgi.'.$identifier;
                   9079:     #
                   9080:     $Title  = '' if (! defined($Title));
                   9081:     $xlabel = '' if (! defined($xlabel));
                   9082:     $ylabel = '' if (! defined($ylabel));
                   9083:     my %ValuesHash = 
                   9084:         (
1.369     www      9085:          $id.'.title'  => &escape($Title),
                   9086:          $id.'.xlabel' => &escape($xlabel),
                   9087:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9088:          $id.'.labels' => join(',',@$Xlabels),
                   9089:          $id.'.PlotType' => 'XY',
                   9090:          $id.'.NumSets' => 2,
1.137     matthew  9091:          $id.'.two_axes' => 1,
                   9092:          $id.'.y1_max_value' => $Max1,
                   9093:          $id.'.y1_min_value' => $Min1,
                   9094:          $id.'.y2_max_value' => $Max2,
                   9095:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9096:          );
                   9097:     #
1.137     matthew  9098:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9099:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9100:     }
                   9101:     #
                   9102:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9103:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9104:         return '';
                   9105:     }
                   9106:     my $NumSets=1;
1.137     matthew  9107:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9108:         next if (! ref($array));
                   9109:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9110:     }
                   9111:     #
                   9112:     # Deal with other parameters
                   9113:     while (my ($key,$value) = each(%Values)) {
                   9114:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9115:     }
                   9116:     #
1.646     raeburn  9117:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9118:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9119: }
                   9120: 
                   9121: ############################################################
                   9122: ############################################################
                   9123: 
                   9124: =pod
                   9125: 
1.157     matthew  9126: =back 
                   9127: 
1.139     matthew  9128: =head1 Statistics helper routines?  
                   9129: 
                   9130: Bad place for them but what the hell.
                   9131: 
1.157     matthew  9132: =over 4
                   9133: 
1.648     raeburn  9134: =item * &chartlink()
1.139     matthew  9135: 
                   9136: Returns a link to the chart for a specific student.  
                   9137: 
                   9138: Inputs:
                   9139: 
                   9140: =over 4
                   9141: 
                   9142: =item $linktext: The text of the link
                   9143: 
                   9144: =item $sname: The students username
                   9145: 
                   9146: =item $sdomain: The students domain
                   9147: 
                   9148: =back
                   9149: 
1.157     matthew  9150: =back
                   9151: 
1.139     matthew  9152: =cut
                   9153: 
                   9154: ############################################################
                   9155: ############################################################
                   9156: sub chartlink {
                   9157:     my ($linktext, $sname, $sdomain) = @_;
                   9158:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9159:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9160:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9161:        '">'.$linktext.'</a>';
1.153     matthew  9162: }
                   9163: 
                   9164: #######################################################
                   9165: #######################################################
                   9166: 
                   9167: =pod
                   9168: 
                   9169: =head1 Course Environment Routines
1.157     matthew  9170: 
                   9171: =over 4
1.153     matthew  9172: 
1.648     raeburn  9173: =item * &restore_course_settings()
1.153     matthew  9174: 
1.648     raeburn  9175: =item * &store_course_settings()
1.153     matthew  9176: 
                   9177: Restores/Store indicated form parameters from the course environment.
                   9178: Will not overwrite existing values of the form parameters.
                   9179: 
                   9180: Inputs: 
                   9181: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9182: 
                   9183: a hash ref describing the data to be stored.  For example:
                   9184:    
                   9185: %Save_Parameters = ('Status' => 'scalar',
                   9186:     'chartoutputmode' => 'scalar',
                   9187:     'chartoutputdata' => 'scalar',
                   9188:     'Section' => 'array',
1.373     raeburn  9189:     'Group' => 'array',
1.153     matthew  9190:     'StudentData' => 'array',
                   9191:     'Maps' => 'array');
                   9192: 
                   9193: Returns: both routines return nothing
                   9194: 
1.631     raeburn  9195: =back
                   9196: 
1.153     matthew  9197: =cut
                   9198: 
                   9199: #######################################################
                   9200: #######################################################
                   9201: sub store_course_settings {
1.496     albertel 9202:     return &store_settings($env{'request.course.id'},@_);
                   9203: }
                   9204: 
                   9205: sub store_settings {
1.153     matthew  9206:     # save to the environment
                   9207:     # appenv the same items, just to be safe
1.300     albertel 9208:     my $udom  = $env{'user.domain'};
                   9209:     my $uname = $env{'user.name'};
1.496     albertel 9210:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9211:     my %SaveHash;
                   9212:     my %AppHash;
                   9213:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9214:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9215:         my $envname = 'environment.'.$basename;
1.258     albertel 9216:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9217:             # Save this value away
                   9218:             if ($type eq 'scalar' &&
1.258     albertel 9219:                 (! exists($env{$envname}) || 
                   9220:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9221:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9222:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9223:             } elsif ($type eq 'array') {
                   9224:                 my $stored_form;
1.258     albertel 9225:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9226:                     $stored_form = join(',',
                   9227:                                         map {
1.369     www      9228:                                             &escape($_);
1.258     albertel 9229:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9230:                 } else {
                   9231:                     $stored_form = 
1.369     www      9232:                         &escape($env{'form.'.$setting});
1.153     matthew  9233:                 }
                   9234:                 # Determine if the array contents are the same.
1.258     albertel 9235:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9236:                     $SaveHash{$basename} = $stored_form;
                   9237:                     $AppHash{$envname}   = $stored_form;
                   9238:                 }
                   9239:             }
                   9240:         }
                   9241:     }
                   9242:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9243:                                           $udom,$uname);
1.153     matthew  9244:     if ($put_result !~ /^(ok|delayed)/) {
                   9245:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9246:                                  'got error:'.$put_result);
                   9247:     }
                   9248:     # Make sure these settings stick around in this session, too
1.646     raeburn  9249:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9250:     return;
                   9251: }
                   9252: 
                   9253: sub restore_course_settings {
1.499     albertel 9254:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9255: }
                   9256: 
                   9257: sub restore_settings {
                   9258:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9259:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9260:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9261:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9262:             '.'.$setting;
1.258     albertel 9263:         if (exists($env{$envname})) {
1.153     matthew  9264:             if ($type eq 'scalar') {
1.258     albertel 9265:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9266:             } elsif ($type eq 'array') {
1.258     albertel 9267:                 $env{'form.'.$setting} = [ 
1.153     matthew  9268:                                            map { 
1.369     www      9269:                                                &unescape($_); 
1.258     albertel 9270:                                            } split(',',$env{$envname})
1.153     matthew  9271:                                            ];
                   9272:             }
                   9273:         }
                   9274:     }
1.127     matthew  9275: }
                   9276: 
1.618     raeburn  9277: #######################################################
                   9278: #######################################################
                   9279: 
                   9280: =pod
                   9281: 
                   9282: =head1 Domain E-mail Routines  
                   9283: 
                   9284: =over 4
                   9285: 
1.648     raeburn  9286: =item * &build_recipient_list()
1.618     raeburn  9287: 
1.884     raeburn  9288: Build recipient lists for five types of e-mail:
1.766     raeburn  9289: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9290: (d) Help requests, (e) Course requests needing approval,  generated by
                   9291: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9292: loncoursequeueadmin.pm respectively.
1.618     raeburn  9293: 
                   9294: Inputs:
1.619     raeburn  9295: defmail (scalar - email address of default recipient), 
1.618     raeburn  9296: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9297: defdom (domain for which to retrieve configuration settings),
                   9298: origmail (scalar - email address of recipient from loncapa.conf, 
                   9299: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9300: 
1.655     raeburn  9301: Returns: comma separated list of addresses to which to send e-mail.
                   9302: 
                   9303: =back
1.618     raeburn  9304: 
                   9305: =cut
                   9306: 
                   9307: ############################################################
                   9308: ############################################################
                   9309: sub build_recipient_list {
1.619     raeburn  9310:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9311:     my @recipients;
                   9312:     my $otheremails;
                   9313:     my %domconfig =
                   9314:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9315:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9316:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9317:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9318:                 my @contacts = ('adminemail','supportemail');
                   9319:                 foreach my $item (@contacts) {
                   9320:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9321:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9322:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9323:                             push(@recipients,$addr);
                   9324:                         }
1.619     raeburn  9325:                     }
1.766     raeburn  9326:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9327:                 }
                   9328:             }
1.766     raeburn  9329:         } elsif ($origmail ne '') {
                   9330:             push(@recipients,$origmail);
1.618     raeburn  9331:         }
1.619     raeburn  9332:     } elsif ($origmail ne '') {
                   9333:         push(@recipients,$origmail);
1.618     raeburn  9334:     }
1.688     raeburn  9335:     if (defined($defmail)) {
                   9336:         if ($defmail ne '') {
                   9337:             push(@recipients,$defmail);
                   9338:         }
1.618     raeburn  9339:     }
                   9340:     if ($otheremails) {
1.619     raeburn  9341:         my @others;
                   9342:         if ($otheremails =~ /,/) {
                   9343:             @others = split(/,/,$otheremails);
1.618     raeburn  9344:         } else {
1.619     raeburn  9345:             push(@others,$otheremails);
                   9346:         }
                   9347:         foreach my $addr (@others) {
                   9348:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9349:                 push(@recipients,$addr);
                   9350:             }
1.618     raeburn  9351:         }
                   9352:     }
1.619     raeburn  9353:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9354:     return $recipientlist;
                   9355: }
                   9356: 
1.127     matthew  9357: ############################################################
                   9358: ############################################################
1.154     albertel 9359: 
1.655     raeburn  9360: =pod
                   9361: 
                   9362: =head1 Course Catalog Routines
                   9363: 
                   9364: =over 4
                   9365: 
                   9366: =item * &gather_categories()
                   9367: 
                   9368: Converts category definitions - keys of categories hash stored in  
                   9369: coursecategories in configuration.db on the primary library server in a 
                   9370: domain - to an array.  Also generates javascript and idx hash used to 
                   9371: generate Domain Coordinator interface for editing Course Categories.
                   9372: 
                   9373: Inputs:
1.663     raeburn  9374: 
1.655     raeburn  9375: categories (reference to hash of category definitions).
1.663     raeburn  9376: 
1.655     raeburn  9377: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9378:       categories and subcategories).
1.663     raeburn  9379: 
1.655     raeburn  9380: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9381:       editing Course Categories).
1.663     raeburn  9382: 
1.655     raeburn  9383: jsarray (reference to array of categories used to create Javascript arrays for
                   9384:          Domain Coordinator interface for editing Course Categories).
                   9385: 
                   9386: Returns: nothing
                   9387: 
                   9388: Side effects: populates cats, idx and jsarray. 
                   9389: 
                   9390: =cut
                   9391: 
                   9392: sub gather_categories {
                   9393:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9394:     my %counters;
                   9395:     my $num = 0;
                   9396:     foreach my $item (keys(%{$categories})) {
                   9397:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9398:         if ($container eq '' && $depth == 0) {
                   9399:             $cats->[$depth][$categories->{$item}] = $cat;
                   9400:         } else {
                   9401:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9402:         }
                   9403:         my ($escitem,$tail) = split(/:/,$item,2);
                   9404:         if ($counters{$tail} eq '') {
                   9405:             $counters{$tail} = $num;
                   9406:             $num ++;
                   9407:         }
                   9408:         if (ref($idx) eq 'HASH') {
                   9409:             $idx->{$item} = $counters{$tail};
                   9410:         }
                   9411:         if (ref($jsarray) eq 'ARRAY') {
                   9412:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9413:         }
                   9414:     }
                   9415:     return;
                   9416: }
                   9417: 
                   9418: =pod
                   9419: 
                   9420: =item * &extract_categories()
                   9421: 
                   9422: Used to generate breadcrumb trails for course categories.
                   9423: 
                   9424: Inputs:
1.663     raeburn  9425: 
1.655     raeburn  9426: categories (reference to hash of category definitions).
1.663     raeburn  9427: 
1.655     raeburn  9428: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9429:       categories and subcategories).
1.663     raeburn  9430: 
1.655     raeburn  9431: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9432: 
1.655     raeburn  9433: allitems (reference to hash - key is category key 
                   9434:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9435: 
1.655     raeburn  9436: idx (reference to hash of counters used in Domain Coordinator interface for
                   9437:       editing Course Categories).
1.663     raeburn  9438: 
1.655     raeburn  9439: jsarray (reference to array of categories used to create Javascript arrays for
                   9440:          Domain Coordinator interface for editing Course Categories).
                   9441: 
1.665     raeburn  9442: subcats (reference to hash of arrays containing all subcategories within each 
                   9443:          category, -recursive)
                   9444: 
1.655     raeburn  9445: Returns: nothing
                   9446: 
                   9447: Side effects: populates trails and allitems hash references.
                   9448: 
                   9449: =cut
                   9450: 
                   9451: sub extract_categories {
1.665     raeburn  9452:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9453:     if (ref($categories) eq 'HASH') {
                   9454:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9455:         if (ref($cats->[0]) eq 'ARRAY') {
                   9456:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9457:                 my $name = $cats->[0][$i];
                   9458:                 my $item = &escape($name).'::0';
                   9459:                 my $trailstr;
                   9460:                 if ($name eq 'instcode') {
                   9461:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9462:                 } else {
                   9463:                     $trailstr = $name;
                   9464:                 }
                   9465:                 if ($allitems->{$item} eq '') {
                   9466:                     push(@{$trails},$trailstr);
                   9467:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9468:                 }
                   9469:                 my @parents = ($name);
                   9470:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9471:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9472:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9473:                         if (ref($subcats) eq 'HASH') {
                   9474:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9475:                         }
                   9476:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9477:                     }
                   9478:                 } else {
                   9479:                     if (ref($subcats) eq 'HASH') {
                   9480:                         $subcats->{$item} = [];
1.655     raeburn  9481:                     }
                   9482:                 }
                   9483:             }
                   9484:         }
                   9485:     }
                   9486:     return;
                   9487: }
                   9488: 
                   9489: =pod
                   9490: 
                   9491: =item *&recurse_categories()
                   9492: 
                   9493: Recursively used to generate breadcrumb trails for course categories.
                   9494: 
                   9495: Inputs:
1.663     raeburn  9496: 
1.655     raeburn  9497: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9498:       categories and subcategories).
1.663     raeburn  9499: 
1.655     raeburn  9500: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9501: 
                   9502: category (current course category, for which breadcrumb trail is being generated).
                   9503: 
                   9504: trails (reference to array of breadcrumb trails for each category).
                   9505: 
1.655     raeburn  9506: allitems (reference to hash - key is category key
                   9507:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9508: 
1.655     raeburn  9509: parents (array containing containers directories for current category, 
                   9510:          back to top level). 
                   9511: 
                   9512: Returns: nothing
                   9513: 
                   9514: Side effects: populates trails and allitems hash references
                   9515: 
                   9516: =cut
                   9517: 
                   9518: sub recurse_categories {
1.665     raeburn  9519:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9520:     my $shallower = $depth - 1;
                   9521:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9522:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9523:             my $name = $cats->[$depth]{$category}[$k];
                   9524:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9525:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9526:             if ($allitems->{$item} eq '') {
                   9527:                 push(@{$trails},$trailstr);
                   9528:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9529:             }
                   9530:             my $deeper = $depth+1;
                   9531:             push(@{$parents},$category);
1.665     raeburn  9532:             if (ref($subcats) eq 'HASH') {
                   9533:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9534:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9535:                     my $higher;
                   9536:                     if ($j > 0) {
                   9537:                         $higher = &escape($parents->[$j]).':'.
                   9538:                                   &escape($parents->[$j-1]).':'.$j;
                   9539:                     } else {
                   9540:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9541:                     }
                   9542:                     push(@{$subcats->{$higher}},$subcat);
                   9543:                 }
                   9544:             }
                   9545:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9546:                                 $subcats);
1.655     raeburn  9547:             pop(@{$parents});
                   9548:         }
                   9549:     } else {
                   9550:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9551:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9552:         if ($allitems->{$item} eq '') {
                   9553:             push(@{$trails},$trailstr);
                   9554:             $allitems->{$item} = scalar(@{$trails})-1;
                   9555:         }
                   9556:     }
                   9557:     return;
                   9558: }
                   9559: 
1.663     raeburn  9560: =pod
                   9561: 
                   9562: =item *&assign_categories_table()
                   9563: 
                   9564: Create a datatable for display of hierarchical categories in a domain,
                   9565: with checkboxes to allow a course to be categorized. 
                   9566: 
                   9567: Inputs:
                   9568: 
                   9569: cathash - reference to hash of categories defined for the domain (from
                   9570:           configuration.db)
                   9571: 
                   9572: currcat - scalar with an & separated list of categories assigned to a course. 
                   9573: 
                   9574: Returns: $output (markup to be displayed) 
                   9575: 
                   9576: =cut
                   9577: 
                   9578: sub assign_categories_table {
                   9579:     my ($cathash,$currcat) = @_;
                   9580:     my $output;
                   9581:     if (ref($cathash) eq 'HASH') {
                   9582:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9583:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9584:         $maxdepth = scalar(@cats);
                   9585:         if (@cats > 0) {
                   9586:             my $itemcount = 0;
                   9587:             if (ref($cats[0]) eq 'ARRAY') {
                   9588:                 $output = &Apache::loncommon::start_data_table();
                   9589:                 my @currcategories;
                   9590:                 if ($currcat ne '') {
                   9591:                     @currcategories = split('&',$currcat);
                   9592:                 }
                   9593:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9594:                     my $parent = $cats[0][$i];
                   9595:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9596:                     next if ($parent eq 'instcode');
                   9597:                     my $item = &escape($parent).'::0';
                   9598:                     my $checked = '';
                   9599:                     if (@currcategories > 0) {
                   9600:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9601:                             $checked = ' checked="checked"';
1.663     raeburn  9602:                         }
                   9603:                     }
1.675     raeburn  9604:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9605:                                '<input type="checkbox" name="usecategory" value="'.
                   9606:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9607:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9608:                     my $depth = 1;
                   9609:                     push(@path,$parent);
                   9610:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9611:                     pop(@path);
                   9612:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9613:                     $itemcount ++;
                   9614:                 }
                   9615:                 $output .= &Apache::loncommon::end_data_table();
                   9616:             }
                   9617:         }
                   9618:     }
                   9619:     return $output;
                   9620: }
                   9621: 
                   9622: =pod
                   9623: 
                   9624: =item *&assign_category_rows()
                   9625: 
                   9626: Create a datatable row for display of nested categories in a domain,
                   9627: with checkboxes to allow a course to be categorized,called recursively.
                   9628: 
                   9629: Inputs:
                   9630: 
                   9631: itemcount - track row number for alternating colors
                   9632: 
                   9633: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9634:       categories and subcategories.
                   9635: 
                   9636: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9637: 
                   9638: parent - parent of current category item
                   9639: 
                   9640: path - Array containing all categories back up through the hierarchy from the
                   9641:        current category to the top level.
                   9642: 
                   9643: currcategories - reference to array of current categories assigned to the course
                   9644: 
                   9645: Returns: $output (markup to be displayed).
                   9646: 
                   9647: =cut
                   9648: 
                   9649: sub assign_category_rows {
                   9650:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9651:     my ($text,$name,$item,$chgstr);
                   9652:     if (ref($cats) eq 'ARRAY') {
                   9653:         my $maxdepth = scalar(@{$cats});
                   9654:         if (ref($cats->[$depth]) eq 'HASH') {
                   9655:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9656:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9657:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9658:                 $text .= '<td><table class="LC_datatable">';
                   9659:                 for (my $j=0; $j<$numchildren; $j++) {
                   9660:                     $name = $cats->[$depth]{$parent}[$j];
                   9661:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9662:                     my $deeper = $depth+1;
                   9663:                     my $checked = '';
                   9664:                     if (ref($currcategories) eq 'ARRAY') {
                   9665:                         if (@{$currcategories} > 0) {
                   9666:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9667:                                 $checked = ' checked="checked"';
1.663     raeburn  9668:                             }
                   9669:                         }
                   9670:                     }
1.664     raeburn  9671:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9672:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9673:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9674:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9675:                              '</td><td>';
1.663     raeburn  9676:                     if (ref($path) eq 'ARRAY') {
                   9677:                         push(@{$path},$name);
                   9678:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9679:                         pop(@{$path});
                   9680:                     }
                   9681:                     $text .= '</td></tr>';
                   9682:                 }
                   9683:                 $text .= '</table></td>';
                   9684:             }
                   9685:         }
                   9686:     }
                   9687:     return $text;
                   9688: }
                   9689: 
1.655     raeburn  9690: ############################################################
                   9691: ############################################################
                   9692: 
                   9693: 
1.443     albertel 9694: sub commit_customrole {
1.664     raeburn  9695:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9696:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9697:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9698:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9699:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9700:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9701:                  '</b><br />';
                   9702:     return $output;
                   9703: }
                   9704: 
                   9705: sub commit_standardrole {
1.541     raeburn  9706:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9707:     my ($output,$logmsg,$linefeed);
                   9708:     if ($context eq 'auto') {
                   9709:         $linefeed = "\n";
                   9710:     } else {
                   9711:         $linefeed = "<br />\n";
                   9712:     }  
1.443     albertel 9713:     if ($three eq 'st') {
1.541     raeburn  9714:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9715:                                          $one,$two,$sec,$context);
                   9716:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9717:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9718:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9719:         } else {
1.541     raeburn  9720:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9721:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9722:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9723:             if ($context eq 'auto') {
                   9724:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9725:             } else {
                   9726:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9727:                &mt('Add to classlist').': <b>ok</b>';
                   9728:             }
                   9729:             $output .= $linefeed;
1.443     albertel 9730:         }
                   9731:     } else {
                   9732:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9733:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9734:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9735:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9736:         if ($context eq 'auto') {
                   9737:             $output .= $result.$linefeed;
                   9738:         } else {
                   9739:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9740:         }
1.443     albertel 9741:     }
                   9742:     return $output;
                   9743: }
                   9744: 
                   9745: sub commit_studentrole {
1.541     raeburn  9746:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9747:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9748:     if ($context eq 'auto') {
                   9749:         $linefeed = "\n";
                   9750:     } else {
                   9751:         $linefeed = '<br />'."\n";
                   9752:     }
1.443     albertel 9753:     if (defined($one) && defined($two)) {
                   9754:         my $cid=$one.'_'.$two;
                   9755:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9756:         my $secchange = 0;
                   9757:         my $expire_role_result;
                   9758:         my $modify_section_result;
1.628     raeburn  9759:         if ($oldsec ne '-1') { 
                   9760:             if ($oldsec ne $sec) {
1.443     albertel 9761:                 $secchange = 1;
1.628     raeburn  9762:                 my $now = time;
1.443     albertel 9763:                 my $uurl='/'.$cid;
                   9764:                 $uurl=~s/\_/\//g;
                   9765:                 if ($oldsec) {
                   9766:                     $uurl.='/'.$oldsec;
                   9767:                 }
1.626     raeburn  9768:                 $oldsecurl = $uurl;
1.628     raeburn  9769:                 $expire_role_result = 
1.652     raeburn  9770:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9771:                 if ($env{'request.course.sec'} ne '') { 
                   9772:                     if ($expire_role_result eq 'refused') {
                   9773:                         my @roles = ('st');
                   9774:                         my @statuses = ('previous');
                   9775:                         my @roledoms = ($one);
                   9776:                         my $withsec = 1;
                   9777:                         my %roleshash = 
                   9778:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9779:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9780:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9781:                             my ($oldstart,$oldend) = 
                   9782:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9783:                             if ($oldend > 0 && $oldend <= $now) {
                   9784:                                 $expire_role_result = 'ok';
                   9785:                             }
                   9786:                         }
                   9787:                     }
                   9788:                 }
1.443     albertel 9789:                 $result = $expire_role_result;
                   9790:             }
                   9791:         }
                   9792:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9793:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9794:             if ($modify_section_result =~ /^ok/) {
                   9795:                 if ($secchange == 1) {
1.628     raeburn  9796:                     if ($sec eq '') {
                   9797:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9798:                     } else {
                   9799:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9800:                     }
1.443     albertel 9801:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9802:                     if ($sec eq '') {
                   9803:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9804:                     } else {
                   9805:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9806:                     }
1.443     albertel 9807:                 } else {
1.628     raeburn  9808:                     if ($sec eq '') {
                   9809:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9810:                     } else {
                   9811:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9812:                     }
1.443     albertel 9813:                 }
                   9814:             } else {
1.628     raeburn  9815:                 if ($secchange) {       
                   9816:                     $$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;
                   9817:                 } else {
                   9818:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9819:                 }
1.443     albertel 9820:             }
                   9821:             $result = $modify_section_result;
                   9822:         } elsif ($secchange == 1) {
1.628     raeburn  9823:             if ($oldsec eq '') {
                   9824:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9825:             } else {
                   9826:                 $$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;
                   9827:             }
1.626     raeburn  9828:             if ($expire_role_result eq 'refused') {
                   9829:                 my $newsecurl = '/'.$cid;
                   9830:                 $newsecurl =~ s/\_/\//g;
                   9831:                 if ($sec ne '') {
                   9832:                     $newsecurl.='/'.$sec;
                   9833:                 }
                   9834:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9835:                     if ($sec eq '') {
                   9836:                         $$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;
                   9837:                     } else {
                   9838:                         $$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;
                   9839:                     }
                   9840:                 }
                   9841:             }
1.443     albertel 9842:         }
                   9843:     } else {
1.626     raeburn  9844:         $$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 9845:         $result = "error: incomplete course id\n";
                   9846:     }
                   9847:     return $result;
                   9848: }
                   9849: 
                   9850: ############################################################
                   9851: ############################################################
                   9852: 
1.566     albertel 9853: sub check_clone {
1.578     raeburn  9854:     my ($args,$linefeed) = @_;
1.566     albertel 9855:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9856:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9857:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9858:     my $clonemsg;
                   9859:     my $can_clone = 0;
                   9860: 
                   9861:     if ($clonehome eq 'no_host') {
1.578     raeburn  9862:         $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 9863:     } else {
                   9864: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.882     raeburn  9865: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   9866:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 9867: 	    $can_clone = 1;
                   9868: 	} else {
                   9869: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9870: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9871: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9872:             if (grep(/^\*$/,@cloners)) {
                   9873:                 $can_clone = 1;
                   9874:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9875:                 $can_clone = 1;
                   9876:             } else {
                   9877: 	        my %roleshash =
                   9878: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9879: 					 $args->{'ccdomain'},
                   9880:                                          'userroles',['active'],['cc'],
                   9881: 					 [$args->{'clonedomain'}]);
                   9882: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9883: 		    $can_clone = 1;
                   9884: 	        } else {
                   9885:                     $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'});
                   9886: 	        }
1.566     albertel 9887: 	    }
1.578     raeburn  9888:         }
1.566     albertel 9889:     }
                   9890:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9891: }
                   9892: 
1.444     albertel 9893: sub construct_course {
1.885     raeburn  9894:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 9895:     my $outcome;
1.541     raeburn  9896:     my $linefeed =  '<br />'."\n";
                   9897:     if ($context eq 'auto') {
                   9898:         $linefeed = "\n";
                   9899:     }
1.566     albertel 9900: 
                   9901: #
                   9902: # Are we cloning?
                   9903: #
                   9904:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9905:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9906: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9907: 	if ($context ne 'auto') {
1.578     raeburn  9908:             if ($clonemsg ne '') {
                   9909: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9910:             }
1.566     albertel 9911: 	}
                   9912: 	$outcome .= $clonemsg.$linefeed;
                   9913: 
                   9914:         if (!$can_clone) {
                   9915: 	    return (0,$outcome);
                   9916: 	}
                   9917:     }
                   9918: 
1.444     albertel 9919: #
                   9920: # Open course
                   9921: #
                   9922:     my $crstype = lc($args->{'crstype'});
                   9923:     my %cenv=();
                   9924:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9925:                                              $args->{'cdescr'},
                   9926:                                              $args->{'curl'},
                   9927:                                              $args->{'course_home'},
                   9928:                                              $args->{'nonstandard'},
                   9929:                                              $args->{'crscode'},
                   9930:                                              $args->{'ccuname'}.':'.
                   9931:                                              $args->{'ccdomain'},
1.882     raeburn  9932:                                              $args->{'crstype'},
1.885     raeburn  9933:                                              $cnum,$context,$category);
1.444     albertel 9934: 
                   9935:     # Note: The testing routines depend on this being output; see 
                   9936:     # Utils::Course. This needs to at least be output as a comment
                   9937:     # if anyone ever decides to not show this, and Utils::Course::new
                   9938:     # will need to be suitably modified.
1.541     raeburn  9939:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9940: #
                   9941: # Check if created correctly
                   9942: #
1.479     albertel 9943:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9944:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9945:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9946: 
1.444     albertel 9947: #
1.566     albertel 9948: # Do the cloning
                   9949: #   
                   9950:     if ($can_clone && $cloneid) {
                   9951: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9952: 	if ($context ne 'auto') {
                   9953: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9954: 	}
                   9955: 	$outcome .= $clonemsg.$linefeed;
                   9956: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9957: # Copy all files
1.637     www      9958: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9959: # Restore URL
1.566     albertel 9960: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9961: # Restore title
1.566     albertel 9962: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9963: # Mark as cloned
1.566     albertel 9964: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9965: # Need to clone grading mode
                   9966:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9967:         $cenv{'grading'}=$newenv{'grading'};
                   9968: # Do not clone these environment entries
                   9969:         &Apache::lonnet::del('environment',
                   9970:                   ['default_enrollment_start_date',
                   9971:                    'default_enrollment_end_date',
                   9972:                    'question.email',
                   9973:                    'policy.email',
                   9974:                    'comment.email',
                   9975:                    'pch.users.denied',
1.725     raeburn  9976:                    'plc.users.denied',
                   9977:                    'hidefromcat',
                   9978:                    'categories'],
1.638     www      9979:                    $$crsudom,$$crsunum);
1.444     albertel 9980:     }
1.566     albertel 9981: 
1.444     albertel 9982: #
                   9983: # Set environment (will override cloned, if existing)
                   9984: #
                   9985:     my @sections = ();
                   9986:     my @xlists = ();
                   9987:     if ($args->{'crstype'}) {
                   9988:         $cenv{'type'}=$args->{'crstype'};
                   9989:     }
                   9990:     if ($args->{'crsid'}) {
                   9991:         $cenv{'courseid'}=$args->{'crsid'};
                   9992:     }
                   9993:     if ($args->{'crscode'}) {
                   9994:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   9995:     }
                   9996:     if ($args->{'crsquota'} ne '') {
                   9997:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   9998:     } else {
                   9999:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10000:     }
                   10001:     if ($args->{'ccuname'}) {
                   10002:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10003:                                         ':'.$args->{'ccdomain'};
                   10004:     } else {
                   10005:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10006:     }
                   10007:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10008:     if ($args->{'crssections'}) {
                   10009:         $cenv{'internal.sectionnums'} = '';
                   10010:         if ($args->{'crssections'} =~ m/,/) {
                   10011:             @sections = split/,/,$args->{'crssections'};
                   10012:         } else {
                   10013:             $sections[0] = $args->{'crssections'};
                   10014:         }
                   10015:         if (@sections > 0) {
                   10016:             foreach my $item (@sections) {
                   10017:                 my ($sec,$gp) = split/:/,$item;
                   10018:                 my $class = $args->{'crscode'}.$sec;
                   10019:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10020:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10021:                 unless ($addcheck eq 'ok') {
                   10022:                     push @badclasses, $class;
                   10023:                 }
                   10024:             }
                   10025:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10026:         }
                   10027:     }
                   10028: # do not hide course coordinator from staff listing, 
                   10029: # even if privileged
                   10030:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10031: # add crosslistings
                   10032:     if ($args->{'crsxlist'}) {
                   10033:         $cenv{'internal.crosslistings'}='';
                   10034:         if ($args->{'crsxlist'} =~ m/,/) {
                   10035:             @xlists = split/,/,$args->{'crsxlist'};
                   10036:         } else {
                   10037:             $xlists[0] = $args->{'crsxlist'};
                   10038:         }
                   10039:         if (@xlists > 0) {
                   10040:             foreach my $item (@xlists) {
                   10041:                 my ($xl,$gp) = split/:/,$item;
                   10042:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10043:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10044:                 unless ($addcheck eq 'ok') {
                   10045:                     push @badclasses, $xl;
                   10046:                 }
                   10047:             }
                   10048:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10049:         }
                   10050:     }
                   10051:     if ($args->{'autoadds'}) {
                   10052:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10053:     }
                   10054:     if ($args->{'autodrops'}) {
                   10055:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10056:     }
                   10057: # check for notification of enrollment changes
                   10058:     my @notified = ();
                   10059:     if ($args->{'notify_owner'}) {
                   10060:         if ($args->{'ccuname'} ne '') {
                   10061:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10062:         }
                   10063:     }
                   10064:     if ($args->{'notify_dc'}) {
                   10065:         if ($uname ne '') { 
1.630     raeburn  10066:             push(@notified,$uname.':'.$udom);
1.444     albertel 10067:         }
                   10068:     }
                   10069:     if (@notified > 0) {
                   10070:         my $notifylist;
                   10071:         if (@notified > 1) {
                   10072:             $notifylist = join(',',@notified);
                   10073:         } else {
                   10074:             $notifylist = $notified[0];
                   10075:         }
                   10076:         $cenv{'internal.notifylist'} = $notifylist;
                   10077:     }
                   10078:     if (@badclasses > 0) {
                   10079:         my %lt=&Apache::lonlocal::texthash(
                   10080:                 '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',
                   10081:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10082:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10083:         );
1.541     raeburn  10084:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10085:                            ' ('.$lt{'adby'}.')';
                   10086:         if ($context eq 'auto') {
                   10087:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10088:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10089:             foreach my $item (@badclasses) {
                   10090:                 if ($context eq 'auto') {
                   10091:                     $outcome .= " - $item\n";
                   10092:                 } else {
                   10093:                     $outcome .= "<li>$item</li>\n";
                   10094:                 }
                   10095:             }
                   10096:             if ($context eq 'auto') {
                   10097:                 $outcome .= $linefeed;
                   10098:             } else {
1.566     albertel 10099:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10100:             }
                   10101:         } 
1.444     albertel 10102:     }
                   10103:     if ($args->{'no_end_date'}) {
                   10104:         $args->{'endaccess'} = 0;
                   10105:     }
                   10106:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10107:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10108:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10109:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10110:     if ($args->{'showphotos'}) {
                   10111:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10112:     }
                   10113:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10114:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10115:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10116:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10117:             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'); 
                   10118:             if ($context eq 'auto') {
                   10119:                 $outcome .= $krb_msg;
                   10120:             } else {
1.566     albertel 10121:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10122:             }
                   10123:             $outcome .= $linefeed;
1.444     albertel 10124:         }
                   10125:     }
                   10126:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10127:        if ($args->{'setpolicy'}) {
                   10128:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10129:        }
                   10130:        if ($args->{'setcontent'}) {
                   10131:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10132:        }
                   10133:     }
                   10134:     if ($args->{'reshome'}) {
                   10135: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10136: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10137:     }
                   10138: #
                   10139: # course has keyed access
                   10140: #
                   10141:     if ($args->{'setkeys'}) {
                   10142:        $cenv{'keyaccess'}='yes';
                   10143:     }
                   10144: # if specified, key authority is not course, but user
                   10145: # only active if keyaccess is yes
                   10146:     if ($args->{'keyauth'}) {
1.487     albertel 10147: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10148: 	$user = &LONCAPA::clean_username($user);
                   10149: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10150: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10151: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10152: 	}
                   10153:     }
                   10154: 
                   10155:     if ($args->{'disresdis'}) {
                   10156:         $cenv{'pch.roles.denied'}='st';
                   10157:     }
                   10158:     if ($args->{'disablechat'}) {
                   10159:         $cenv{'plc.roles.denied'}='st';
                   10160:     }
                   10161: 
                   10162:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10163:     # course
                   10164:     $cenv{'course.helper.not.run'} = 1;
                   10165:     #
                   10166:     # Use new Randomseed
                   10167:     #
                   10168:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10169:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10170:     #
                   10171:     # The encryption code and receipt prefix for this course
                   10172:     #
                   10173:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10174:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10175:     #
                   10176:     # By default, use standard grading
                   10177:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10178: 
1.541     raeburn  10179:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10180:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10181: #
                   10182: # Open all assignments
                   10183: #
                   10184:     if ($args->{'openall'}) {
                   10185:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10186:        my %storecontent = ($storeunder         => time,
                   10187:                            $storeunder.'.type' => 'date_start');
                   10188:        
                   10189:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10190:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10191:    }
                   10192: #
                   10193: # Set first page
                   10194: #
                   10195:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10196: 	    || ($cloneid)) {
1.445     albertel 10197: 	use LONCAPA::map;
1.444     albertel 10198: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10199: 
                   10200: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10201:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10202: 
1.444     albertel 10203:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10204:         my $title; my $url;
                   10205:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10206: 	    $title=&mt('Syllabus');
1.444     albertel 10207:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10208:         } else {
1.690     bisitz   10209:             $title=&mt('Navigate Contents');
1.444     albertel 10210:             $url='/adm/navmaps';
                   10211:         }
1.445     albertel 10212: 
                   10213:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10214: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10215: 
                   10216: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10217:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10218:     }
1.566     albertel 10219: 
                   10220:     return (1,$outcome);
1.444     albertel 10221: }
                   10222: 
                   10223: ############################################################
                   10224: ############################################################
                   10225: 
1.378     raeburn  10226: sub course_type {
                   10227:     my ($cid) = @_;
                   10228:     if (!defined($cid)) {
                   10229:         $cid = $env{'request.course.id'};
                   10230:     }
1.404     albertel 10231:     if (defined($env{'course.'.$cid.'.type'})) {
                   10232:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10233:     } else {
                   10234:         return 'Course';
1.377     raeburn  10235:     }
                   10236: }
1.156     albertel 10237: 
1.406     raeburn  10238: sub group_term {
                   10239:     my $crstype = &course_type();
                   10240:     my %names = (
                   10241:                   'Course' => 'group',
1.865     raeburn  10242:                   'Community' => 'group',
1.406     raeburn  10243:                 );
                   10244:     return $names{$crstype};
                   10245: }
                   10246: 
1.156     albertel 10247: sub icon {
                   10248:     my ($file)=@_;
1.505     albertel 10249:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10250:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10251:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10252:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10253: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10254: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10255: 	            $curfext.".gif") {
                   10256: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10257: 		$curfext.".gif";
                   10258: 	}
                   10259:     }
1.249     albertel 10260:     return &lonhttpdurl($iconname);
1.154     albertel 10261: } 
1.84      albertel 10262: 
1.575     albertel 10263: sub lonhttpdurl {
1.692     www      10264: #
                   10265: # Had been used for "small fry" static images on separate port 8080.
                   10266: # Modify here if lightweight http functionality desired again.
                   10267: # Currently eliminated due to increasing firewall issues.
                   10268: #
1.575     albertel 10269:     my ($url)=@_;
1.692     www      10270:     return $url;
1.215     albertel 10271: }
                   10272: 
1.213     albertel 10273: sub connection_aborted {
                   10274:     my ($r)=@_;
                   10275:     $r->print(" ");$r->rflush();
                   10276:     my $c = $r->connection;
                   10277:     return $c->aborted();
                   10278: }
                   10279: 
1.221     foxr     10280: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10281: #    strings as 'strings'.
                   10282: sub escape_single {
1.221     foxr     10283:     my ($input) = @_;
1.223     albertel 10284:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10285:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10286:     return $input;
                   10287: }
1.223     albertel 10288: 
1.222     foxr     10289: #  Same as escape_single, but escape's "'s  This 
                   10290: #  can be used for  "strings"
                   10291: sub escape_double {
                   10292:     my ($input) = @_;
                   10293:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10294:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10295:     return $input;
                   10296: }
1.223     albertel 10297:  
1.222     foxr     10298: #   Escapes the last element of a full URL.
                   10299: sub escape_url {
                   10300:     my ($url)   = @_;
1.238     raeburn  10301:     my @urlslices = split(/\//, $url,-1);
1.369     www      10302:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10303:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10304: }
1.462     albertel 10305: 
1.820     raeburn  10306: sub compare_arrays {
                   10307:     my ($arrayref1,$arrayref2) = @_;
                   10308:     my (@difference,%count);
                   10309:     @difference = ();
                   10310:     %count = ();
                   10311:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10312:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10313:         foreach my $element (keys(%count)) {
                   10314:             if ($count{$element} == 1) {
                   10315:                 push(@difference,$element);
                   10316:             }
                   10317:         }
                   10318:     }
                   10319:     return @difference;
                   10320: }
                   10321: 
1.817     bisitz   10322: # -------------------------------------------------------- Initialize user login
1.462     albertel 10323: sub init_user_environment {
1.463     albertel 10324:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10325:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10326: 
                   10327:     my $public=($username eq 'public' && $domain eq 'public');
                   10328: 
                   10329: # See if old ID present, if so, remove
                   10330: 
                   10331:     my ($filename,$cookie,$userroles);
                   10332:     my $now=time;
                   10333: 
                   10334:     if ($public) {
                   10335: 	my $max_public=100;
                   10336: 	my $oldest;
                   10337: 	my $oldest_time=0;
                   10338: 	for(my $next=1;$next<=$max_public;$next++) {
                   10339: 	    if (-e $lonids."/publicuser_$next.id") {
                   10340: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10341: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10342: 		    $oldest_time=$mtime;
                   10343: 		    $oldest=$next;
                   10344: 		}
                   10345: 	    } else {
                   10346: 		$cookie="publicuser_$next";
                   10347: 		last;
                   10348: 	    }
                   10349: 	}
                   10350: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10351:     } else {
1.463     albertel 10352: 	# if this isn't a robot, kill any existing non-robot sessions
                   10353: 	if (!$args->{'robot'}) {
                   10354: 	    opendir(DIR,$lonids);
                   10355: 	    while ($filename=readdir(DIR)) {
                   10356: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10357: 		    unlink($lonids.'/'.$filename);
                   10358: 		}
1.462     albertel 10359: 	    }
1.463     albertel 10360: 	    closedir(DIR);
1.462     albertel 10361: 	}
                   10362: # Give them a new cookie
1.463     albertel 10363: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10364: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10365: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10366:     
                   10367: # Initialize roles
                   10368: 
                   10369: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10370:     }
                   10371: # ------------------------------------ Check browser type and MathML capability
                   10372: 
                   10373:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10374:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10375: 
                   10376: # ------------------------------------------------------------- Get environment
                   10377: 
                   10378:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10379:     my ($tmp) = keys(%userenv);
                   10380:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10381: 	# default remote control to off
                   10382: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10383:     } else {
                   10384: 	undef(%userenv);
                   10385:     }
                   10386:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10387: 	$form->{'interface'}=$userenv{'interface'};
                   10388:     }
                   10389:     $env{'environment.remote'}=$userenv{'remote'};
                   10390:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10391: 
                   10392: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10393:     foreach my $option ('interface','localpath','localres') {
                   10394:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10395:     }
                   10396: # --------------------------------------------------------- Write first profile
                   10397: 
                   10398:     {
                   10399: 	my %initial_env = 
                   10400: 	    ("user.name"          => $username,
                   10401: 	     "user.domain"        => $domain,
                   10402: 	     "user.home"          => $authhost,
                   10403: 	     "browser.type"       => $clientbrowser,
                   10404: 	     "browser.version"    => $clientversion,
                   10405: 	     "browser.mathml"     => $clientmathml,
                   10406: 	     "browser.unicode"    => $clientunicode,
                   10407: 	     "browser.os"         => $clientos,
                   10408: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10409: 	     "request.course.fn"  => '',
                   10410: 	     "request.course.uri" => '',
                   10411: 	     "request.course.sec" => '',
                   10412: 	     "request.role"       => 'cm',
                   10413: 	     "request.role.adv"   => $env{'user.adv'},
                   10414: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10415: 
                   10416:         if ($form->{'localpath'}) {
                   10417: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10418: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10419:         }
                   10420: 	
                   10421: 	if ($public) {
                   10422: 	    $initial_env{"environment.remote"} = "off";
                   10423: 	}
                   10424: 	if ($form->{'interface'}) {
                   10425: 	    $form->{'interface'}=~s/\W//gs;
                   10426: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10427: 	    $env{'browser.interface'}=$form->{'interface'};
                   10428: 	}
                   10429: 
1.724     raeburn  10430:         foreach my $tool ('aboutme','blog','portfolio') {
                   10431:             $userenv{'availabletools.'.$tool} = 
                   10432:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10433:         }
                   10434: 
1.864     raeburn  10435:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10436:             $userenv{'canrequest.'.$crstype} =
                   10437:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10438:                                                   'reload','requestcourses');
                   10439:         }
                   10440: 
1.462     albertel 10441: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10442: 	
                   10443: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10444: 		 &GDBM_WRCREAT(),0640)) {
                   10445: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10446: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10447: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10448: 	    if (ref($args->{'extra_env'})) {
                   10449: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10450: 	    }
1.462     albertel 10451: 	    untie(%disk_env);
                   10452: 	} else {
1.705     tempelho 10453: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10454: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10455: 	    return 'error: '.$!;
                   10456: 	}
                   10457:     }
                   10458:     $env{'request.role'}='cm';
                   10459:     $env{'request.role.adv'}=$env{'user.adv'};
                   10460:     $env{'browser.type'}=$clientbrowser;
                   10461: 
                   10462:     return $cookie;
                   10463: 
                   10464: }
                   10465: 
                   10466: sub _add_to_env {
                   10467:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10468:     if (ref($env_data) eq 'HASH') {
                   10469:         while (my ($key,$value) = each(%$env_data)) {
                   10470: 	    $idf->{$prefix.$key} = $value;
                   10471: 	    $env{$prefix.$key}   = $value;
                   10472:         }
1.462     albertel 10473:     }
                   10474: }
                   10475: 
1.685     tempelho 10476: # --- Get the symbolic name of a problem and the url
                   10477: sub get_symb {
                   10478:     my ($request,$silent) = @_;
1.726     raeburn  10479:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10480:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10481:     if ($symb eq '') {
                   10482:         if (!$silent) {
                   10483:             $request->print("Unable to handle ambiguous references:$url:.");
                   10484:             return ();
                   10485:         }
                   10486:     }
                   10487:     &Apache::lonenc::check_decrypt(\$symb);
                   10488:     return ($symb);
                   10489: }
                   10490: 
                   10491: # --------------------------------------------------------------Get annotation
                   10492: 
                   10493: sub get_annotation {
                   10494:     my ($symb,$enc) = @_;
                   10495: 
                   10496:     my $key = $symb;
                   10497:     if (!$enc) {
                   10498:         $key =
                   10499:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10500:     }
                   10501:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10502:     return $annotation{$key};
                   10503: }
                   10504: 
                   10505: sub clean_symb {
1.731     raeburn  10506:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10507: 
                   10508:     &Apache::lonenc::check_decrypt(\$symb);
                   10509:     my $enc = $env{'request.enc'};
1.731     raeburn  10510:     if ($delete_enc) {
1.730     raeburn  10511:         delete($env{'request.enc'});
                   10512:     }
1.685     tempelho 10513: 
                   10514:     return ($symb,$enc);
                   10515: }
1.462     albertel 10516: 
1.41      ng       10517: =pod
                   10518: 
                   10519: =back
                   10520: 
1.112     bowersj2 10521: =cut
1.41      ng       10522: 
1.112     bowersj2 10523: 1;
                   10524: __END__;
1.41      ng       10525: 

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