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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.889   ! raeburn     4: # $Id: loncommon.pm,v 1.888 2009/09/06 19:09:54 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.468     raeburn   485:     my ($domainfilter,$sec_element,$formname)=@_;
1.886     raeburn   486:     my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Community - for which you wish to add/modify a user role.');
1.876     raeburn   487:     my $id_functions = &javascript_index_functions();
                    488:     my $output = '
1.776     bisitz    489: <script type="text/javascript" language="JavaScript">
1.824     bisitz    490: // <![CDATA[
1.468     raeburn   491:     var stdeditbrowser;'."\n";
1.876     raeburn   492: 
                    493:     $output .= <<"ENDSTDBRW";
1.377     raeburn   494:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91      www       495:         var url = '/adm/pickcourse?';
1.876     raeburn   496:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  497:         if (domainfilter != null) {
                    498:            if (domainfilter != '') {
                    499:                url += 'domainfilter='+domainfilter+'&';
                    500: 	   }
                    501:         }
1.91      www       502:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  503: 	                            '&cdomelement='+udom+
                    504:                                     '&cnameelement='+desc;
1.468     raeburn   505:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   506:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   507:                 url += '&roleelement='+extra_element;
                    508:                 if (domainfilter == null || domainfilter == '') {
                    509:                     url += '&domainfilter='+extra_element;
                    510:                 }
1.234     raeburn   511:             }
1.468     raeburn   512:             else {
                    513:                 if (formname == 'portform') {
                    514:                     url += '&setroles='+extra_element;
1.800     raeburn   515:                 } else {
                    516:                     if (formname == 'rules') {
                    517:                         url += '&fixeddom='+extra_element; 
                    518:                     }
1.468     raeburn   519:                 }
                    520:             }     
1.230     raeburn   521:         }
1.872     raeburn   522:         if (formname == 'ccrs') {
                    523:             var ownername = document.forms[formid].ccuname.value;
                    524:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    525:             url += '&cloner='+ownername+':'+ownerdom;
                    526:         }
1.293     raeburn   527:         if (multflag !=null && multflag != '') {
                    528:             url += '&multiple='+multflag;
                    529:         }
1.865     raeburn   530:         if (crstype == 'Course/Community') {
1.377     raeburn   531:             if (formname == 'cu') {
                    532:                 crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value; 
                    533:                 if (crstype == "") {
                    534:                     alert("$crs_or_grp_alert");
                    535:                     return;
                    536:                 }
                    537:             }
                    538:         }
                    539:         if (crstype !=null && crstype != '') {
                    540:             url += '&type='+crstype;
                    541:         }
1.102     www       542:         var title = 'Course_Browser';
1.91      www       543:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    544:         options += ',width=700,height=600';
                    545:         stdeditbrowser = open(url,title,options,'1');
                    546:         stdeditbrowser.focus();
                    547:     }
1.876     raeburn   548: $id_functions
                    549: ENDSTDBRW
                    550:     if ($sec_element ne '') {
                    551:         $output .= &setsec_javascript($sec_element,$formname);
                    552:     }
                    553:     $output .= '
                    554: // ]]>
                    555: </script>';
                    556:     return $output;
                    557: }
                    558: 
                    559: sub javascript_index_functions {
                    560:     return <<"ENDJS";
                    561: 
                    562: function getFormIdByName(formname) {
                    563:     for (var i=0;i<document.forms.length;i++) {
                    564:         if (document.forms[i].name == formname) {
                    565:             return i;
                    566:         }
                    567:     }
                    568:     return -1;
                    569: }
                    570: 
                    571: function getIndexByName(formid,item) {
                    572:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    573:         if (document.forms[formid].elements[i].name == item) {
                    574:             return i;
                    575:         }
                    576:     }
                    577:     return -1;
                    578: }
1.468     raeburn   579: 
1.876     raeburn   580: function getDomainFromSelectbox(formname,udom) {
                    581:     var userdom;
                    582:     var formid = getFormIdByName(formname);
                    583:     if (formid > -1) {
                    584:         var domid = getIndexByName(formid,udom);
                    585:         if (domid > -1) {
                    586:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    587:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    588:             }
                    589:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    590:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   591:             }
                    592:         }
                    593:     }
1.876     raeburn   594:     return userdom;
                    595: }
                    596: 
                    597: ENDJS
1.468     raeburn   598: 
1.876     raeburn   599: }
                    600: 
                    601: sub userbrowser_javascript {
                    602:     my $id_functions = &javascript_index_functions();
                    603:     return <<"ENDUSERBRW";
                    604: 
1.888     raeburn   605: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   606:     var url = '/adm/pickuser?';
                    607:     var userdom = getDomainFromSelectbox(formname,udom);
                    608:     if (userdom != null) {
                    609:        if (userdom != '') {
                    610:            url += 'srchdom='+userdom+'&';
                    611:        }
                    612:     }
                    613:     url += 'form=' + formname + '&unameelement='+uname+
                    614:                                 '&udomelement='+udom+
                    615:                                 '&ulastelement='+ulast+
                    616:                                 '&ufirstelement='+ufirst+
                    617:                                 '&uemailelement='+uemail+
1.881     raeburn   618:                                 '&hideudomelement='+hideudom+
                    619:                                 '&coursedom='+crsdom;
1.888     raeburn   620:     if ((caller != null) && (caller != undefined)) {
                    621:         url += '&caller='+caller;
                    622:     }
1.876     raeburn   623:     var title = 'User_Browser';
                    624:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    625:     options += ',width=700,height=600';
                    626:     var stdeditbrowser = open(url,title,options,'1');
                    627:     stdeditbrowser.focus();
                    628: }
                    629: 
1.888     raeburn   630: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   631:     var formid = getFormIdByName(formname);
                    632:     if (formid > -1) {
1.888     raeburn   633:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   634:         var domid = getIndexByName(formid,udom);
                    635:         var hidedomid = getIndexByName(formid,origdom);
                    636:         if (hidedomid > -1) {
                    637:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   638:             var unameval = document.forms[formid].elements[unameid].value;
                    639:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    640:                 if (domid > -1) {
                    641:                     var slct = document.forms[formid].elements[domid];
                    642:                     if (slct.type == 'select-one') {
                    643:                         var i;
                    644:                         for (i=0;i<slct.length;i++) {
                    645:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    646:                         }
                    647:                     }
                    648:                     if (slct.type == 'hidden') {
                    649:                         slct.value = fixeddom;
1.876     raeburn   650:                     }
                    651:                 }
1.468     raeburn   652:             }
                    653:         }
                    654:     }
1.876     raeburn   655:     return;
                    656: }
                    657: 
                    658: $id_functions
                    659: ENDUSERBRW
1.468     raeburn   660: }
                    661: 
                    662: sub setsec_javascript {
                    663:     my ($sec_element,$formname) = @_;
                    664:     my $setsections = qq|
                    665: function setSect(sectionlist) {
1.629     raeburn   666:     var sectionsArray = new Array();
                    667:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    668:         sectionsArray = sectionlist.split(",");
                    669:     }
1.468     raeburn   670:     var numSections = sectionsArray.length;
                    671:     document.$formname.$sec_element.length = 0;
                    672:     if (numSections == 0) {
                    673:         document.$formname.$sec_element.multiple=false;
                    674:         document.$formname.$sec_element.size=1;
                    675:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    676:     } else {
                    677:         if (numSections == 1) {
                    678:             document.$formname.$sec_element.multiple=false;
                    679:             document.$formname.$sec_element.size=1;
                    680:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    681:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    682:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    683:         } else {
                    684:             for (var i=0; i<numSections; i++) {
                    685:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    686:             }
                    687:             document.$formname.$sec_element.multiple=true
                    688:             if (numSections < 3) {
                    689:                 document.$formname.$sec_element.size=numSections;
                    690:             } else {
                    691:                 document.$formname.$sec_element.size=3;
                    692:             }
                    693:             document.$formname.$sec_element.options[0].selected = false
                    694:         }
                    695:     }
1.91      www       696: }
1.468     raeburn   697: |;
                    698:     return $setsections;
                    699: }
                    700: 
1.91      www       701: 
                    702: sub selectcourse_link {
1.377     raeburn   703:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.871     raeburn   704:    my $linktext = &mt('Select Course');
                    705:    if ($selecttype eq 'Community') {
                    706:        $linktext = &mt('Select Community'); 
                    707:    }
1.787     bisitz    708:    return '<span class="LC_nobreak">'
                    709:          ."<a href='"
                    710:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    711:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
                    712:          .'","'.$multflag.'","'.$selecttype.'");'
1.871     raeburn   713:          ."'>".$linktext.'</a>'
1.787     bisitz    714:          .'</span>';
1.74      www       715: }
1.42      matthew   716: 
1.653     raeburn   717: sub selectauthor_link {
                    718:    my ($form,$udom)=@_;
                    719:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    720:           &mt('Select Author').'</a>';
                    721: }
                    722: 
1.876     raeburn   723: sub selectuser_link {
1.881     raeburn   724:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   725:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   726:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   727:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   728:            ');">'.$linktext.'</a>';
1.876     raeburn   729: }
                    730: 
1.273     raeburn   731: sub check_uncheck_jscript {
                    732:     my $jscript = <<"ENDSCRT";
                    733: function checkAll(field) {
                    734:     if (field.length > 0) {
                    735:         for (i = 0; i < field.length; i++) {
                    736:             field[i].checked = true ;
                    737:         }
                    738:     } else {
                    739:         field.checked = true
                    740:     }
                    741: }
                    742:  
                    743: function uncheckAll(field) {
                    744:     if (field.length > 0) {
                    745:         for (i = 0; i < field.length; i++) {
                    746:             field[i].checked = false ;
1.543     albertel  747:         }
                    748:     } else {
1.273     raeburn   749:         field.checked = false ;
                    750:     }
                    751: }
                    752: ENDSCRT
                    753:     return $jscript;
                    754: }
                    755: 
1.656     www       756: sub select_timezone {
1.659     raeburn   757:    my ($name,$selected,$onchange,$includeempty)=@_;
                    758:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    759:    if ($includeempty) {
                    760:        $output .= '<option value=""';
                    761:        if (($selected eq '') || ($selected eq 'local')) {
                    762:            $output .= ' selected="selected" ';
                    763:        }
                    764:        $output .= '> </option>';
                    765:    }
1.657     raeburn   766:    my @timezones = DateTime::TimeZone->all_names;
                    767:    foreach my $tzone (@timezones) {
                    768:        $output.= '<option value="'.$tzone.'"';
                    769:        if ($tzone eq $selected) {
                    770:            $output.=' selected="selected"';
                    771:        }
                    772:        $output.=">$tzone</option>\n";
1.656     www       773:    }
                    774:    $output.="</select>";
                    775:    return $output;
                    776: }
1.273     raeburn   777: 
1.687     raeburn   778: sub select_datelocale {
                    779:     my ($name,$selected,$onchange,$includeempty)=@_;
                    780:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    781:     if ($includeempty) {
                    782:         $output .= '<option value=""';
                    783:         if ($selected eq '') {
                    784:             $output .= ' selected="selected" ';
                    785:         }
                    786:         $output .= '> </option>';
                    787:     }
                    788:     my (@possibles,%locale_names);
                    789:     my @locales = DateTime::Locale::Catalog::Locales;
                    790:     foreach my $locale (@locales) {
                    791:         if (ref($locale) eq 'HASH') {
                    792:             my $id = $locale->{'id'};
                    793:             if ($id ne '') {
                    794:                 my $en_terr = $locale->{'en_territory'};
                    795:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   796:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   797:                 if (grep(/^en$/,@languages) || !@languages) {
                    798:                     if ($en_terr ne '') {
                    799:                         $locale_names{$id} = '('.$en_terr.')';
                    800:                     } elsif ($native_terr ne '') {
                    801:                         $locale_names{$id} = $native_terr;
                    802:                     }
                    803:                 } else {
                    804:                     if ($native_terr ne '') {
                    805:                         $locale_names{$id} = $native_terr.' ';
                    806:                     } elsif ($en_terr ne '') {
                    807:                         $locale_names{$id} = '('.$en_terr.')';
                    808:                     }
                    809:                 }
                    810:                 push (@possibles,$id);
                    811:             }
                    812:         }
                    813:     }
                    814:     foreach my $item (sort(@possibles)) {
                    815:         $output.= '<option value="'.$item.'"';
                    816:         if ($item eq $selected) {
                    817:             $output.=' selected="selected"';
                    818:         }
                    819:         $output.=">$item";
                    820:         if ($locale_names{$item} ne '') {
                    821:             $output.="  $locale_names{$item}</option>\n";
                    822:         }
                    823:         $output.="</option>\n";
                    824:     }
                    825:     $output.="</select>";
                    826:     return $output;
                    827: }
                    828: 
1.792     raeburn   829: sub select_language {
                    830:     my ($name,$selected,$includeempty) = @_;
                    831:     my %langchoices;
                    832:     if ($includeempty) {
                    833:         %langchoices = ('' => 'No language preference');
                    834:     }
                    835:     foreach my $id (&languageids()) {
                    836:         my $code = &supportedlanguagecode($id);
                    837:         if ($code) {
                    838:             $langchoices{$code} = &plainlanguagedescription($id);
                    839:         }
                    840:     }
                    841:     return &select_form($selected,$name,%langchoices);
                    842: }
                    843: 
1.42      matthew   844: =pod
1.36      matthew   845: 
1.648     raeburn   846: =item * &linked_select_forms(...)
1.36      matthew   847: 
                    848: linked_select_forms returns a string containing a <script></script> block
                    849: and html for two <select> menus.  The select menus will be linked in that
                    850: changing the value of the first menu will result in new values being placed
                    851: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   852: order unless a defined order is provided.
1.36      matthew   853: 
                    854: linked_select_forms takes the following ordered inputs:
                    855: 
                    856: =over 4
                    857: 
1.112     bowersj2  858: =item * $formname, the name of the <form> tag
1.36      matthew   859: 
1.112     bowersj2  860: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   861: 
1.112     bowersj2  862: =item * $firstdefault, the default value for the first menu
1.36      matthew   863: 
1.112     bowersj2  864: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   865: 
1.112     bowersj2  866: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   867: 
1.112     bowersj2  868: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   869: 
1.609     raeburn   870: =item * $menuorder, the order of values in the first menu
                    871: 
1.41      ng        872: =back 
                    873: 
1.36      matthew   874: Below is an example of such a hash.  Only the 'text', 'default', and 
                    875: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    876: values for the first select menu.  The text that coincides with the 
1.41      ng        877: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   878: and text for the second menu are given in the hash pointed to by 
                    879: $menu{$choice1}->{'select2'}.  
                    880: 
1.112     bowersj2  881:  my %menu = ( A1 => { text =>"Choice A1" ,
                    882:                        default => "B3",
                    883:                        select2 => { 
                    884:                            B1 => "Choice B1",
                    885:                            B2 => "Choice B2",
                    886:                            B3 => "Choice B3",
                    887:                            B4 => "Choice B4"
1.609     raeburn   888:                            },
                    889:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  890:                    },
                    891:                A2 => { text =>"Choice A2" ,
                    892:                        default => "C2",
                    893:                        select2 => { 
                    894:                            C1 => "Choice C1",
                    895:                            C2 => "Choice C2",
                    896:                            C3 => "Choice C3"
1.609     raeburn   897:                            },
                    898:                        order => ['C2','C1','C3'],
1.112     bowersj2  899:                    },
                    900:                A3 => { text =>"Choice A3" ,
                    901:                        default => "D6",
                    902:                        select2 => { 
                    903:                            D1 => "Choice D1",
                    904:                            D2 => "Choice D2",
                    905:                            D3 => "Choice D3",
                    906:                            D4 => "Choice D4",
                    907:                            D5 => "Choice D5",
                    908:                            D6 => "Choice D6",
                    909:                            D7 => "Choice D7"
1.609     raeburn   910:                            },
                    911:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  912:                    }
                    913:                );
1.36      matthew   914: 
                    915: =cut
                    916: 
                    917: sub linked_select_forms {
                    918:     my ($formname,
                    919:         $middletext,
                    920:         $firstdefault,
                    921:         $firstselectname,
                    922:         $secondselectname, 
1.609     raeburn   923:         $hashref,
                    924:         $menuorder,
1.36      matthew   925:         ) = @_;
                    926:     my $second = "document.$formname.$secondselectname";
                    927:     my $first = "document.$formname.$firstselectname";
                    928:     # output the javascript to do the changing
                    929:     my $result = '';
1.776     bisitz    930:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    931:     $result.="// <![CDATA[\n";
1.36      matthew   932:     $result.="var select2data = new Object();\n";
                    933:     $" = '","';
                    934:     my $debug = '';
                    935:     foreach my $s1 (sort(keys(%$hashref))) {
                    936:         $result.="select2data.d_$s1 = new Object();\n";        
                    937:         $result.="select2data.d_$s1.def = new String('".
                    938:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn   939:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew   940:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn   941:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                    942:             @s2values = @{$hashref->{$s1}->{'order'}};
                    943:         }
1.36      matthew   944:         $result.="\"@s2values\");\n";
                    945:         $result.="select2data.d_$s1.texts = new Array(";        
                    946:         my @s2texts;
                    947:         foreach my $value (@s2values) {
                    948:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                    949:         }
                    950:         $result.="\"@s2texts\");\n";
                    951:     }
                    952:     $"=' ';
                    953:     $result.= <<"END";
                    954: 
                    955: function select1_changed() {
                    956:     // Determine new choice
                    957:     var newvalue = "d_" + $first.value;
                    958:     // update select2
                    959:     var values     = select2data[newvalue].values;
                    960:     var texts      = select2data[newvalue].texts;
                    961:     var select2def = select2data[newvalue].def;
                    962:     var i;
                    963:     // out with the old
                    964:     for (i = 0; i < $second.options.length; i++) {
                    965:         $second.options[i] = null;
                    966:     }
                    967:     // in with the nuclear
                    968:     for (i=0;i<values.length; i++) {
                    969:         $second.options[i] = new Option(values[i]);
1.143     matthew   970:         $second.options[i].value = values[i];
1.36      matthew   971:         $second.options[i].text = texts[i];
                    972:         if (values[i] == select2def) {
                    973:             $second.options[i].selected = true;
                    974:         }
                    975:     }
                    976: }
1.824     bisitz    977: // ]]>
1.36      matthew   978: </script>
                    979: END
                    980:     # output the initial values for the selection lists
                    981:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn   982:     my @order = sort(keys(%{$hashref}));
                    983:     if (ref($menuorder) eq 'ARRAY') {
                    984:         @order = @{$menuorder};
                    985:     }
                    986:     foreach my $value (@order) {
1.36      matthew   987:         $result.="    <option value=\"$value\" ";
1.253     albertel  988:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www       989:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew   990:     }
                    991:     $result .= "</select>\n";
                    992:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                    993:     $result .= $middletext;
                    994:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                    995:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn   996:     
                    997:     my @secondorder = sort(keys(%select2));
                    998:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                    999:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1000:     }
                   1001:     foreach my $value (@secondorder) {
1.36      matthew  1002:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1003:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1004:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1005:     }
                   1006:     $result .= "</select>\n";
                   1007:     #    return $debug;
                   1008:     return $result;
                   1009: }   #  end of sub linked_select_forms {
                   1010: 
1.45      matthew  1011: =pod
1.44      bowersj2 1012: 
1.648     raeburn  1013: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1014: 
1.112     bowersj2 1015: Returns a string corresponding to an HTML link to the given help
                   1016: $topic, where $topic corresponds to the name of a .tex file in
                   1017: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1018: spaces. 
                   1019: 
                   1020: $text will optionally be linked to the same topic, allowing you to
                   1021: link text in addition to the graphic. If you do not want to link
                   1022: text, but wish to specify one of the later parameters, pass an
                   1023: empty string. 
                   1024: 
                   1025: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1026: the link will not open a new window. If false, the link will open
                   1027: a new window using Javascript. (Default is false.) 
                   1028: 
                   1029: $width and $height are optional numerical parameters that will
                   1030: override the width and height of the popped up window, which may
                   1031: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1032: 
                   1033: =cut
                   1034: 
                   1035: sub help_open_topic {
1.48      bowersj2 1036:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1037:     $text = "" if (not defined $text);
1.44      bowersj2 1038:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1039:     $width = 350 if (not defined $width);
                   1040:     $height = 400 if (not defined $height);
                   1041:     my $filename = $topic;
                   1042:     $filename =~ s/ /_/g;
                   1043: 
1.48      bowersj2 1044:     my $template = "";
                   1045:     my $link;
1.572     banghart 1046:     
1.159     www      1047:     $topic=~s/\W/\_/g;
1.44      bowersj2 1048: 
1.572     banghart 1049:     if (!$stayOnPage) {
1.72      bowersj2 1050: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1051:     } else {
1.48      bowersj2 1052: 	$link = "/adm/help/${filename}.hlp";
                   1053:     }
                   1054: 
                   1055:     # Add the text
1.755     neumanie 1056:     if ($text ne "") {	
1.763     bisitz   1057: 	$template.='<span class="LC_help_open_topic">'
                   1058:                   .'<a target="_top" href="'.$link.'">'
                   1059:                   .$text.'</a>';
1.48      bowersj2 1060:     }
                   1061: 
1.763     bisitz   1062:     # (Always) Add the graphic
1.179     matthew  1063:     my $title = &mt('Online Help');
1.667     raeburn  1064:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1065:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1066:               .'<img src="'.$helpicon.'" border="0"'
                   1067:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1068:               .' title="'.$title.'"' 
1.763     bisitz   1069:               .' /></a>';
                   1070:     if ($text ne "") {	
                   1071:         $template.='</span>';
                   1072:     }
1.44      bowersj2 1073:     return $template;
                   1074: 
1.106     bowersj2 1075: }
                   1076: 
                   1077: # This is a quicky function for Latex cheatsheet editing, since it 
                   1078: # appears in at least four places
                   1079: sub helpLatexCheatsheet {
1.732     raeburn  1080:     my ($topic,$text,$not_author) = @_;
                   1081:     my $out;
1.106     bowersj2 1082:     my $addOther = '';
1.732     raeburn  1083:     if ($topic) {
1.763     bisitz   1084: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1085: 							       undef, undef, 600).
                   1086: 								   '</span> ';
                   1087:     }
                   1088:     $out = '<span>' # Start cheatsheet
                   1089: 	  .$addOther
                   1090:           .'<span>'
                   1091: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1092: 					       undef,undef,600)
                   1093: 	  .'</span> <span>'
                   1094: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1095: 					       undef,undef,600)
                   1096: 	  .'</span>';
1.732     raeburn  1097:     unless ($not_author) {
1.763     bisitz   1098:         $out .= ' <span>'
                   1099: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1100: 	                                            undef,undef,600)
                   1101: 	       .'</span>';
1.732     raeburn  1102:     }
1.763     bisitz   1103:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1104:     return $out;
1.172     www      1105: }
                   1106: 
1.430     albertel 1107: sub general_help {
                   1108:     my $helptopic='Student_Intro';
                   1109:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1110: 	$helptopic='Authoring_Intro';
                   1111:     } elsif ($env{'request.role'}=~/^cc/) {
                   1112: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1113:     } elsif ($env{'request.role'}=~/^dc/) {
                   1114:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1115:     }
                   1116:     return $helptopic;
                   1117: }
                   1118: 
                   1119: sub update_help_link {
                   1120:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1121:     my $origurl = $ENV{'REQUEST_URI'};
                   1122:     $origurl=~s|^/~|/priv/|;
                   1123:     my $timestamp = time;
                   1124:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1125:         $$datum = &escape($$datum);
                   1126:     }
                   1127: 
                   1128:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1129:     my $output .= <<"ENDOUTPUT";
                   1130: <script type="text/javascript">
1.824     bisitz   1131: // <![CDATA[
1.430     albertel 1132: banner_link = '$banner_link';
1.824     bisitz   1133: // ]]>
1.430     albertel 1134: </script>
                   1135: ENDOUTPUT
                   1136:     return $output;
                   1137: }
                   1138: 
                   1139: # now just updates the help link and generates a blue icon
1.193     raeburn  1140: sub help_open_menu {
1.430     albertel 1141:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1142: 	= @_;    
1.430     albertel 1143:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1144:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1145:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1146:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1147:         $stayOnPage=1;
1.430     albertel 1148:     }
                   1149:     my $output;
                   1150:     if ($component_help) {
                   1151: 	if (!$text) {
                   1152: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1153: 				       $width,$height);
                   1154: 	} else {
                   1155: 	    my $help_text;
                   1156: 	    $help_text=&unescape($topic);
                   1157: 	    $output='<table><tr><td>'.
                   1158: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1159: 				 $width,$height).'</td></tr></table>';
                   1160: 	}
                   1161:     }
                   1162:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1163:     return $output.$banner_link;
                   1164: }
                   1165: 
                   1166: sub top_nav_help {
                   1167:     my ($text) = @_;
1.436     albertel 1168:     $text = &mt($text);
1.572     banghart 1169:     my $stay_on_page = 
1.798     tempelho 1170: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1171:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1172: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1173:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1174: 
1.201     raeburn  1175:     my $title = &mt('Get help');
1.436     albertel 1176: 
                   1177:     return <<"END";
                   1178: $banner_link
                   1179:  <a href="$link" title="$title">$text</a>
                   1180: END
                   1181: }
                   1182: 
                   1183: sub help_menu_js {
                   1184:     my ($text) = @_;
                   1185: 
                   1186:     my $stayOnPage = 
1.798     tempelho 1187: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1188: 
                   1189:     my $width = 620;
                   1190:     my $height = 600;
1.430     albertel 1191:     my $helptopic=&general_help();
                   1192:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1193:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1194:     my $start_page =
                   1195:         &Apache::loncommon::start_page('Help Menu', undef,
                   1196: 				       {'frameset'    => 1,
                   1197: 					'js_ready'    => 1,
                   1198: 					'add_entries' => {
                   1199: 					    'border' => '0',
1.579     raeburn  1200: 					    'rows'   => "110,*",},});
1.331     albertel 1201:     my $end_page =
                   1202:         &Apache::loncommon::end_page({'frameset' => 1,
                   1203: 				      'js_ready' => 1,});
                   1204: 
1.436     albertel 1205:     my $template .= <<"ENDTEMPLATE";
                   1206: <script type="text/javascript">
1.877     bisitz   1207: // <![CDATA[
1.253     albertel 1208: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1209: var banner_link = '';
1.243     raeburn  1210: function helpMenu(target) {
                   1211:     var caller = this;
                   1212:     if (target == 'open') {
                   1213:         var newWindow = null;
                   1214:         try {
1.262     albertel 1215:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1216:         }
                   1217:         catch(error) {
                   1218:             writeHelp(caller);
                   1219:             return;
                   1220:         }
                   1221:         if (newWindow) {
                   1222:             caller = newWindow;
                   1223:         }
1.193     raeburn  1224:     }
1.243     raeburn  1225:     writeHelp(caller);
                   1226:     return;
                   1227: }
                   1228: function writeHelp(caller) {
1.430     albertel 1229:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1230:     caller.document.close()
                   1231:     caller.focus()
1.193     raeburn  1232: }
1.877     bisitz   1233: // END LON-CAPA Internal -->
1.253     albertel 1234: // ]]>
1.436     albertel 1235: </script>
1.193     raeburn  1236: ENDTEMPLATE
                   1237:     return $template;
                   1238: }
                   1239: 
1.172     www      1240: sub help_open_bug {
                   1241:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1242:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1243:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1244:     $text = "" if (not defined $text);
                   1245:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1246:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1247: 	$stayOnPage=1;
                   1248:     }
1.184     albertel 1249:     $width = 600 if (not defined $width);
                   1250:     $height = 600 if (not defined $height);
1.172     www      1251: 
                   1252:     $topic=~s/\W+/\+/g;
                   1253:     my $link='';
                   1254:     my $template='';
1.379     albertel 1255:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1256: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1257:     if (!$stayOnPage)
                   1258:     {
                   1259: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1260:     }
                   1261:     else
                   1262:     {
                   1263: 	$link = $url;
                   1264:     }
                   1265:     # Add the text
                   1266:     if ($text ne "")
                   1267:     {
                   1268: 	$template .= 
                   1269:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1270:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1271:     }
                   1272: 
                   1273:     # Add the graphic
1.179     matthew  1274:     my $title = &mt('Report a Bug');
1.215     albertel 1275:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1276:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1277:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1278: ENDTEMPLATE
                   1279:     if ($text ne '') { $template.='</td></tr></table>' };
                   1280:     return $template;
                   1281: 
                   1282: }
                   1283: 
                   1284: sub help_open_faq {
                   1285:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1286:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1287:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1288:     $text = "" if (not defined $text);
                   1289:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1290:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1291: 	$stayOnPage=1;
                   1292:     }
                   1293:     $width = 350 if (not defined $width);
                   1294:     $height = 400 if (not defined $height);
                   1295: 
                   1296:     $topic=~s/\W+/\+/g;
                   1297:     my $link='';
                   1298:     my $template='';
                   1299:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1300:     if (!$stayOnPage)
                   1301:     {
                   1302: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1303:     }
                   1304:     else
                   1305:     {
                   1306: 	$link = $url;
                   1307:     }
                   1308: 
                   1309:     # Add the text
                   1310:     if ($text ne "")
                   1311:     {
                   1312: 	$template .= 
1.173     www      1313:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1314:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1315:     }
                   1316: 
                   1317:     # Add the graphic
1.179     matthew  1318:     my $title = &mt('View the FAQ');
1.215     albertel 1319:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1320:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1321:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1322: ENDTEMPLATE
                   1323:     if ($text ne '') { $template.='</td></tr></table>' };
                   1324:     return $template;
                   1325: 
1.44      bowersj2 1326: }
1.37      matthew  1327: 
1.180     matthew  1328: ###############################################################
                   1329: ###############################################################
                   1330: 
1.45      matthew  1331: =pod
                   1332: 
1.648     raeburn  1333: =item * &change_content_javascript():
1.256     matthew  1334: 
                   1335: This and the next function allow you to create small sections of an
                   1336: otherwise static HTML page that you can update on the fly with
                   1337: Javascript, even in Netscape 4.
                   1338: 
                   1339: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1340: must be written to the HTML page once. It will prove the Javascript
                   1341: function "change(name, content)". Calling the change function with the
                   1342: name of the section 
                   1343: you want to update, matching the name passed to C<changable_area>, and
                   1344: the new content you want to put in there, will put the content into
                   1345: that area.
                   1346: 
                   1347: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1348: to contain room for the original contents. You need to "make space"
                   1349: for whatever changes you wish to make, and be B<sure> to check your
                   1350: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1351: it's adequate for updating a one-line status display, but little more.
                   1352: This script will set the space to 100% width, so you only need to
                   1353: worry about height in Netscape 4.
                   1354: 
                   1355: Modern browsers are much less limiting, and if you can commit to the
                   1356: user not using Netscape 4, this feature may be used freely with
                   1357: pretty much any HTML.
                   1358: 
                   1359: =cut
                   1360: 
                   1361: sub change_content_javascript {
                   1362:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1363:     if ($env{'browser.type'} eq 'netscape' &&
                   1364: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1365: 	return (<<NETSCAPE4);
                   1366: 	function change(name, content) {
                   1367: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1368: 	    doc.open();
                   1369: 	    doc.write(content);
                   1370: 	    doc.close();
                   1371: 	}
                   1372: NETSCAPE4
                   1373:     } else {
                   1374: 	# Otherwise, we need to use semi-standards-compliant code
                   1375: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1376: 	# is really scary, and every useful browser supports it
                   1377: 	return (<<DOMBASED);
                   1378: 	function change(name, content) {
                   1379: 	    element = document.getElementById(name);
                   1380: 	    element.innerHTML = content;
                   1381: 	}
                   1382: DOMBASED
                   1383:     }
                   1384: }
                   1385: 
                   1386: =pod
                   1387: 
1.648     raeburn  1388: =item * &changable_area($name,$origContent):
1.256     matthew  1389: 
                   1390: This provides a "changable area" that can be modified on the fly via
                   1391: the Javascript code provided in C<change_content_javascript>. $name is
                   1392: the name you will use to reference the area later; do not repeat the
                   1393: same name on a given HTML page more then once. $origContent is what
                   1394: the area will originally contain, which can be left blank.
                   1395: 
                   1396: =cut
                   1397: 
                   1398: sub changable_area {
                   1399:     my ($name, $origContent) = @_;
                   1400: 
1.258     albertel 1401:     if ($env{'browser.type'} eq 'netscape' &&
                   1402: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1403: 	# If this is netscape 4, we need to use the Layer tag
                   1404: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1405:     } else {
                   1406: 	return "<span id='$name'>$origContent</span>";
                   1407:     }
                   1408: }
                   1409: 
                   1410: =pod
                   1411: 
1.648     raeburn  1412: =item * &viewport_geometry_js 
1.590     raeburn  1413: 
                   1414: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1415: 
                   1416: =cut
                   1417: 
                   1418: 
                   1419: sub viewport_geometry_js { 
                   1420:     return <<"GEOMETRY";
                   1421: var Geometry = {};
                   1422: function init_geometry() {
                   1423:     if (Geometry.init) { return };
                   1424:     Geometry.init=1;
                   1425:     if (window.innerHeight) {
                   1426:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1427:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1428:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1429:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1430:     }
                   1431:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1432:         Geometry.getViewportHeight =
                   1433:             function() { return document.documentElement.clientHeight; };
                   1434:         Geometry.getViewportWidth =
                   1435:             function() { return document.documentElement.clientWidth; };
                   1436: 
                   1437:         Geometry.getHorizontalScroll =
                   1438:             function() { return document.documentElement.scrollLeft; };
                   1439:         Geometry.getVerticalScroll =
                   1440:             function() { return document.documentElement.scrollTop; };
                   1441:     }
                   1442:     else if (document.body.clientHeight) {
                   1443:         Geometry.getViewportHeight =
                   1444:             function() { return document.body.clientHeight; };
                   1445:         Geometry.getViewportWidth =
                   1446:             function() { return document.body.clientWidth; };
                   1447:         Geometry.getHorizontalScroll =
                   1448:             function() { return document.body.scrollLeft; };
                   1449:         Geometry.getVerticalScroll =
                   1450:             function() { return document.body.scrollTop; };
                   1451:     }
                   1452: }
                   1453: 
                   1454: GEOMETRY
                   1455: }
                   1456: 
                   1457: =pod
                   1458: 
1.648     raeburn  1459: =item * &viewport_size_js()
1.590     raeburn  1460: 
                   1461: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1462: 
                   1463: =cut
                   1464: 
                   1465: sub viewport_size_js {
                   1466:     my $geometry = &viewport_geometry_js();
                   1467:     return <<"DIMS";
                   1468: 
                   1469: $geometry
                   1470: 
                   1471: function getViewportDims(width,height) {
                   1472:     init_geometry();
                   1473:     width.value = Geometry.getViewportWidth();
                   1474:     height.value = Geometry.getViewportHeight();
                   1475:     return;
                   1476: }
                   1477: 
                   1478: DIMS
                   1479: }
                   1480: 
                   1481: =pod
                   1482: 
1.648     raeburn  1483: =item * &resize_textarea_js()
1.565     albertel 1484: 
                   1485: emits the needed javascript to resize a textarea to be as big as possible
                   1486: 
                   1487: creates a function resize_textrea that takes two IDs first should be
                   1488: the id of the element to resize, second should be the id of a div that
                   1489: surrounds everything that comes after the textarea, this routine needs
                   1490: to be attached to the <body> for the onload and onresize events.
                   1491: 
1.648     raeburn  1492: =back
1.565     albertel 1493: 
                   1494: =cut
                   1495: 
                   1496: sub resize_textarea_js {
1.590     raeburn  1497:     my $geometry = &viewport_geometry_js();
1.565     albertel 1498:     return <<"RESIZE";
                   1499:     <script type="text/javascript">
1.824     bisitz   1500: // <![CDATA[
1.590     raeburn  1501: $geometry
1.565     albertel 1502: 
1.588     albertel 1503: function getX(element) {
                   1504:     var x = 0;
                   1505:     while (element) {
                   1506: 	x += element.offsetLeft;
                   1507: 	element = element.offsetParent;
                   1508:     }
                   1509:     return x;
                   1510: }
                   1511: function getY(element) {
                   1512:     var y = 0;
                   1513:     while (element) {
                   1514: 	y += element.offsetTop;
                   1515: 	element = element.offsetParent;
                   1516:     }
                   1517:     return y;
                   1518: }
                   1519: 
                   1520: 
1.565     albertel 1521: function resize_textarea(textarea_id,bottom_id) {
                   1522:     init_geometry();
                   1523:     var textarea        = document.getElementById(textarea_id);
                   1524:     //alert(textarea);
                   1525: 
1.588     albertel 1526:     var textarea_top    = getY(textarea);
1.565     albertel 1527:     var textarea_height = textarea.offsetHeight;
                   1528:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1529:     var bottom_top      = getY(bottom);
1.565     albertel 1530:     var bottom_height   = bottom.offsetHeight;
                   1531:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1532:     var fudge           = 23;
1.565     albertel 1533:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1534:     if (new_height < 300) {
                   1535: 	new_height = 300;
                   1536:     }
                   1537:     textarea.style.height=new_height+'px';
                   1538: }
1.824     bisitz   1539: // ]]>
1.565     albertel 1540: </script>
                   1541: RESIZE
                   1542: 
                   1543: }
                   1544: 
                   1545: =pod
                   1546: 
1.256     matthew  1547: =head1 Excel and CSV file utility routines
                   1548: 
                   1549: =over 4
                   1550: 
                   1551: =cut
                   1552: 
                   1553: ###############################################################
                   1554: ###############################################################
                   1555: 
                   1556: =pod
                   1557: 
1.648     raeburn  1558: =item * &csv_translate($text) 
1.37      matthew  1559: 
1.185     www      1560: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1561: format.
                   1562: 
                   1563: =cut
                   1564: 
1.180     matthew  1565: ###############################################################
                   1566: ###############################################################
1.37      matthew  1567: sub csv_translate {
                   1568:     my $text = shift;
                   1569:     $text =~ s/\"/\"\"/g;
1.209     albertel 1570:     $text =~ s/\n/ /g;
1.37      matthew  1571:     return $text;
                   1572: }
1.180     matthew  1573: 
                   1574: ###############################################################
                   1575: ###############################################################
                   1576: 
                   1577: =pod
                   1578: 
1.648     raeburn  1579: =item * &define_excel_formats()
1.180     matthew  1580: 
                   1581: Define some commonly used Excel cell formats.
                   1582: 
                   1583: Currently supported formats:
                   1584: 
                   1585: =over 4
                   1586: 
                   1587: =item header
                   1588: 
                   1589: =item bold
                   1590: 
                   1591: =item h1
                   1592: 
                   1593: =item h2
                   1594: 
                   1595: =item h3
                   1596: 
1.256     matthew  1597: =item h4
                   1598: 
                   1599: =item i
                   1600: 
1.180     matthew  1601: =item date
                   1602: 
                   1603: =back
                   1604: 
                   1605: Inputs: $workbook
                   1606: 
                   1607: Returns: $format, a hash reference.
                   1608: 
                   1609: =cut
                   1610: 
                   1611: ###############################################################
                   1612: ###############################################################
                   1613: sub define_excel_formats {
                   1614:     my ($workbook) = @_;
                   1615:     my $format;
                   1616:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1617:                                                 bottom    => 1,
                   1618:                                                 align     => 'center');
                   1619:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1620:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1621:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1622:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1623:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1624:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1625:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1626:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1627:     return $format;
                   1628: }
                   1629: 
                   1630: ###############################################################
                   1631: ###############################################################
1.113     bowersj2 1632: 
                   1633: =pod
                   1634: 
1.648     raeburn  1635: =item * &create_workbook()
1.255     matthew  1636: 
                   1637: Create an Excel worksheet.  If it fails, output message on the
                   1638: request object and return undefs.
                   1639: 
                   1640: Inputs: Apache request object
                   1641: 
                   1642: Returns (undef) on failure, 
                   1643:     Excel worksheet object, scalar with filename, and formats 
                   1644:     from &Apache::loncommon::define_excel_formats on success
                   1645: 
                   1646: =cut
                   1647: 
                   1648: ###############################################################
                   1649: ###############################################################
                   1650: sub create_workbook {
                   1651:     my ($r) = @_;
                   1652:         #
                   1653:     # Create the excel spreadsheet
                   1654:     my $filename = '/prtspool/'.
1.258     albertel 1655:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1656:         time.'_'.rand(1000000000).'.xls';
                   1657:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1658:     if (! defined($workbook)) {
                   1659:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1660:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1661:                             "This error has been logged.  ".
                   1662:                             "Please alert your LON-CAPA administrator").
                   1663:                   '</p>');
                   1664:         return (undef);
                   1665:     }
                   1666:     #
                   1667:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1668:     #
                   1669:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1670:     return ($workbook,$filename,$format);
                   1671: }
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: 
                   1676: =pod
                   1677: 
1.648     raeburn  1678: =item * &create_text_file()
1.113     bowersj2 1679: 
1.542     raeburn  1680: Create a file to write to and eventually make available to the user.
1.256     matthew  1681: If file creation fails, outputs an error message on the request object and 
                   1682: return undefs.
1.113     bowersj2 1683: 
1.256     matthew  1684: Inputs: Apache request object, and file suffix
1.113     bowersj2 1685: 
1.256     matthew  1686: Returns (undef) on failure, 
                   1687:     Filehandle and filename on success.
1.113     bowersj2 1688: 
                   1689: =cut
                   1690: 
1.256     matthew  1691: ###############################################################
                   1692: ###############################################################
                   1693: sub create_text_file {
                   1694:     my ($r,$suffix) = @_;
                   1695:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1696:     my $fh;
                   1697:     my $filename = '/prtspool/'.
1.258     albertel 1698:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1699:         time.'_'.rand(1000000000).'.'.$suffix;
                   1700:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1701:     if (! defined($fh)) {
                   1702:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1703:         $r->print(&mt('Problems occurred in creating the output file. '
                   1704:                      .'This error has been logged. '
                   1705:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1706:     }
1.256     matthew  1707:     return ($fh,$filename)
1.113     bowersj2 1708: }
                   1709: 
                   1710: 
1.256     matthew  1711: =pod 
1.113     bowersj2 1712: 
                   1713: =back
                   1714: 
                   1715: =cut
1.37      matthew  1716: 
                   1717: ###############################################################
1.33      matthew  1718: ##        Home server <option> list generating code          ##
                   1719: ###############################################################
1.35      matthew  1720: 
1.169     www      1721: # ------------------------------------------
                   1722: 
                   1723: sub domain_select {
                   1724:     my ($name,$value,$multiple)=@_;
                   1725:     my %domains=map { 
1.514     albertel 1726: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1727:     } &Apache::lonnet::all_domains();
1.169     www      1728:     if ($multiple) {
                   1729: 	$domains{''}=&mt('Any domain');
1.550     albertel 1730: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1731: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1732:     } else {
1.550     albertel 1733: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1734: 	return &select_form($name,$value,%domains);
                   1735:     }
                   1736: }
                   1737: 
1.282     albertel 1738: #-------------------------------------------
                   1739: 
                   1740: =pod
                   1741: 
1.519     raeburn  1742: =head1 Routines for form select boxes
                   1743: 
                   1744: =over 4
                   1745: 
1.648     raeburn  1746: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1747: 
                   1748: Returns a string containing a <select> element int multiple mode
                   1749: 
                   1750: 
                   1751: Args:
                   1752:   $name - name of the <select> element
1.506     raeburn  1753:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1754:   $size - number of rows long the select element is
1.283     albertel 1755:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1756:           (shown text should already have been &mt())
1.506     raeburn  1757:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1758: 
1.282     albertel 1759: =cut
                   1760: 
                   1761: #-------------------------------------------
1.169     www      1762: sub multiple_select_form {
1.284     albertel 1763:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1764:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1765:     my $output='';
1.191     matthew  1766:     if (! defined($size)) {
                   1767:         $size = 4;
1.283     albertel 1768:         if (scalar(keys(%$hash))<4) {
                   1769:             $size = scalar(keys(%$hash));
1.191     matthew  1770:         }
                   1771:     }
1.734     bisitz   1772:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1773:     my @order;
1.506     raeburn  1774:     if (ref($order) eq 'ARRAY')  {
                   1775:         @order = @{$order};
                   1776:     } else {
                   1777:         @order = sort(keys(%$hash));
1.501     banghart 1778:     }
                   1779:     if (exists($$hash{'select_form_order'})) {
                   1780:         @order = @{$$hash{'select_form_order'}};
                   1781:     }
                   1782:         
1.284     albertel 1783:     foreach my $key (@order) {
1.356     albertel 1784:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1785:         $output.='selected="selected" ' if ($selected{$key});
                   1786:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1787:     }
                   1788:     $output.="</select>\n";
                   1789:     return $output;
                   1790: }
                   1791: 
1.88      www      1792: #-------------------------------------------
                   1793: 
                   1794: =pod
                   1795: 
1.648     raeburn  1796: =item * &select_form($defdom,$name,%hash)
1.88      www      1797: 
                   1798: Returns a string containing a <select name='$name' size='1'> form to 
                   1799: allow a user to select options from a hash option_name => displayed text.  
                   1800: See lonrights.pm for an example invocation and use.
                   1801: 
                   1802: =cut
                   1803: 
                   1804: #-------------------------------------------
                   1805: sub select_form {
                   1806:     my ($def,$name,%hash) = @_;
                   1807:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1808:     my @keys;
                   1809:     if (exists($hash{'select_form_order'})) {
                   1810: 	@keys=@{$hash{'select_form_order'}};
                   1811:     } else {
                   1812: 	@keys=sort(keys(%hash));
                   1813:     }
1.356     albertel 1814:     foreach my $key (@keys) {
                   1815:         $selectform.=
                   1816: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1817:             ($key eq $def ? 'selected="selected" ' : '').
                   1818:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1819:     }
                   1820:     $selectform.="</select>";
                   1821:     return $selectform;
                   1822: }
                   1823: 
1.475     www      1824: # For display filters
                   1825: 
                   1826: sub display_filter {
                   1827:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1828:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1829:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1830: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1831: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1832: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1833:            &mt('Filter [_1]',
1.477     www      1834: 	   &select_form($env{'form.displayfilter'},
                   1835: 			'displayfilter',
                   1836: 			('currentfolder' => 'Current folder/page',
                   1837: 			 'containing' => 'Containing phrase',
                   1838: 			 'none' => 'None'))).
1.714     bisitz   1839: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1840: }
                   1841: 
1.167     www      1842: sub gradeleveldescription {
                   1843:     my $gradelevel=shift;
                   1844:     my %gradelevels=(0 => 'Not specified',
                   1845: 		     1 => 'Grade 1',
                   1846: 		     2 => 'Grade 2',
                   1847: 		     3 => 'Grade 3',
                   1848: 		     4 => 'Grade 4',
                   1849: 		     5 => 'Grade 5',
                   1850: 		     6 => 'Grade 6',
                   1851: 		     7 => 'Grade 7',
                   1852: 		     8 => 'Grade 8',
                   1853: 		     9 => 'Grade 9',
                   1854: 		     10 => 'Grade 10',
                   1855: 		     11 => 'Grade 11',
                   1856: 		     12 => 'Grade 12',
                   1857: 		     13 => 'Grade 13',
                   1858: 		     14 => '100 Level',
                   1859: 		     15 => '200 Level',
                   1860: 		     16 => '300 Level',
                   1861: 		     17 => '400 Level',
                   1862: 		     18 => 'Graduate Level');
                   1863:     return &mt($gradelevels{$gradelevel});
                   1864: }
                   1865: 
1.163     www      1866: sub select_level_form {
                   1867:     my ($deflevel,$name)=@_;
                   1868:     unless ($deflevel) { $deflevel=0; }
1.167     www      1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1870:     for (my $i=0; $i<=18; $i++) {
                   1871:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1872:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1873:                 ">".&gradeleveldescription($i)."</option>\n";
                   1874:     }
                   1875:     $selectform.="</select>";
                   1876:     return $selectform;
1.163     www      1877: }
1.167     www      1878: 
1.35      matthew  1879: #-------------------------------------------
                   1880: 
1.45      matthew  1881: =pod
                   1882: 
1.873     raeburn  1883: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange)
1.35      matthew  1884: 
                   1885: Returns a string containing a <select name='$name' size='1'> form to 
                   1886: allow a user to select the domain to preform an operation in.  
                   1887: See loncreateuser.pm for an example invocation and use.
                   1888: 
1.90      www      1889: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1890: selected");
                   1891: 
1.743     raeburn  1892: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1893: 
1.872     raeburn  1894: The optional $onchange argumnet specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.  
1.563     raeburn  1895: 
1.35      matthew  1896: =cut
                   1897: 
                   1898: #-------------------------------------------
1.34      matthew  1899: sub select_dom_form {
1.872     raeburn  1900:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange) = @_;
                   1901:     if ($onchange) {
1.874     raeburn  1902:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1903:     }
1.550     albertel 1904:     my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90      www      1905:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1906:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1907:     foreach my $dom (@domains) {
                   1908:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1909:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1910:         if ($showdomdesc) {
                   1911:             if ($dom ne '') {
                   1912:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1913:                 if ($domdesc ne '') {
                   1914:                     $selectdomain .= ' ('.$domdesc.')';
                   1915:                 }
                   1916:             } 
                   1917:         }
                   1918:         $selectdomain .= "</option>\n";
1.34      matthew  1919:     }
                   1920:     $selectdomain.="</select>";
                   1921:     return $selectdomain;
                   1922: }
                   1923: 
1.35      matthew  1924: #-------------------------------------------
                   1925: 
1.45      matthew  1926: =pod
                   1927: 
1.648     raeburn  1928: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1929: 
1.586     raeburn  1930: input: 4 arguments (two required, two optional) - 
                   1931:     $domain - domain of new user
                   1932:     $name - name of form element
                   1933:     $default - Value of 'default' causes a default item to be first 
                   1934:                             option, and selected by default. 
                   1935:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   1936:                             if 1 server found, or default, if 0 found.
1.594     raeburn  1937: output: returns 2 items: 
1.586     raeburn  1938: (a) form element which contains either:
                   1939:    (i) <select name="$name">
                   1940:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   1941:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   1942:        </select>
                   1943:        form item if there are multiple library servers in $domain, or
                   1944:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   1945:        if there is only one library server in $domain.
                   1946: 
                   1947: (b) number of library servers found.
                   1948: 
                   1949: See loncreateuser.pm for example of use.
1.35      matthew  1950: 
                   1951: =cut
                   1952: 
                   1953: #-------------------------------------------
1.586     raeburn  1954: sub home_server_form_item {
                   1955:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 1956:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  1957:     my $result;
                   1958:     my $numlib = keys(%servers);
                   1959:     if ($numlib > 1) {
                   1960:         $result .= '<select name="'.$name.'" />'."\n";
                   1961:         if ($default) {
1.804     bisitz   1962:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  1963:                        '</option>'."\n";
                   1964:         }
                   1965:         foreach my $hostid (sort(keys(%servers))) {
                   1966:             $result.= '<option value="'.$hostid.'">'.
                   1967: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   1968:         }
                   1969:         $result .= '</select>'."\n";
                   1970:     } elsif ($numlib == 1) {
                   1971:         my $hostid;
                   1972:         foreach my $item (keys(%servers)) {
                   1973:             $hostid = $item;
                   1974:         }
                   1975:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   1976:                    $hostid.'" />';
                   1977:                    if (!$hide) {
                   1978:                        $result .= $hostid.' '.$servers{$hostid};
                   1979:                    }
                   1980:                    $result .= "\n";
                   1981:     } elsif ($default) {
                   1982:         $result .= '<input type="hidden" name="'.$name.
                   1983:                    '" value="default" />';
                   1984:                    if (!$hide) {
                   1985:                        $result .= &mt('default');
                   1986:                    }
                   1987:                    $result .= "\n";
1.33      matthew  1988:     }
1.586     raeburn  1989:     return ($result,$numlib);
1.33      matthew  1990: }
1.112     bowersj2 1991: 
                   1992: =pod
                   1993: 
1.534     albertel 1994: =back 
                   1995: 
1.112     bowersj2 1996: =cut
1.87      matthew  1997: 
                   1998: ###############################################################
1.112     bowersj2 1999: ##                  Decoding User Agent                      ##
1.87      matthew  2000: ###############################################################
                   2001: 
                   2002: =pod
                   2003: 
1.112     bowersj2 2004: =head1 Decoding the User Agent
                   2005: 
                   2006: =over 4
                   2007: 
                   2008: =item * &decode_user_agent()
1.87      matthew  2009: 
                   2010: Inputs: $r
                   2011: 
                   2012: Outputs:
                   2013: 
                   2014: =over 4
                   2015: 
1.112     bowersj2 2016: =item * $httpbrowser
1.87      matthew  2017: 
1.112     bowersj2 2018: =item * $clientbrowser
1.87      matthew  2019: 
1.112     bowersj2 2020: =item * $clientversion
1.87      matthew  2021: 
1.112     bowersj2 2022: =item * $clientmathml
1.87      matthew  2023: 
1.112     bowersj2 2024: =item * $clientunicode
1.87      matthew  2025: 
1.112     bowersj2 2026: =item * $clientos
1.87      matthew  2027: 
                   2028: =back
                   2029: 
1.157     matthew  2030: =back 
                   2031: 
1.87      matthew  2032: =cut
                   2033: 
                   2034: ###############################################################
                   2035: ###############################################################
                   2036: sub decode_user_agent {
1.247     albertel 2037:     my ($r)=@_;
1.87      matthew  2038:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2039:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2040:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2041:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2042:     my $clientbrowser='unknown';
                   2043:     my $clientversion='0';
                   2044:     my $clientmathml='';
                   2045:     my $clientunicode='0';
                   2046:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2047:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2048: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2049: 	    $clientbrowser=$bname;
                   2050:             $httpbrowser=~/$vreg/i;
                   2051: 	    $clientversion=$1;
                   2052:             $clientmathml=($clientversion>=$minv);
                   2053:             $clientunicode=($clientversion>=$univ);
                   2054: 	}
                   2055:     }
                   2056:     my $clientos='unknown';
                   2057:     if (($httpbrowser=~/linux/i) ||
                   2058:         ($httpbrowser=~/unix/i) ||
                   2059:         ($httpbrowser=~/ux/i) ||
                   2060:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2061:     if (($httpbrowser=~/vax/i) ||
                   2062:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2063:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2064:     if (($httpbrowser=~/mac/i) ||
                   2065:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2066:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2067:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2068:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2069:             $clientunicode,$clientos,);
                   2070: }
                   2071: 
1.32      matthew  2072: ###############################################################
                   2073: ##    Authentication changing form generation subroutines    ##
                   2074: ###############################################################
                   2075: ##
                   2076: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2077: ## hash, and have reasonable default values.
                   2078: ##
                   2079: ##    formname = the name given in the <form> tag.
1.35      matthew  2080: #-------------------------------------------
                   2081: 
1.45      matthew  2082: =pod
                   2083: 
1.112     bowersj2 2084: =head1 Authentication Routines
                   2085: 
                   2086: =over 4
                   2087: 
1.648     raeburn  2088: =item * &authform_xxxxxx()
1.35      matthew  2089: 
                   2090: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2091: handle some of the conveniences required for authentication forms.  
                   2092: This is not an optimal method, but it works.  
                   2093: 
                   2094: =over 4
                   2095: 
1.112     bowersj2 2096: =item * authform_header
1.35      matthew  2097: 
1.112     bowersj2 2098: =item * authform_authorwarning
1.35      matthew  2099: 
1.112     bowersj2 2100: =item * authform_nochange
1.35      matthew  2101: 
1.112     bowersj2 2102: =item * authform_kerberos
1.35      matthew  2103: 
1.112     bowersj2 2104: =item * authform_internal
1.35      matthew  2105: 
1.112     bowersj2 2106: =item * authform_filesystem
1.35      matthew  2107: 
                   2108: =back
                   2109: 
1.648     raeburn  2110: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2111: 
1.35      matthew  2112: =cut
                   2113: 
                   2114: #-------------------------------------------
1.32      matthew  2115: sub authform_header{  
                   2116:     my %in = (
                   2117:         formname => 'cu',
1.80      albertel 2118:         kerb_def_dom => '',
1.32      matthew  2119:         @_,
                   2120:     );
                   2121:     $in{'formname'} = 'document.' . $in{'formname'};
                   2122:     my $result='';
1.80      albertel 2123: 
                   2124: #---------------------------------------------- Code for upper case translation
                   2125:     my $Javascript_toUpperCase;
                   2126:     unless ($in{kerb_def_dom}) {
                   2127:         $Javascript_toUpperCase =<<"END";
                   2128:         switch (choice) {
                   2129:            case 'krb': currentform.elements[choicearg].value =
                   2130:                currentform.elements[choicearg].value.toUpperCase();
                   2131:                break;
                   2132:            default:
                   2133:         }
                   2134: END
                   2135:     } else {
                   2136:         $Javascript_toUpperCase = "";
                   2137:     }
                   2138: 
1.165     raeburn  2139:     my $radioval = "'nochange'";
1.591     raeburn  2140:     if (defined($in{'curr_authtype'})) {
                   2141:         if ($in{'curr_authtype'} ne '') {
                   2142:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2143:         }
1.174     matthew  2144:     }
1.165     raeburn  2145:     my $argfield = 'null';
1.591     raeburn  2146:     if (defined($in{'mode'})) {
1.165     raeburn  2147:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2148:             if (defined($in{'curr_autharg'})) {
                   2149:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2150:                     $argfield = "'$in{'curr_autharg'}'";
                   2151:                 }
                   2152:             }
                   2153:         }
                   2154:     }
                   2155: 
1.32      matthew  2156:     $result.=<<"END";
                   2157: var current = new Object();
1.165     raeburn  2158: current.radiovalue = $radioval;
                   2159: current.argfield = $argfield;
1.32      matthew  2160: 
                   2161: function changed_radio(choice,currentform) {
                   2162:     var choicearg = choice + 'arg';
                   2163:     // If a radio button in changed, we need to change the argfield
                   2164:     if (current.radiovalue != choice) {
                   2165:         current.radiovalue = choice;
                   2166:         if (current.argfield != null) {
                   2167:             currentform.elements[current.argfield].value = '';
                   2168:         }
                   2169:         if (choice == 'nochange') {
                   2170:             current.argfield = null;
                   2171:         } else {
                   2172:             current.argfield = choicearg;
                   2173:             switch(choice) {
                   2174:                 case 'krb': 
                   2175:                     currentform.elements[current.argfield].value = 
                   2176:                         "$in{'kerb_def_dom'}";
                   2177:                 break;
                   2178:               default:
                   2179:                 break;
                   2180:             }
                   2181:         }
                   2182:     }
                   2183:     return;
                   2184: }
1.22      www      2185: 
1.32      matthew  2186: function changed_text(choice,currentform) {
                   2187:     var choicearg = choice + 'arg';
                   2188:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2189:         $Javascript_toUpperCase
1.32      matthew  2190:         // clear old field
                   2191:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2192:             currentform.elements[current.argfield].value = '';
                   2193:         }
                   2194:         current.argfield = choicearg;
                   2195:     }
                   2196:     set_auth_radio_buttons(choice,currentform);
                   2197:     return;
1.20      www      2198: }
1.32      matthew  2199: 
                   2200: function set_auth_radio_buttons(newvalue,currentform) {
                   2201:     var i=0;
                   2202:     while (i < currentform.login.length) {
                   2203:         if (currentform.login[i].value == newvalue) { break; }
                   2204:         i++;
                   2205:     }
                   2206:     if (i == currentform.login.length) {
                   2207:         return;
                   2208:     }
                   2209:     current.radiovalue = newvalue;
                   2210:     currentform.login[i].checked = true;
                   2211:     return;
                   2212: }
                   2213: END
                   2214:     return $result;
                   2215: }
                   2216: 
                   2217: sub authform_authorwarning{
                   2218:     my $result='';
1.144     matthew  2219:     $result='<i>'.
                   2220:         &mt('As a general rule, only authors or co-authors should be '.
                   2221:             'filesystem authenticated '.
                   2222:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2223:     return $result;
                   2224: }
                   2225: 
                   2226: sub authform_nochange{  
                   2227:     my %in = (
                   2228:               formname => 'document.cu',
                   2229:               kerb_def_dom => 'MSU.EDU',
                   2230:               @_,
                   2231:           );
1.586     raeburn  2232:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2233:     my $result;
                   2234:     if (keys(%can_assign) == 0) {
                   2235:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2236:     } else {
                   2237:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2238:                   '<input type="radio" name="login" value="nochange" '.
                   2239:                   'checked="checked" onclick="'.
1.281     albertel 2240:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2241: 	    '</label>';
1.586     raeburn  2242:     }
1.32      matthew  2243:     return $result;
                   2244: }
                   2245: 
1.591     raeburn  2246: sub authform_kerberos {
1.32      matthew  2247:     my %in = (
                   2248:               formname => 'document.cu',
                   2249:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2250:               kerb_def_auth => 'krb4',
1.32      matthew  2251:               @_,
                   2252:               );
1.586     raeburn  2253:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2254:         $autharg,$jscall);
                   2255:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2256:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2257:        $check5 = ' checked="checked"';
1.80      albertel 2258:     } else {
1.772     bisitz   2259:        $check4 = ' checked="checked"';
1.80      albertel 2260:     }
1.165     raeburn  2261:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2262:     if (defined($in{'curr_authtype'})) {
                   2263:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2264:             $krbcheck = ' checked="checked"';
1.623     raeburn  2265:             if (defined($in{'mode'})) {
                   2266:                 if ($in{'mode'} eq 'modifyuser') {
                   2267:                     $krbcheck = '';
                   2268:                 }
                   2269:             }
1.591     raeburn  2270:             if (defined($in{'curr_kerb_ver'})) {
                   2271:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2272:                     $check5 = ' checked="checked"';
1.591     raeburn  2273:                     $check4 = '';
                   2274:                 } else {
1.772     bisitz   2275:                     $check4 = ' checked="checked"';
1.591     raeburn  2276:                     $check5 = '';
                   2277:                 }
1.586     raeburn  2278:             }
1.591     raeburn  2279:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2280:                 $krbarg = $in{'curr_autharg'};
                   2281:             }
1.586     raeburn  2282:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2283:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2284:                     $result = 
                   2285:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2286:         $in{'curr_autharg'},$krbver);
                   2287:                 } else {
                   2288:                     $result =
                   2289:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2290:                 }
                   2291:                 return $result; 
                   2292:             }
                   2293:         }
                   2294:     } else {
                   2295:         if ($authnum == 1) {
1.784     bisitz   2296:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2297:         }
                   2298:     }
1.586     raeburn  2299:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2300:         return;
1.587     raeburn  2301:     } elsif ($authtype eq '') {
1.591     raeburn  2302:         if (defined($in{'mode'})) {
1.587     raeburn  2303:             if ($in{'mode'} eq 'modifycourse') {
                   2304:                 if ($authnum == 1) {
1.784     bisitz   2305:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2306:                 }
                   2307:             }
                   2308:         }
1.586     raeburn  2309:     }
                   2310:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2311:     if ($authtype eq '') {
                   2312:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2313:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2314:                     $krbcheck.' />';
                   2315:     }
                   2316:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2317:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2318:          $in{'curr_authtype'} eq 'krb5') ||
                   2319:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2320:          $in{'curr_authtype'} eq 'krb4')) {
                   2321:         $result .= &mt
1.144     matthew  2322:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2323:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2324:          '<label>'.$authtype,
1.281     albertel 2325:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2326:              'value="'.$krbarg.'" '.
1.144     matthew  2327:              'onchange="'.$jscall.'" />',
1.281     albertel 2328:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2329:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2330: 	 '</label>');
1.586     raeburn  2331:     } elsif ($can_assign{'krb4'}) {
                   2332:         $result .= &mt
                   2333:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2334:          '[_3] Version 4 [_4]',
                   2335:          '<label>'.$authtype,
                   2336:          '</label><input type="text" size="10" name="krbarg" '.
                   2337:              'value="'.$krbarg.'" '.
                   2338:              'onchange="'.$jscall.'" />',
                   2339:          '<label><input type="hidden" name="krbver" value="4" />',
                   2340:          '</label>');
                   2341:     } elsif ($can_assign{'krb5'}) {
                   2342:         $result .= &mt
                   2343:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2344:          '[_3] Version 5 [_4]',
                   2345:          '<label>'.$authtype,
                   2346:          '</label><input type="text" size="10" name="krbarg" '.
                   2347:              'value="'.$krbarg.'" '.
                   2348:              'onchange="'.$jscall.'" />',
                   2349:          '<label><input type="hidden" name="krbver" value="5" />',
                   2350:          '</label>');
                   2351:     }
1.32      matthew  2352:     return $result;
                   2353: }
                   2354: 
                   2355: sub authform_internal{  
1.586     raeburn  2356:     my %in = (
1.32      matthew  2357:                 formname => 'document.cu',
                   2358:                 kerb_def_dom => 'MSU.EDU',
                   2359:                 @_,
                   2360:                 );
1.586     raeburn  2361:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2362:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2363:     if (defined($in{'curr_authtype'})) {
                   2364:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2365:             if ($can_assign{'int'}) {
1.772     bisitz   2366:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2367:                 if (defined($in{'mode'})) {
                   2368:                     if ($in{'mode'} eq 'modifyuser') {
                   2369:                         $intcheck = '';
                   2370:                     }
                   2371:                 }
1.591     raeburn  2372:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2373:                     $intarg = $in{'curr_autharg'};
                   2374:                 }
                   2375:             } else {
                   2376:                 $result = &mt('Currently internally authenticated.');
                   2377:                 return $result;
1.165     raeburn  2378:             }
                   2379:         }
1.586     raeburn  2380:     } else {
                   2381:         if ($authnum == 1) {
1.784     bisitz   2382:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2383:         }
                   2384:     }
                   2385:     if (!$can_assign{'int'}) {
                   2386:         return;
1.587     raeburn  2387:     } elsif ($authtype eq '') {
1.591     raeburn  2388:         if (defined($in{'mode'})) {
1.587     raeburn  2389:             if ($in{'mode'} eq 'modifycourse') {
                   2390:                 if ($authnum == 1) {
1.784     bisitz   2391:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2392:                 }
                   2393:             }
                   2394:         }
1.165     raeburn  2395:     }
1.586     raeburn  2396:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2397:     if ($authtype eq '') {
                   2398:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2399:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2400:     }
1.605     bisitz   2401:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2402:                $intarg.'" onchange="'.$jscall.'" />';
                   2403:     $result = &mt
1.144     matthew  2404:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2405:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2406:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2407:     return $result;
                   2408: }
                   2409: 
                   2410: sub authform_local{  
                   2411:     my %in = (
                   2412:               formname => 'document.cu',
                   2413:               kerb_def_dom => 'MSU.EDU',
                   2414:               @_,
                   2415:               );
1.586     raeburn  2416:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2417:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2418:     if (defined($in{'curr_authtype'})) {
                   2419:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2420:             if ($can_assign{'loc'}) {
1.772     bisitz   2421:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2422:                 if (defined($in{'mode'})) {
                   2423:                     if ($in{'mode'} eq 'modifyuser') {
                   2424:                         $loccheck = '';
                   2425:                     }
                   2426:                 }
1.591     raeburn  2427:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2428:                     $locarg = $in{'curr_autharg'};
                   2429:                 }
                   2430:             } else {
                   2431:                 $result = &mt('Currently using local (institutional) authentication.');
                   2432:                 return $result;
1.165     raeburn  2433:             }
                   2434:         }
1.586     raeburn  2435:     } else {
                   2436:         if ($authnum == 1) {
1.784     bisitz   2437:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2438:         }
                   2439:     }
                   2440:     if (!$can_assign{'loc'}) {
                   2441:         return;
1.587     raeburn  2442:     } elsif ($authtype eq '') {
1.591     raeburn  2443:         if (defined($in{'mode'})) {
1.587     raeburn  2444:             if ($in{'mode'} eq 'modifycourse') {
                   2445:                 if ($authnum == 1) {
1.784     bisitz   2446:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2447:                 }
                   2448:             }
                   2449:         }
1.165     raeburn  2450:     }
1.586     raeburn  2451:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2452:     if ($authtype eq '') {
                   2453:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2454:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2455:                     $jscall.'" />';
                   2456:     }
                   2457:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2458:                $locarg.'" onchange="'.$jscall.'" />';
                   2459:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2460:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2461:     return $result;
                   2462: }
                   2463: 
                   2464: sub authform_filesystem{  
                   2465:     my %in = (
                   2466:               formname => 'document.cu',
                   2467:               kerb_def_dom => 'MSU.EDU',
                   2468:               @_,
                   2469:               );
1.586     raeburn  2470:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2471:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2472:     if (defined($in{'curr_authtype'})) {
                   2473:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2474:             if ($can_assign{'fsys'}) {
1.772     bisitz   2475:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2476:                 if (defined($in{'mode'})) {
                   2477:                     if ($in{'mode'} eq 'modifyuser') {
                   2478:                         $fsyscheck = '';
                   2479:                     }
                   2480:                 }
1.586     raeburn  2481:             } else {
                   2482:                 $result = &mt('Currently Filesystem Authenticated.');
                   2483:                 return $result;
                   2484:             }           
                   2485:         }
                   2486:     } else {
                   2487:         if ($authnum == 1) {
1.784     bisitz   2488:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2489:         }
                   2490:     }
                   2491:     if (!$can_assign{'fsys'}) {
                   2492:         return;
1.587     raeburn  2493:     } elsif ($authtype eq '') {
1.591     raeburn  2494:         if (defined($in{'mode'})) {
1.587     raeburn  2495:             if ($in{'mode'} eq 'modifycourse') {
                   2496:                 if ($authnum == 1) {
1.784     bisitz   2497:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2498:                 }
                   2499:             }
                   2500:         }
1.586     raeburn  2501:     }
                   2502:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2503:     if ($authtype eq '') {
                   2504:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2505:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2506:                     $jscall.'" />';
                   2507:     }
                   2508:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2509:                ' onchange="'.$jscall.'" />';
                   2510:     $result = &mt
1.144     matthew  2511:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2512:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2513:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2514:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2515:                   'onchange="'.$jscall.'" />');
1.32      matthew  2516:     return $result;
                   2517: }
                   2518: 
1.586     raeburn  2519: sub get_assignable_auth {
                   2520:     my ($dom) = @_;
                   2521:     if ($dom eq '') {
                   2522:         $dom = $env{'request.role.domain'};
                   2523:     }
                   2524:     my %can_assign = (
                   2525:                           krb4 => 1,
                   2526:                           krb5 => 1,
                   2527:                           int  => 1,
                   2528:                           loc  => 1,
                   2529:                      );
                   2530:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2531:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2532:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2533:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2534:             my $context;
                   2535:             if ($env{'request.role'} =~ /^au/) {
                   2536:                 $context = 'author';
                   2537:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2538:                 $context = 'domain';
                   2539:             } elsif ($env{'request.course.id'}) {
                   2540:                 $context = 'course';
                   2541:             }
                   2542:             if ($context) {
                   2543:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2544:                    %can_assign = %{$authhash->{$context}}; 
                   2545:                 }
                   2546:             }
                   2547:         }
                   2548:     }
                   2549:     my $authnum = 0;
                   2550:     foreach my $key (keys(%can_assign)) {
                   2551:         if ($can_assign{$key}) {
                   2552:             $authnum ++;
                   2553:         }
                   2554:     }
                   2555:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2556:         $authnum --;
                   2557:     }
                   2558:     return ($authnum,%can_assign);
                   2559: }
                   2560: 
1.80      albertel 2561: ###############################################################
                   2562: ##    Get Kerberos Defaults for Domain                 ##
                   2563: ###############################################################
                   2564: ##
                   2565: ## Returns default kerberos version and an associated argument
                   2566: ## as listed in file domain.tab. If not listed, provides
                   2567: ## appropriate default domain and kerberos version.
                   2568: ##
                   2569: #-------------------------------------------
                   2570: 
                   2571: =pod
                   2572: 
1.648     raeburn  2573: =item * &get_kerberos_defaults()
1.80      albertel 2574: 
                   2575: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2576: version and domain. If not found, it defaults to version 4 and the 
                   2577: domain of the server.
1.80      albertel 2578: 
1.648     raeburn  2579: =over 4
                   2580: 
1.80      albertel 2581: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2582: 
1.648     raeburn  2583: =back
                   2584: 
                   2585: =back
                   2586: 
1.80      albertel 2587: =cut
                   2588: 
                   2589: #-------------------------------------------
                   2590: sub get_kerberos_defaults {
                   2591:     my $domain=shift;
1.641     raeburn  2592:     my ($krbdef,$krbdefdom);
                   2593:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2594:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2595:         $krbdef = $domdefaults{'auth_def'};
                   2596:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2597:     } else {
1.80      albertel 2598:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2599:         my $krbdefdom=$1;
                   2600:         $krbdefdom=~tr/a-z/A-Z/;
                   2601:         $krbdef = "krb4";
                   2602:     }
                   2603:     return ($krbdef,$krbdefdom);
                   2604: }
1.112     bowersj2 2605: 
1.32      matthew  2606: 
1.46      matthew  2607: ###############################################################
                   2608: ##                Thesaurus Functions                        ##
                   2609: ###############################################################
1.20      www      2610: 
1.46      matthew  2611: =pod
1.20      www      2612: 
1.112     bowersj2 2613: =head1 Thesaurus Functions
                   2614: 
                   2615: =over 4
                   2616: 
1.648     raeburn  2617: =item * &initialize_keywords()
1.46      matthew  2618: 
                   2619: Initializes the package variable %Keywords if it is empty.  Uses the
                   2620: package variable $thesaurus_db_file.
                   2621: 
                   2622: =cut
                   2623: 
                   2624: ###################################################
                   2625: 
                   2626: sub initialize_keywords {
                   2627:     return 1 if (scalar keys(%Keywords));
                   2628:     # If we are here, %Keywords is empty, so fill it up
                   2629:     #   Make sure the file we need exists...
                   2630:     if (! -e $thesaurus_db_file) {
                   2631:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2632:                                  " failed because it does not exist");
                   2633:         return 0;
                   2634:     }
                   2635:     #   Set up the hash as a database
                   2636:     my %thesaurus_db;
                   2637:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2638:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2639:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2640:                                  $thesaurus_db_file);
                   2641:         return 0;
                   2642:     } 
                   2643:     #  Get the average number of appearances of a word.
                   2644:     my $avecount = $thesaurus_db{'average.count'};
                   2645:     #  Put keywords (those that appear > average) into %Keywords
                   2646:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2647:         my ($count,undef) = split /:/,$data;
                   2648:         $Keywords{$word}++ if ($count > $avecount);
                   2649:     }
                   2650:     untie %thesaurus_db;
                   2651:     # Remove special values from %Keywords.
1.356     albertel 2652:     foreach my $value ('total.count','average.count') {
                   2653:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2654:   }
1.46      matthew  2655:     return 1;
                   2656: }
                   2657: 
                   2658: ###################################################
                   2659: 
                   2660: =pod
                   2661: 
1.648     raeburn  2662: =item * &keyword($word)
1.46      matthew  2663: 
                   2664: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2665: than the average number of times in the thesaurus database.  Calls 
                   2666: &initialize_keywords
                   2667: 
                   2668: =cut
                   2669: 
                   2670: ###################################################
1.20      www      2671: 
                   2672: sub keyword {
1.46      matthew  2673:     return if (!&initialize_keywords());
                   2674:     my $word=lc(shift());
                   2675:     $word=~s/\W//g;
                   2676:     return exists($Keywords{$word});
1.20      www      2677: }
1.46      matthew  2678: 
                   2679: ###############################################################
                   2680: 
                   2681: =pod 
1.20      www      2682: 
1.648     raeburn  2683: =item * &get_related_words()
1.46      matthew  2684: 
1.160     matthew  2685: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2686: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2687: will be returned.  The order of the words returned is determined by the
                   2688: database which holds them.
                   2689: 
                   2690: Uses global $thesaurus_db_file.
                   2691: 
                   2692: =cut
                   2693: 
                   2694: ###############################################################
                   2695: sub get_related_words {
                   2696:     my $keyword = shift;
                   2697:     my %thesaurus_db;
                   2698:     if (! -e $thesaurus_db_file) {
                   2699:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2700:                                  "failed because the file does not exist");
                   2701:         return ();
                   2702:     }
                   2703:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2704:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2705:         return ();
                   2706:     } 
                   2707:     my @Words=();
1.429     www      2708:     my $count=0;
1.46      matthew  2709:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2710: 	# The first element is the number of times
                   2711: 	# the word appears.  We do not need it now.
1.429     www      2712: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2713: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2714: 	my $threshold=$mostfrequentcount/10;
                   2715:         foreach my $possibleword (@RelatedWords) {
                   2716:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2717:             if ($wordcount>$threshold) {
                   2718: 		push(@Words,$word);
                   2719:                 $count++;
                   2720:                 if ($count>10) { last; }
                   2721: 	    }
1.20      www      2722:         }
                   2723:     }
1.46      matthew  2724:     untie %thesaurus_db;
                   2725:     return @Words;
1.14      harris41 2726: }
1.46      matthew  2727: 
1.112     bowersj2 2728: =pod
                   2729: 
                   2730: =back
                   2731: 
                   2732: =cut
1.61      www      2733: 
                   2734: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2735: =pod
                   2736: 
1.112     bowersj2 2737: =head1 User Name Functions
                   2738: 
                   2739: =over 4
                   2740: 
1.648     raeburn  2741: =item * &plainname($uname,$udom,$first)
1.81      albertel 2742: 
1.112     bowersj2 2743: Takes a users logon name and returns it as a string in
1.226     albertel 2744: "first middle last generation" form 
                   2745: if $first is set to 'lastname' then it returns it as
                   2746: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2747: 
                   2748: =cut
1.61      www      2749: 
1.295     www      2750: 
1.81      albertel 2751: ###############################################################
1.61      www      2752: sub plainname {
1.226     albertel 2753:     my ($uname,$udom,$first)=@_;
1.537     albertel 2754:     return if (!defined($uname) || !defined($udom));
1.295     www      2755:     my %names=&getnames($uname,$udom);
1.226     albertel 2756:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2757: 					  $names{'middlename'},
                   2758: 					  $names{'lastname'},
                   2759: 					  $names{'generation'},$first);
                   2760:     $name=~s/^\s+//;
1.62      www      2761:     $name=~s/\s+$//;
                   2762:     $name=~s/\s+/ /g;
1.353     albertel 2763:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2764:     return $name;
1.61      www      2765: }
1.66      www      2766: 
                   2767: # -------------------------------------------------------------------- Nickname
1.81      albertel 2768: =pod
                   2769: 
1.648     raeburn  2770: =item * &nickname($uname,$udom)
1.81      albertel 2771: 
                   2772: Gets a users name and returns it as a string as
                   2773: 
                   2774: "&quot;nickname&quot;"
1.66      www      2775: 
1.81      albertel 2776: if the user has a nickname or
                   2777: 
                   2778: "first middle last generation"
                   2779: 
                   2780: if the user does not
                   2781: 
                   2782: =cut
1.66      www      2783: 
                   2784: sub nickname {
                   2785:     my ($uname,$udom)=@_;
1.537     albertel 2786:     return if (!defined($uname) || !defined($udom));
1.295     www      2787:     my %names=&getnames($uname,$udom);
1.68      albertel 2788:     my $name=$names{'nickname'};
1.66      www      2789:     if ($name) {
                   2790:        $name='&quot;'.$name.'&quot;'; 
                   2791:     } else {
                   2792:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2793: 	     $names{'lastname'}.' '.$names{'generation'};
                   2794:        $name=~s/\s+$//;
                   2795:        $name=~s/\s+/ /g;
                   2796:     }
                   2797:     return $name;
                   2798: }
                   2799: 
1.295     www      2800: sub getnames {
                   2801:     my ($uname,$udom)=@_;
1.537     albertel 2802:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2803:     if ($udom eq 'public' && $uname eq 'public') {
                   2804: 	return ('lastname' => &mt('Public'));
                   2805:     }
1.295     www      2806:     my $id=$uname.':'.$udom;
                   2807:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2808:     if ($cached) {
                   2809: 	return %{$names};
                   2810:     } else {
                   2811: 	my %loadnames=&Apache::lonnet::get('environment',
                   2812:                     ['firstname','middlename','lastname','generation','nickname'],
                   2813: 					 $udom,$uname);
                   2814: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2815: 	return %loadnames;
                   2816:     }
                   2817: }
1.61      www      2818: 
1.542     raeburn  2819: # -------------------------------------------------------------------- getemails
1.648     raeburn  2820: 
1.542     raeburn  2821: =pod
                   2822: 
1.648     raeburn  2823: =item * &getemails($uname,$udom)
1.542     raeburn  2824: 
                   2825: Gets a user's email information and returns it as a hash with keys:
                   2826: notification, critnotification, permanentemail
                   2827: 
                   2828: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2829: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2830:  
1.648     raeburn  2831: 
1.542     raeburn  2832: =cut
                   2833: 
1.648     raeburn  2834: 
1.466     albertel 2835: sub getemails {
                   2836:     my ($uname,$udom)=@_;
                   2837:     if ($udom eq 'public' && $uname eq 'public') {
                   2838: 	return;
                   2839:     }
1.467     www      2840:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2841:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2842:     my $id=$uname.':'.$udom;
                   2843:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2844:     if ($cached) {
                   2845: 	return %{$names};
                   2846:     } else {
                   2847: 	my %loadnames=&Apache::lonnet::get('environment',
                   2848:                     			   ['notification','critnotification',
                   2849: 					    'permanentemail'],
                   2850: 					   $udom,$uname);
                   2851: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2852: 	return %loadnames;
                   2853:     }
                   2854: }
                   2855: 
1.551     albertel 2856: sub flush_email_cache {
                   2857:     my ($uname,$udom)=@_;
                   2858:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2859:     if (!$uname) { $uname=$env{'user.name'};   }
                   2860:     return if ($udom eq 'public' && $uname eq 'public');
                   2861:     my $id=$uname.':'.$udom;
                   2862:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2863: }
                   2864: 
1.728     raeburn  2865: # -------------------------------------------------------------------- getlangs
                   2866: 
                   2867: =pod
                   2868: 
                   2869: =item * &getlangs($uname,$udom)
                   2870: 
                   2871: Gets a user's language preference and returns it as a hash with key:
                   2872: language.
                   2873: 
                   2874: =cut
                   2875: 
                   2876: 
                   2877: sub getlangs {
                   2878:     my ($uname,$udom) = @_;
                   2879:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2880:     if (!$uname) { $uname=$env{'user.name'};   }
                   2881:     my $id=$uname.':'.$udom;
                   2882:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2883:     if ($cached) {
                   2884:         return %{$langs};
                   2885:     } else {
                   2886:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2887:                                            $udom,$uname);
                   2888:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2889:         return %loadlangs;
                   2890:     }
                   2891: }
                   2892: 
                   2893: sub flush_langs_cache {
                   2894:     my ($uname,$udom)=@_;
                   2895:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2896:     if (!$uname) { $uname=$env{'user.name'};   }
                   2897:     return if ($udom eq 'public' && $uname eq 'public');
                   2898:     my $id=$uname.':'.$udom;
                   2899:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2900: }
                   2901: 
1.61      www      2902: # ------------------------------------------------------------------ Screenname
1.81      albertel 2903: 
                   2904: =pod
                   2905: 
1.648     raeburn  2906: =item * &screenname($uname,$udom)
1.81      albertel 2907: 
                   2908: Gets a users screenname and returns it as a string
                   2909: 
                   2910: =cut
1.61      www      2911: 
                   2912: sub screenname {
                   2913:     my ($uname,$udom)=@_;
1.258     albertel 2914:     if ($uname eq $env{'user.name'} &&
                   2915: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2916:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2917:     return $names{'screenname'};
1.62      www      2918: }
                   2919: 
1.212     albertel 2920: 
1.802     bisitz   2921: # ------------------------------------------------------------- Confirm Wrapper
                   2922: =pod
                   2923: 
                   2924: =item confirmwrapper
                   2925: 
                   2926: Wrap messages about completion of operation in box
                   2927: 
                   2928: =cut
                   2929: 
                   2930: sub confirmwrapper {
                   2931:     my ($message)=@_;
                   2932:     if ($message) {
                   2933:         return "\n".'<div class="LC_confirm_box">'."\n"
                   2934:                .$message."\n"
                   2935:                .'</div>'."\n";
                   2936:     } else {
                   2937:         return $message;
                   2938:     }
                   2939: }
                   2940: 
1.62      www      2941: # ------------------------------------------------------------- Message Wrapper
                   2942: 
                   2943: sub messagewrapper {
1.369     www      2944:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      2945:     return 
1.441     albertel 2946:         '<a href="/adm/email?compose=individual&amp;'.
                   2947:         'recname='.$username.'&amp;recdom='.$domain.
                   2948: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  2949:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      2950: }
1.802     bisitz   2951: 
1.74      www      2952: # --------------------------------------------------------------- Notes Wrapper
                   2953: 
                   2954: sub noteswrapper {
                   2955:     my ($link,$un,$do)=@_;
                   2956:     return 
                   2957: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62      www      2958: }
1.802     bisitz   2959: 
1.62      www      2960: # ------------------------------------------------------------- Aboutme Wrapper
                   2961: 
                   2962: sub aboutmewrapper {
1.166     www      2963:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  2964:     if (!defined($username)  && !defined($domain)) {
                   2965:         return;
                   2966:     }
1.205     www      2967:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756     weissno  2968: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      2969: }
                   2970: 
                   2971: # ------------------------------------------------------------ Syllabus Wrapper
                   2972: 
                   2973: sub syllabuswrapper {
1.707     bisitz   2974:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  2975:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      2976: }
1.14      harris41 2977: 
1.802     bisitz   2978: # -----------------------------------------------------------------------------
                   2979: 
1.208     matthew  2980: sub track_student_link {
1.887     raeburn  2981:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 2982:     my $link ="/adm/trackstudent?";
1.208     matthew  2983:     my $title = 'View recent activity';
                   2984:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   2985:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 2986:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  2987:         $title .= ' of this student';
1.268     albertel 2988:     } 
1.208     matthew  2989:     if (defined($target) && $target !~ /^\s*$/) {
                   2990:         $target = qq{target="$target"};
                   2991:     } else {
                   2992:         $target = '';
                   2993:     }
1.268     albertel 2994:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  2995:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 2996:     $title = &mt($title);
                   2997:     $linktext = &mt($linktext);
1.448     albertel 2998:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   2999: 	&help_open_topic('View_recent_activity');
1.208     matthew  3000: }
                   3001: 
1.781     raeburn  3002: sub slot_reservations_link {
                   3003:     my ($linktext,$sname,$sdom,$target) = @_;
                   3004:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3005:     my $title = 'View slot reservation history';
                   3006:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3007:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3008:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3009:         $title .= ' of this student';
                   3010:     }
                   3011:     if (defined($target) && $target !~ /^\s*$/) {
                   3012:         $target = qq{target="$target"};
                   3013:     } else {
                   3014:         $target = '';
                   3015:     }
                   3016:     $title = &mt($title);
                   3017:     $linktext = &mt($linktext);
                   3018:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3019: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3020: 
                   3021: }
                   3022: 
1.508     www      3023: # ===================================================== Display a student photo
                   3024: 
                   3025: 
1.509     albertel 3026: sub student_image_tag {
1.508     www      3027:     my ($domain,$user)=@_;
                   3028:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3029:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3030: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3031:     } else {
                   3032: 	return '';
                   3033:     }
                   3034: }
                   3035: 
1.112     bowersj2 3036: =pod
                   3037: 
                   3038: =back
                   3039: 
                   3040: =head1 Access .tab File Data
                   3041: 
                   3042: =over 4
                   3043: 
1.648     raeburn  3044: =item * &languageids() 
1.112     bowersj2 3045: 
                   3046: returns list of all language ids
                   3047: 
                   3048: =cut
                   3049: 
1.14      harris41 3050: sub languageids {
1.16      harris41 3051:     return sort(keys(%language));
1.14      harris41 3052: }
                   3053: 
1.112     bowersj2 3054: =pod
                   3055: 
1.648     raeburn  3056: =item * &languagedescription() 
1.112     bowersj2 3057: 
                   3058: returns description of a specified language id
                   3059: 
                   3060: =cut
                   3061: 
1.14      harris41 3062: sub languagedescription {
1.125     www      3063:     my $code=shift;
                   3064:     return  ($supported_language{$code}?'* ':'').
                   3065:             $language{$code}.
1.126     www      3066: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3067: }
                   3068: 
                   3069: sub plainlanguagedescription {
                   3070:     my $code=shift;
                   3071:     return $language{$code};
                   3072: }
                   3073: 
                   3074: sub supportedlanguagecode {
                   3075:     my $code=shift;
                   3076:     return $supported_language{$code};
1.97      www      3077: }
                   3078: 
1.112     bowersj2 3079: =pod
                   3080: 
1.648     raeburn  3081: =item * &copyrightids() 
1.112     bowersj2 3082: 
                   3083: returns list of all copyrights
                   3084: 
                   3085: =cut
                   3086: 
                   3087: sub copyrightids {
                   3088:     return sort(keys(%cprtag));
                   3089: }
                   3090: 
                   3091: =pod
                   3092: 
1.648     raeburn  3093: =item * &copyrightdescription() 
1.112     bowersj2 3094: 
                   3095: returns description of a specified copyright id
                   3096: 
                   3097: =cut
                   3098: 
                   3099: sub copyrightdescription {
1.166     www      3100:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3101: }
1.197     matthew  3102: 
                   3103: =pod
                   3104: 
1.648     raeburn  3105: =item * &source_copyrightids() 
1.192     taceyjo1 3106: 
                   3107: returns list of all source copyrights
                   3108: 
                   3109: =cut
                   3110: 
                   3111: sub source_copyrightids {
                   3112:     return sort(keys(%scprtag));
                   3113: }
                   3114: 
                   3115: =pod
                   3116: 
1.648     raeburn  3117: =item * &source_copyrightdescription() 
1.192     taceyjo1 3118: 
                   3119: returns description of a specified source copyright id
                   3120: 
                   3121: =cut
                   3122: 
                   3123: sub source_copyrightdescription {
                   3124:     return &mt($scprtag{shift(@_)});
                   3125: }
1.112     bowersj2 3126: 
                   3127: =pod
                   3128: 
1.648     raeburn  3129: =item * &filecategories() 
1.112     bowersj2 3130: 
                   3131: returns list of all file categories
                   3132: 
                   3133: =cut
                   3134: 
                   3135: sub filecategories {
                   3136:     return sort(keys(%category_extensions));
                   3137: }
                   3138: 
                   3139: =pod
                   3140: 
1.648     raeburn  3141: =item * &filecategorytypes() 
1.112     bowersj2 3142: 
                   3143: returns list of file types belonging to a given file
                   3144: category
                   3145: 
                   3146: =cut
                   3147: 
                   3148: sub filecategorytypes {
1.356     albertel 3149:     my ($cat) = @_;
                   3150:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3151: }
                   3152: 
                   3153: =pod
                   3154: 
1.648     raeburn  3155: =item * &fileembstyle() 
1.112     bowersj2 3156: 
                   3157: returns embedding style for a specified file type
                   3158: 
                   3159: =cut
                   3160: 
                   3161: sub fileembstyle {
                   3162:     return $fe{lc(shift(@_))};
1.169     www      3163: }
                   3164: 
1.351     www      3165: sub filemimetype {
                   3166:     return $fm{lc(shift(@_))};
                   3167: }
                   3168: 
1.169     www      3169: 
                   3170: sub filecategoryselect {
                   3171:     my ($name,$value)=@_;
1.189     matthew  3172:     return &select_form($value,$name,
1.169     www      3173: 			'' => &mt('Any category'),
                   3174: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3175: }
                   3176: 
                   3177: =pod
                   3178: 
1.648     raeburn  3179: =item * &filedescription() 
1.112     bowersj2 3180: 
                   3181: returns description for a specified file type
                   3182: 
                   3183: =cut
                   3184: 
                   3185: sub filedescription {
1.188     matthew  3186:     my $file_description = $fd{lc(shift())};
                   3187:     $file_description =~ s:([\[\]]):~$1:g;
                   3188:     return &mt($file_description);
1.112     bowersj2 3189: }
                   3190: 
                   3191: =pod
                   3192: 
1.648     raeburn  3193: =item * &filedescriptionex() 
1.112     bowersj2 3194: 
                   3195: returns description for a specified file type with
                   3196: extra formatting
                   3197: 
                   3198: =cut
                   3199: 
                   3200: sub filedescriptionex {
                   3201:     my $ex=shift;
1.188     matthew  3202:     my $file_description = $fd{lc($ex)};
                   3203:     $file_description =~ s:([\[\]]):~$1:g;
                   3204:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3205: }
                   3206: 
                   3207: # End of .tab access
                   3208: =pod
                   3209: 
                   3210: =back
                   3211: 
                   3212: =cut
                   3213: 
                   3214: # ------------------------------------------------------------------ File Types
                   3215: sub fileextensions {
                   3216:     return sort(keys(%fe));
                   3217: }
                   3218: 
1.97      www      3219: # ----------------------------------------------------------- Display Languages
                   3220: # returns a hash with all desired display languages
                   3221: #
                   3222: 
                   3223: sub display_languages {
                   3224:     my %languages=();
1.695     raeburn  3225:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3226: 	$languages{$lang}=1;
1.97      www      3227:     }
                   3228:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3229:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3230: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3231: 	    $languages{$lang}=1;
1.97      www      3232:         }
                   3233:     }
                   3234:     return %languages;
1.14      harris41 3235: }
                   3236: 
1.582     albertel 3237: sub languages {
                   3238:     my ($possible_langs) = @_;
1.695     raeburn  3239:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3240:     if (!ref($possible_langs)) {
                   3241: 	if( wantarray ) {
                   3242: 	    return @preferred_langs;
                   3243: 	} else {
                   3244: 	    return $preferred_langs[0];
                   3245: 	}
                   3246:     }
                   3247:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3248:     my @preferred_possibilities;
                   3249:     foreach my $preferred_lang (@preferred_langs) {
                   3250: 	if (exists($possibilities{$preferred_lang})) {
                   3251: 	    push(@preferred_possibilities, $preferred_lang);
                   3252: 	}
                   3253:     }
                   3254:     if( wantarray ) {
                   3255: 	return @preferred_possibilities;
                   3256:     }
                   3257:     return $preferred_possibilities[0];
                   3258: }
                   3259: 
1.742     raeburn  3260: sub user_lang {
                   3261:     my ($touname,$toudom,$fromcid) = @_;
                   3262:     my @userlangs;
                   3263:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3264:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3265:                     $env{'course.'.$fromcid.'.languages'}));
                   3266:     } else {
                   3267:         my %langhash = &getlangs($touname,$toudom);
                   3268:         if ($langhash{'languages'} ne '') {
                   3269:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3270:         } else {
                   3271:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3272:             if ($domdefs{'lang_def'} ne '') {
                   3273:                 @userlangs = ($domdefs{'lang_def'});
                   3274:             }
                   3275:         }
                   3276:     }
                   3277:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3278:     my $user_lh = Apache::localize->get_handle(@languages);
                   3279:     return $user_lh;
                   3280: }
                   3281: 
                   3282: 
1.112     bowersj2 3283: ###############################################################
                   3284: ##               Student Answer Attempts                     ##
                   3285: ###############################################################
                   3286: 
                   3287: =pod
                   3288: 
                   3289: =head1 Alternate Problem Views
                   3290: 
                   3291: =over 4
                   3292: 
1.648     raeburn  3293: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3294:     $getattempt, $regexp, $gradesub)
                   3295: 
                   3296: Return string with previous attempt on problem. Arguments:
                   3297: 
                   3298: =over 4
                   3299: 
                   3300: =item * $symb: Problem, including path
                   3301: 
                   3302: =item * $username: username of the desired student
                   3303: 
                   3304: =item * $domain: domain of the desired student
1.14      harris41 3305: 
1.112     bowersj2 3306: =item * $course: Course ID
1.14      harris41 3307: 
1.112     bowersj2 3308: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3309:     something
1.14      harris41 3310: 
1.112     bowersj2 3311: =item * $regexp: if string matches this regexp, the string will be
                   3312:     sent to $gradesub
1.14      harris41 3313: 
1.112     bowersj2 3314: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3315: 
1.112     bowersj2 3316: =back
1.14      harris41 3317: 
1.112     bowersj2 3318: The output string is a table containing all desired attempts, if any.
1.16      harris41 3319: 
1.112     bowersj2 3320: =cut
1.1       albertel 3321: 
                   3322: sub get_previous_attempt {
1.43      ng       3323:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3324:   my $prevattempts='';
1.43      ng       3325:   no strict 'refs';
1.1       albertel 3326:   if ($symb) {
1.3       albertel 3327:     my (%returnhash)=
                   3328:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3329:     if ($returnhash{'version'}) {
                   3330:       my %lasthash=();
                   3331:       my $version;
                   3332:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3333:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3334: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3335:         }
1.1       albertel 3336:       }
1.596     albertel 3337:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3338:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3339:       foreach my $key (sort(keys(%lasthash))) {
                   3340: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3341: 	if ($#parts > 0) {
1.31      albertel 3342: 	  my $data=$parts[-1];
                   3343: 	  pop(@parts);
1.596     albertel 3344: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3345: 	} else {
1.41      ng       3346: 	  if ($#parts == 0) {
                   3347: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3348: 	  } else {
                   3349: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3350: 	  }
1.31      albertel 3351: 	}
1.16      harris41 3352:       }
1.596     albertel 3353:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3354:       if ($getattempt eq '') {
                   3355: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3356: 	  $prevattempts.=&start_data_table_row().
                   3357: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3358: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3359: 		my $value = &format_previous_attempt_value($key,
                   3360: 							   $returnhash{$version.':'.$key});
                   3361: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3362: 	    }
1.596     albertel 3363: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3364: 	 }
1.1       albertel 3365:       }
1.596     albertel 3366:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3367:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3368: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3369: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3370: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3371:       }
1.596     albertel 3372:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3373:     } else {
1.596     albertel 3374:       $prevattempts=
                   3375: 	  &start_data_table().&start_data_table_row().
                   3376: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3377: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3378:     }
                   3379:   } else {
1.596     albertel 3380:     $prevattempts=
                   3381: 	  &start_data_table().&start_data_table_row().
                   3382: 	  '<td>'.&mt('No data.').'</td>'.
                   3383: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3384:   }
1.10      albertel 3385: }
                   3386: 
1.581     albertel 3387: sub format_previous_attempt_value {
                   3388:     my ($key,$value) = @_;
                   3389:     if ($key =~ /timestamp/) {
                   3390: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3391:     } elsif (ref($value) eq 'ARRAY') {
                   3392: 	$value = '('.join(', ', @{ $value }).')';
                   3393:     } else {
                   3394: 	$value = &unescape($value);
                   3395:     }
                   3396:     return $value;
                   3397: }
                   3398: 
                   3399: 
1.107     albertel 3400: sub relative_to_absolute {
                   3401:     my ($url,$output)=@_;
                   3402:     my $parser=HTML::TokeParser->new(\$output);
                   3403:     my $token;
                   3404:     my $thisdir=$url;
                   3405:     my @rlinks=();
                   3406:     while ($token=$parser->get_token) {
                   3407: 	if ($token->[0] eq 'S') {
                   3408: 	    if ($token->[1] eq 'a') {
                   3409: 		if ($token->[2]->{'href'}) {
                   3410: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3411: 		}
                   3412: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3413: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3414: 	    } elsif ($token->[1] eq 'base') {
                   3415: 		$thisdir=$token->[2]->{'href'};
                   3416: 	    }
                   3417: 	}
                   3418:     }
                   3419:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3420:     foreach my $link (@rlinks) {
1.726     raeburn  3421: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3422: 		($link=~/^\//) ||
                   3423: 		($link=~/^javascript:/i) ||
                   3424: 		($link=~/^mailto:/i) ||
                   3425: 		($link=~/^\#/)) {
                   3426: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3427: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3428: 	}
                   3429:     }
                   3430: # -------------------------------------------------- Deal with Applet codebases
                   3431:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3432:     return $output;
                   3433: }
                   3434: 
1.112     bowersj2 3435: =pod
                   3436: 
1.648     raeburn  3437: =item * &get_student_view()
1.112     bowersj2 3438: 
                   3439: show a snapshot of what student was looking at
                   3440: 
                   3441: =cut
                   3442: 
1.10      albertel 3443: sub get_student_view {
1.186     albertel 3444:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3445:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3446:   my (%form);
1.10      albertel 3447:   my @elements=('symb','courseid','domain','username');
                   3448:   foreach my $element (@elements) {
1.186     albertel 3449:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3450:   }
1.186     albertel 3451:   if (defined($moreenv)) {
                   3452:       %form=(%form,%{$moreenv});
                   3453:   }
1.236     albertel 3454:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3455:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3456:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3457:   $userview=~s/\<body[^\>]*\>//gi;
                   3458:   $userview=~s/\<\/body\>//gi;
                   3459:   $userview=~s/\<html\>//gi;
                   3460:   $userview=~s/\<\/html\>//gi;
                   3461:   $userview=~s/\<head\>//gi;
                   3462:   $userview=~s/\<\/head\>//gi;
                   3463:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3464:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3465:   if (wantarray) {
                   3466:      return ($userview,$response);
                   3467:   } else {
                   3468:      return $userview;
                   3469:   }
                   3470: }
                   3471: 
                   3472: sub get_student_view_with_retries {
                   3473:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3474: 
                   3475:     my $ok = 0;                 # True if we got a good response.
                   3476:     my $content;
                   3477:     my $response;
                   3478: 
                   3479:     # Try to get the student_view done. within the retries count:
                   3480:     
                   3481:     do {
                   3482:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3483:          $ok      = $response->is_success;
                   3484:          if (!$ok) {
                   3485:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3486:          }
                   3487:          $retries--;
                   3488:     } while (!$ok && ($retries > 0));
                   3489:     
                   3490:     if (!$ok) {
                   3491:        $content = '';          # On error return an empty content.
                   3492:     }
1.651     www      3493:     if (wantarray) {
                   3494:        return ($content, $response);
                   3495:     } else {
                   3496:        return $content;
                   3497:     }
1.11      albertel 3498: }
                   3499: 
1.112     bowersj2 3500: =pod
                   3501: 
1.648     raeburn  3502: =item * &get_student_answers() 
1.112     bowersj2 3503: 
                   3504: show a snapshot of how student was answering problem
                   3505: 
                   3506: =cut
                   3507: 
1.11      albertel 3508: sub get_student_answers {
1.100     sakharuk 3509:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3510:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3511:   my (%moreenv);
1.11      albertel 3512:   my @elements=('symb','courseid','domain','username');
                   3513:   foreach my $element (@elements) {
1.186     albertel 3514:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3515:   }
1.186     albertel 3516:   $moreenv{'grade_target'}='answer';
                   3517:   %moreenv=(%form,%moreenv);
1.497     raeburn  3518:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3519:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3520:   return $userview;
1.1       albertel 3521: }
1.116     albertel 3522: 
                   3523: =pod
                   3524: 
                   3525: =item * &submlink()
                   3526: 
1.242     albertel 3527: Inputs: $text $uname $udom $symb $target
1.116     albertel 3528: 
                   3529: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3530: 
                   3531: =cut
                   3532: 
                   3533: ###############################################
                   3534: sub submlink {
1.242     albertel 3535:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3536:     if (!($uname && $udom)) {
                   3537: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3538: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3539: 	if (!$symb) { $symb=$cursymb; }
                   3540:     }
1.254     matthew  3541:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3542:     $symb=&escape($symb);
1.242     albertel 3543:     if ($target) { $target="target=\"$target\""; }
                   3544:     return '<a href="/adm/grades?&command=submission&'.
                   3545: 	'symb='.$symb.'&student='.$uname.
                   3546: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3547: }
                   3548: ##############################################
                   3549: 
                   3550: =pod
                   3551: 
                   3552: =item * &pgrdlink()
                   3553: 
                   3554: Inputs: $text $uname $udom $symb $target
                   3555: 
                   3556: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3557: 
                   3558: =cut
                   3559: 
                   3560: ###############################################
                   3561: sub pgrdlink {
                   3562:     my $link=&submlink(@_);
                   3563:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3564:     return $link;
                   3565: }
                   3566: ##############################################
                   3567: 
                   3568: =pod
                   3569: 
                   3570: =item * &pprmlink()
                   3571: 
                   3572: Inputs: $text $uname $udom $symb $target
                   3573: 
                   3574: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3575: student and a specific resource
1.242     albertel 3576: 
                   3577: =cut
                   3578: 
                   3579: ###############################################
                   3580: sub pprmlink {
                   3581:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3582:     if (!($uname && $udom)) {
                   3583: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3584: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3585: 	if (!$symb) { $symb=$cursymb; }
                   3586:     }
1.254     matthew  3587:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3588:     $symb=&escape($symb);
1.242     albertel 3589:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3590:     return '<a href="/adm/parmset?command=set&amp;'.
                   3591: 	'symb='.$symb.'&amp;uname='.$uname.
                   3592: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3593: }
                   3594: ##############################################
1.37      matthew  3595: 
1.112     bowersj2 3596: =pod
                   3597: 
                   3598: =back
                   3599: 
                   3600: =cut
                   3601: 
1.37      matthew  3602: ###############################################
1.51      www      3603: 
                   3604: 
                   3605: sub timehash {
1.687     raeburn  3606:     my ($thistime) = @_;
                   3607:     my $timezone = &Apache::lonlocal::gettimezone();
                   3608:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3609:                      ->set_time_zone($timezone);
                   3610:     my $wday = $dt->day_of_week();
                   3611:     if ($wday == 7) { $wday = 0; }
                   3612:     return ( 'second' => $dt->second(),
                   3613:              'minute' => $dt->minute(),
                   3614:              'hour'   => $dt->hour(),
                   3615:              'day'     => $dt->day_of_month(),
                   3616:              'month'   => $dt->month(),
                   3617:              'year'    => $dt->year(),
                   3618:              'weekday' => $wday,
                   3619:              'dayyear' => $dt->day_of_year(),
                   3620:              'dlsav'   => $dt->is_dst() );
1.51      www      3621: }
                   3622: 
1.370     www      3623: sub utc_string {
                   3624:     my ($date)=@_;
1.371     www      3625:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3626: }
                   3627: 
1.51      www      3628: sub maketime {
                   3629:     my %th=@_;
1.687     raeburn  3630:     my ($epoch_time,$timezone,$dt);
                   3631:     $timezone = &Apache::lonlocal::gettimezone();
                   3632:     eval {
                   3633:         $dt = DateTime->new( year   => $th{'year'},
                   3634:                              month  => $th{'month'},
                   3635:                              day    => $th{'day'},
                   3636:                              hour   => $th{'hour'},
                   3637:                              minute => $th{'minute'},
                   3638:                              second => $th{'second'},
                   3639:                              time_zone => $timezone,
                   3640:                          );
                   3641:     };
                   3642:     if (!$@) {
                   3643:         $epoch_time = $dt->epoch;
                   3644:         if ($epoch_time) {
                   3645:             return $epoch_time;
                   3646:         }
                   3647:     }
1.51      www      3648:     return POSIX::mktime(
                   3649:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3650:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3651: }
                   3652: 
                   3653: #########################################
1.51      www      3654: 
                   3655: sub findallcourses {
1.482     raeburn  3656:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3657:     my %roles;
                   3658:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3659:     my %courses;
1.51      www      3660:     my $now=time;
1.482     raeburn  3661:     if (!defined($uname)) {
                   3662:         $uname = $env{'user.name'};
                   3663:     }
                   3664:     if (!defined($udom)) {
                   3665:         $udom = $env{'user.domain'};
                   3666:     }
                   3667:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3668:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3669:         if (!%roles) {
                   3670:             %roles = (
                   3671:                        cc => 1,
                   3672:                        in => 1,
                   3673:                        ep => 1,
                   3674:                        ta => 1,
                   3675:                        cr => 1,
                   3676:                        st => 1,
                   3677:              );
                   3678:         }
                   3679:         foreach my $entry (keys(%roleshash)) {
                   3680:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3681:             if ($trole =~ /^cr/) { 
                   3682:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3683:             } else {
                   3684:                 next if (!exists($roles{$trole}));
                   3685:             }
                   3686:             if ($tend) {
                   3687:                 next if ($tend < $now);
                   3688:             }
                   3689:             if ($tstart) {
                   3690:                 next if ($tstart > $now);
                   3691:             }
                   3692:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3693:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3694:             if ($secpart eq '') {
                   3695:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3696:                 $sec = 'none';
                   3697:                 $realsec = '';
                   3698:             } else {
                   3699:                 $cnum = $cnumpart;
                   3700:                 ($sec,$role) = split(/_/,$secpart);
                   3701:                 $realsec = $sec;
1.490     raeburn  3702:             }
1.482     raeburn  3703:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3704:         }
                   3705:     } else {
                   3706:         foreach my $key (keys(%env)) {
1.483     albertel 3707: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3708:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3709: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3710: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3711: 	        next if (%roles && !exists($roles{$role}));
                   3712: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3713:                 my $active=1;
                   3714:                 if ($starttime) {
                   3715: 		    if ($now<$starttime) { $active=0; }
                   3716:                 }
                   3717:                 if ($endtime) {
                   3718:                     if ($now>$endtime) { $active=0; }
                   3719:                 }
                   3720:                 if ($active) {
                   3721:                     if ($sec eq '') {
                   3722:                         $sec = 'none';
                   3723:                     }
                   3724:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3725:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3726:                 }
                   3727:             }
1.51      www      3728:         }
                   3729:     }
1.474     raeburn  3730:     return %courses;
1.51      www      3731: }
1.37      matthew  3732: 
1.54      www      3733: ###############################################
1.474     raeburn  3734: 
                   3735: sub blockcheck {
1.482     raeburn  3736:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3737: 
                   3738:     if (!defined($udom)) {
                   3739:         $udom = $env{'user.domain'};
                   3740:     }
                   3741:     if (!defined($uname)) {
                   3742:         $uname = $env{'user.name'};
                   3743:     }
                   3744: 
                   3745:     # If uname and udom are for a course, check for blocks in the course.
                   3746: 
                   3747:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3748:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3749:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3750:         return ($startblock,$endblock);
                   3751:     }
1.474     raeburn  3752: 
1.502     raeburn  3753:     my $startblock = 0;
                   3754:     my $endblock = 0;
1.482     raeburn  3755:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3756: 
1.490     raeburn  3757:     # If uname is for a user, and activity is course-specific, i.e.,
                   3758:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3759: 
1.490     raeburn  3760:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3761:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3762:         foreach my $key (keys(%live_courses)) {
                   3763:             if ($key ne $env{'request.course.id'}) {
                   3764:                 delete($live_courses{$key});
                   3765:             }
                   3766:         }
                   3767:     }
                   3768: 
                   3769:     my $otheruser = 0;
                   3770:     my %own_courses;
                   3771:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3772:         # Resource belongs to user other than current user.
                   3773:         $otheruser = 1;
                   3774:         # Gather courses for current user
                   3775:         %own_courses = 
                   3776:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3777:     }
                   3778: 
                   3779:     # Gather active course roles - course coordinator, instructor, 
                   3780:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3781: 
                   3782:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3783:         my ($cdom,$cnum);
                   3784:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3785:             $cdom = $env{'course.'.$course.'.domain'};
                   3786:             $cnum = $env{'course.'.$course.'.num'};
                   3787:         } else {
1.490     raeburn  3788:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3789:         }
                   3790:         my $no_ownblock = 0;
                   3791:         my $no_userblock = 0;
1.533     raeburn  3792:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3793:             # Check if current user has 'evb' priv for this
                   3794:             if (defined($own_courses{$course})) {
                   3795:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3796:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3797:                     if ($sec ne 'none') {
                   3798:                         $checkrole .= '/'.$sec;
                   3799:                     }
                   3800:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3801:                         $no_ownblock = 1;
                   3802:                         last;
                   3803:                     }
                   3804:                 }
                   3805:             }
                   3806:             # if they have 'evb' priv and are currently not playing student
                   3807:             next if (($no_ownblock) &&
                   3808:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3809:         }
1.474     raeburn  3810:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3811:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3812:             if ($sec ne 'none') {
1.482     raeburn  3813:                 $checkrole .= '/'.$sec;
1.474     raeburn  3814:             }
1.490     raeburn  3815:             if ($otheruser) {
                   3816:                 # Resource belongs to user other than current user.
                   3817:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3818:                 my ($trole,$tdom,$tnum,$tsec);
                   3819:                 my $entry = $live_courses{$course}{$sec};
                   3820:                 if ($entry =~ /^cr/) {
                   3821:                     ($trole,$tdom,$tnum,$tsec) = 
                   3822:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3823:                 } else {
                   3824:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3825:                 }
                   3826:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3827:                 $area = '/'.$tdom.'/'.$tnum;
                   3828:                 $trest = $tnum;
                   3829:                 if ($tsec ne '') {
                   3830:                     $area .= '/'.$tsec;
                   3831:                     $trest .= '/'.$tsec;
                   3832:                 }
                   3833:                 $spec = $trole.'.'.$area;
                   3834:                 if ($trole =~ /^cr/) {
                   3835:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3836:                                                       $tdom,$spec,$trest,$area);
                   3837:                 } else {
                   3838:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3839:                                                        $tdom,$spec,$trest,$area);
                   3840:                 }
                   3841:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3842:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3843:                     if ($1) {
                   3844:                         $no_userblock = 1;
                   3845:                         last;
                   3846:                     }
                   3847:                 }
1.490     raeburn  3848:             } else {
                   3849:                 # Resource belongs to current user
                   3850:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3851:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3852:                     $no_ownblock = 1;
                   3853:                     last;
                   3854:                 }
1.474     raeburn  3855:             }
                   3856:         }
                   3857:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3858:         next if (($no_ownblock) &&
1.491     albertel 3859:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3860:         next if ($no_userblock);
1.474     raeburn  3861: 
1.866     kalberla 3862:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3863:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3864:         
                   3865:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3866:         if (($start != 0) && 
                   3867:             (($startblock == 0) || ($startblock > $start))) {
                   3868:             $startblock = $start;
                   3869:         }
                   3870:         if (($end != 0)  &&
                   3871:             (($endblock == 0) || ($endblock < $end))) {
                   3872:             $endblock = $end;
                   3873:         }
1.490     raeburn  3874:     }
                   3875:     return ($startblock,$endblock);
                   3876: }
                   3877: 
                   3878: sub get_blocks {
                   3879:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3880:     my $startblock = 0;
                   3881:     my $endblock = 0;
                   3882:     my $course = $cdom.'_'.$cnum;
                   3883:     $setters->{$course} = {};
                   3884:     $setters->{$course}{'staff'} = [];
                   3885:     $setters->{$course}{'times'} = [];
                   3886:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3887:     foreach my $record (keys(%records)) {
                   3888:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3889:         if ($start <= time && $end >= time) {
                   3890:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3891:                 &parse_block_record($records{$record});
                   3892:             if ($blocks->{$activity} eq 'on') {
                   3893:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3894:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3895:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3896:                     $startblock = $start;
1.490     raeburn  3897:                 }
1.491     albertel 3898:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3899:                     $endblock = $end;
1.474     raeburn  3900:                 }
                   3901:             }
                   3902:         }
                   3903:     }
                   3904:     return ($startblock,$endblock);
                   3905: }
                   3906: 
                   3907: sub parse_block_record {
                   3908:     my ($record) = @_;
                   3909:     my ($setuname,$setudom,$title,$blocks);
                   3910:     if (ref($record) eq 'HASH') {
                   3911:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3912:         $title = &unescape($record->{'event'});
                   3913:         $blocks = $record->{'blocks'};
                   3914:     } else {
                   3915:         my @data = split(/:/,$record,3);
                   3916:         if (scalar(@data) eq 2) {
                   3917:             $title = $data[1];
                   3918:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3919:         } else {
                   3920:             ($setuname,$setudom,$title) = @data;
                   3921:         }
                   3922:         $blocks = { 'com' => 'on' };
                   3923:     }
                   3924:     return ($setuname,$setudom,$title,$blocks);
                   3925: }
                   3926: 
1.854     kalberla 3927: sub blocking_status {
1.867     kalberla 3928:   my $blocked;
1.854     kalberla 3929:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3930:   my %setters;
                   3931:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
                   3932:   if ($startblock && $endblock) {
                   3933:     $blocked = 1;
                   3934:   }
1.854     kalberla 3935:   if(!wantarray) {
                   3936:     return $blocked;
                   3937:   }
                   3938:   my $output;
                   3939:   my $querystring;
                   3940:   $querystring = "?activity=$activity";
                   3941: 
                   3942:       $output .= <<"END_MYBLOCK";
                   3943: <script type="text/javascript">
                   3944: // <![CDATA[
                   3945:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   3946:         var options = "width=" + w + ",height=" + h + ",";
                   3947:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   3948:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   3949:         var newWin = window.open(url, wdwName, options);
                   3950:         newWin.focus();
                   3951:     }
                   3952: 
                   3953: // ]]>
                   3954: </script>
                   3955: END_MYBLOCK
                   3956:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.867     kalberla 3957:   $output .= <<"END_BLOCK";
                   3958: <div class='LC_comblock'>
1.869     kalberla 3959:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
                   3960:   title='Communication Blocked'>
                   3961:   <img class='LC_noBorder LC_middle' title='Communication Blocked' src='/res/adm/pages/comblock.png' alt='Communication Blocked'/></a>
                   3962:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
                   3963:   title='Communication Blocked'>Communication Blocked</a>
1.867     kalberla 3964: </div>
                   3965: 
                   3966: END_BLOCK
1.474     raeburn  3967: 
1.854     kalberla 3968:   return ($blocked, $output);
                   3969: }
1.490     raeburn  3970: 
1.60      matthew  3971: ###############################################
                   3972: 
1.682     raeburn  3973: sub check_ip_acc {
                   3974:     my ($acc)=@_;
                   3975:     &Apache::lonxml::debug("acc is $acc");
                   3976:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   3977:         return 1;
                   3978:     }
                   3979:     my $allowed=0;
                   3980:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   3981: 
                   3982:     my $name;
                   3983:     foreach my $pattern (split(',',$acc)) {
                   3984:         $pattern =~ s/^\s*//;
                   3985:         $pattern =~ s/\s*$//;
                   3986:         if ($pattern =~ /\*$/) {
                   3987:             #35.8.*
                   3988:             $pattern=~s/\*//;
                   3989:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   3990:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   3991:             #35.8.3.[34-56]
                   3992:             my $low=$2;
                   3993:             my $high=$3;
                   3994:             $pattern=$1;
                   3995:             if ($ip =~ /^\Q$pattern\E/) {
                   3996:                 my $last=(split(/\./,$ip))[3];
                   3997:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   3998:             }
                   3999:         } elsif ($pattern =~ /^\*/) {
                   4000:             #*.msu.edu
                   4001:             $pattern=~s/\*//;
                   4002:             if (!defined($name)) {
                   4003:                 use Socket;
                   4004:                 my $netaddr=inet_aton($ip);
                   4005:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4006:             }
                   4007:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4008:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4009:             #127.0.0.1
                   4010:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4011:         } else {
                   4012:             #some.name.com
                   4013:             if (!defined($name)) {
                   4014:                 use Socket;
                   4015:                 my $netaddr=inet_aton($ip);
                   4016:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4017:             }
                   4018:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4019:         }
                   4020:         if ($allowed) { last; }
                   4021:     }
                   4022:     return $allowed;
                   4023: }
                   4024: 
                   4025: ###############################################
                   4026: 
1.60      matthew  4027: =pod
                   4028: 
1.112     bowersj2 4029: =head1 Domain Template Functions
                   4030: 
                   4031: =over 4
                   4032: 
                   4033: =item * &determinedomain()
1.60      matthew  4034: 
                   4035: Inputs: $domain (usually will be undef)
                   4036: 
1.63      www      4037: Returns: Determines which domain should be used for designs
1.60      matthew  4038: 
                   4039: =cut
1.54      www      4040: 
1.60      matthew  4041: ###############################################
1.63      www      4042: sub determinedomain {
                   4043:     my $domain=shift;
1.531     albertel 4044:     if (! $domain) {
1.60      matthew  4045:         # Determine domain if we have not been given one
                   4046:         $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258     albertel 4047:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4048:         if ($env{'request.role.domain'}) { 
                   4049:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4050:         }
                   4051:     }
1.63      www      4052:     return $domain;
                   4053: }
                   4054: ###############################################
1.517     raeburn  4055: 
1.518     albertel 4056: sub devalidate_domconfig_cache {
                   4057:     my ($udom)=@_;
                   4058:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4059: }
                   4060: 
                   4061: # ---------------------- Get domain configuration for a domain
                   4062: sub get_domainconf {
                   4063:     my ($udom) = @_;
                   4064:     my $cachetime=1800;
                   4065:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4066:     if (defined($cached)) { return %{$result}; }
                   4067: 
                   4068:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4069: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4070:     my (%designhash,%legacy);
1.518     albertel 4071:     if (keys(%domconfig) > 0) {
                   4072:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4073:             if (keys(%{$domconfig{'login'}})) {
                   4074:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4075:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4076:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4077:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4078:                                 $domconfig{'login'}{$key}{$img};
                   4079:                         }
                   4080:                     } else {
                   4081:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4082:                     }
1.632     raeburn  4083:                 }
                   4084:             } else {
                   4085:                 $legacy{'login'} = 1;
1.518     albertel 4086:             }
1.632     raeburn  4087:         } else {
                   4088:             $legacy{'login'} = 1;
1.518     albertel 4089:         }
                   4090:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4091:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4092:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4093:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4094:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4095:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4096:                         }
1.518     albertel 4097:                     }
                   4098:                 }
1.632     raeburn  4099:             } else {
                   4100:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4101:             }
1.632     raeburn  4102:         } else {
                   4103:             $legacy{'rolecolors'} = 1;
1.518     albertel 4104:         }
1.632     raeburn  4105:         if (keys(%legacy) > 0) {
                   4106:             my %legacyhash = &get_legacy_domconf($udom);
                   4107:             foreach my $item (keys(%legacyhash)) {
                   4108:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4109:                     if ($legacy{'login'}) { 
                   4110:                         $designhash{$item} = $legacyhash{$item};
                   4111:                     }
                   4112:                 } else {
                   4113:                     if ($legacy{'rolecolors'}) {
                   4114:                         $designhash{$item} = $legacyhash{$item};
                   4115:                     }
1.518     albertel 4116:                 }
                   4117:             }
                   4118:         }
1.632     raeburn  4119:     } else {
                   4120:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4121:     }
                   4122:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4123: 				  $cachetime);
                   4124:     return %designhash;
                   4125: }
                   4126: 
1.632     raeburn  4127: sub get_legacy_domconf {
                   4128:     my ($udom) = @_;
                   4129:     my %legacyhash;
                   4130:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4131:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4132:     if (-e $designfile) {
                   4133:         if ( open (my $fh,"<$designfile") ) {
                   4134:             while (my $line = <$fh>) {
                   4135:                 next if ($line =~ /^\#/);
                   4136:                 chomp($line);
                   4137:                 my ($key,$val)=(split(/\=/,$line));
                   4138:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4139:             }
                   4140:             close($fh);
                   4141:         }
                   4142:     }
                   4143:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4144:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4145:     }
                   4146:     return %legacyhash;
                   4147: }
                   4148: 
1.63      www      4149: =pod
                   4150: 
1.112     bowersj2 4151: =item * &domainlogo()
1.63      www      4152: 
                   4153: Inputs: $domain (usually will be undef)
                   4154: 
                   4155: Returns: A link to a domain logo, if the domain logo exists.
                   4156: If the domain logo does not exist, a description of the domain.
                   4157: 
                   4158: =cut
1.112     bowersj2 4159: 
1.63      www      4160: ###############################################
                   4161: sub domainlogo {
1.517     raeburn  4162:     my $domain = &determinedomain(shift);
1.518     albertel 4163:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4164:     # See if there is a logo
                   4165:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4166:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4167:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4168: 	    if ($imgsrc =~ m{^/res/}) {
                   4169: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4170: 		&Apache::lonnet::repcopy($local_name);
                   4171: 	    }
                   4172: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4173:         } 
                   4174:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4175:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4176:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4177:     } else {
1.60      matthew  4178:         return '';
1.59      www      4179:     }
                   4180: }
1.63      www      4181: ##############################################
                   4182: 
                   4183: =pod
                   4184: 
1.112     bowersj2 4185: =item * &designparm()
1.63      www      4186: 
                   4187: Inputs: $which parameter; $domain (usually will be undef)
                   4188: 
                   4189: Returns: value of designparamter $which
                   4190: 
                   4191: =cut
1.112     bowersj2 4192: 
1.397     albertel 4193: 
1.400     albertel 4194: ##############################################
1.397     albertel 4195: sub designparm {
                   4196:     my ($which,$domain)=@_;
                   4197:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4198:         return $env{'environment.color.'.$which};
1.96      www      4199:     }
1.63      www      4200:     $domain=&determinedomain($domain);
1.518     albertel 4201:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4202:     my $output;
1.517     raeburn  4203:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4204:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4205:     } else {
1.520     raeburn  4206:         $output = $defaultdesign{$which};
                   4207:     }
                   4208:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4209:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4210:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4211:             if ($output =~ m{^/res/}) {
                   4212:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4213:                 &Apache::lonnet::repcopy($local_name);
                   4214:             }
1.520     raeburn  4215:             $output = &lonhttpdurl($output);
                   4216:         }
1.63      www      4217:     }
1.520     raeburn  4218:     return $output;
1.63      www      4219: }
1.59      www      4220: 
1.822     bisitz   4221: ##############################################
                   4222: =pod
                   4223: 
1.832     bisitz   4224: =item * &authorspace()
                   4225: 
                   4226: Inputs: ./.
                   4227: 
                   4228: Returns: Path to the Construction Space of the current user's
                   4229:          accessed author space
                   4230:          The author space will be that of the current user
                   4231:          when accessing the own author space
                   4232:          and that of the co-author/assistent co-author
                   4233:          when accessing the co-author's/assistent co-author's
                   4234:          space
                   4235: 
                   4236: =cut
                   4237: 
                   4238: sub authorspace {
                   4239:     my $caname = '';
                   4240:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4241:         (undef,$caname) =
                   4242:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4243:     } else {
                   4244:         $caname = $env{'user.name'};
                   4245:     }
                   4246:     return '/priv/'.$caname.'/';
                   4247: }
                   4248: 
                   4249: ##############################################
                   4250: =pod
                   4251: 
1.822     bisitz   4252: =item * &head_subbox()
                   4253: 
                   4254: Inputs: $content (contains HTML code with page functions, etc.)
                   4255: 
                   4256: Returns: HTML div with $content
                   4257:          To be included in page header
                   4258: 
                   4259: =cut
                   4260: 
                   4261: sub head_subbox {
                   4262:     my ($content)=@_;
                   4263:     my $output =
1.844     bisitz   4264:         '<div id="LC_head_subbox">'
1.822     bisitz   4265:        .$content
                   4266:        .'</div>'
                   4267: }
                   4268: 
                   4269: ##############################################
                   4270: =pod
                   4271: 
                   4272: =item * &CSTR_pageheader()
                   4273: 
                   4274: Inputs: ./.
                   4275: 
                   4276: Returns: HTML div with CSTR path and recent box
                   4277:          To be included on Construction Space pages
                   4278: 
                   4279: =cut
                   4280: 
                   4281: sub CSTR_pageheader {
                   4282:     # this is for resources; directories have customtitle, and crumbs
                   4283:             # and select recent are created in lonpubdir.pm  
                   4284:     my ($uname,$thisdisfn)=
                   4285:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4286:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4287:     $formaction=~s/\/+/\//g;
                   4288: 
                   4289:     my $parentpath = '';
                   4290:     my $lastitem = '';
                   4291:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4292:         $parentpath = $1;
                   4293:         $lastitem = $2;
                   4294:     } else {
                   4295:         $lastitem = $thisdisfn;
                   4296:     }
                   4297:     return
                   4298:          '<div>'
                   4299:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4300:         .'<b>'.&mt('Construction Space:').'</b> '
                   4301:         .'<form name="dirs" method="post" action="'.$formaction
                   4302:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4303:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4304:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4305:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4306:         .'</form>'
                   4307:         .&Apache::lonmenu::constspaceform()
                   4308:         .'</div>';
                   4309: }
                   4310: 
1.60      matthew  4311: ###############################################
                   4312: ###############################################
                   4313: 
                   4314: =pod
                   4315: 
1.112     bowersj2 4316: =back
                   4317: 
1.549     albertel 4318: =head1 HTML Helpers
1.112     bowersj2 4319: 
                   4320: =over 4
                   4321: 
                   4322: =item * &bodytag()
1.60      matthew  4323: 
                   4324: Returns a uniform header for LON-CAPA web pages.
                   4325: 
                   4326: Inputs: 
                   4327: 
1.112     bowersj2 4328: =over 4
                   4329: 
                   4330: =item * $title, A title to be displayed on the page.
                   4331: 
                   4332: =item * $function, the current role (can be undef).
                   4333: 
                   4334: =item * $addentries, extra parameters for the <body> tag.
                   4335: 
                   4336: =item * $bodyonly, if defined, only return the <body> tag.
                   4337: 
                   4338: =item * $domain, if defined, force a given domain.
                   4339: 
                   4340: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4341:             text interface only)
1.60      matthew  4342: 
1.814     bisitz   4343: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4344:                      navigational links
1.317     albertel 4345: 
1.338     albertel 4346: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4347: 
1.361     albertel 4348: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4349:          'Switch To Inline Menu' link
                   4350: 
1.460     albertel 4351: =item * $args, optional argument valid values are
                   4352:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4353:             inherit_jsmath -> when creating popup window in a page,
                   4354:                               should it have jsmath forced on by the
                   4355:                               current page
1.460     albertel 4356: 
1.112     bowersj2 4357: =back
                   4358: 
1.60      matthew  4359: Returns: A uniform header for LON-CAPA web pages.  
                   4360: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4361: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4362: other decorations will be returned.
                   4363: 
                   4364: =cut
                   4365: 
1.54      www      4366: sub bodytag {
1.831     bisitz   4367:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4368:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4369: 
1.460     albertel 4370:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4371: 
1.183     matthew  4372:     $function = &get_users_function() if (!$function);
1.339     albertel 4373:     my $img =    &designparm($function.'.img',$domain);
                   4374:     my $font =   &designparm($function.'.font',$domain);
                   4375:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4376: 
1.803     bisitz   4377:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4378: 		   'bgcolor' => $pgbg,
1.339     albertel 4379: 		   'text'    => $font,
                   4380:                    'alink'   => &designparm($function.'.alink',$domain),
                   4381: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4382: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4383:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4384: 
1.63      www      4385:  # role and realm
1.378     raeburn  4386:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4387:     if ($role  eq 'ca') {
1.479     albertel 4388:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4389:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4390:     } 
1.55      www      4391: # realm
1.258     albertel 4392:     if ($env{'request.course.id'}) {
1.378     raeburn  4393:         if ($env{'request.role'} !~ /^cr/) {
                   4394:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4395:         }
1.359     albertel 4396: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4397:     } else {
                   4398:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4399:     }
1.433     albertel 4400: 
1.359     albertel 4401:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4402: # Set messages
1.60      matthew  4403:     my $messages=&domainlogo($domain);
1.330     albertel 4404: 
1.438     albertel 4405:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4406: 
1.101     www      4407: # construct main body tag
1.359     albertel 4408:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4409: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4410: 
1.530     albertel 4411:     if ($bodyonly) {
1.60      matthew  4412:         return $bodytag;
1.798     tempelho 4413:     } 
1.359     albertel 4414: 
1.410     albertel 4415:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4416:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4417: 	undef($role);
1.434     albertel 4418:     } else {
                   4419: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4420:     }
1.359     albertel 4421:     
1.762     bisitz   4422:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4423:     #
                   4424:     # Extra info if you are the DC
                   4425:     my $dc_info = '';
                   4426:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4427:                         $env{'course.'.$env{'request.course.id'}.
                   4428:                                  '.domain'}.'/'})) {
                   4429:         my $cid = $env{'request.course.id'};
                   4430:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4431:         $dc_info =~ s/\s+$//;
1.359     albertel 4432:         $dc_info = '('.$dc_info.')';
                   4433:     }
                   4434: 
1.853     droeschl 4435:     $role = "($role)" if $role;
                   4436:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4437: 
1.837     bisitz   4438:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4439:         # No Remote
1.258     albertel 4440: 	if ($env{'request.state'} eq 'construct') {
1.359     albertel 4441: 	    $forcereg=1;
                   4442: 	}
                   4443: 
1.836     bisitz   4444: #    if ($env{'request.state'} eq 'construct') {
                   4445: #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4446: #    }
1.359     albertel 4447: 
1.816     bisitz   4448:         my $titletable = '<table id="LC_title_bar">'
1.836     bisitz   4449:                         ."<tr><td> $titleinfo $dc_info</td>"
1.816     bisitz   4450:                         .'</tr></table>';
                   4451: 
1.814     bisitz   4452: 	if ($no_nav_bar) {
1.359     albertel 4453: 	    $bodytag .= $titletable;
                   4454: 	} else {
1.852     droeschl 4455:         $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4456:             <em>$realm</em> $dc_info</div>| unless $env{'form.inhibitmenu'};
                   4457: 
1.359     albertel 4458: 	    if ($env{'request.state'} eq 'construct') {
1.863     droeschl 4459:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$titletable);
1.272     raeburn  4460:             } else {
1.863     droeschl 4461:                 $bodytag .= &Apache::lonmenu::menubuttons($forcereg).$titletable;
1.272     raeburn  4462:             }
1.235     raeburn  4463:         }
                   4464:         return $bodytag;
1.94      www      4465:     }
1.95      www      4466: 
1.93      www      4467: #
1.95      www      4468: # Top frame rendering, Remote is up
1.93      www      4469: #
1.359     albertel 4470: 
1.517     raeburn  4471:     my $imgsrc = $img;
                   4472:     if ($img =~ /^\/adm/) {
1.575     albertel 4473:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4474:     }
                   4475:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4476: 
1.305     www      4477:     # Explicit link to get inline menu
1.361     albertel 4478:     my $menu= ($no_inline_link?''
1.883     droeschl 4479: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.853     droeschl 4480:     $bodytag .= qq|<div id="LC_nav_bar">$name $role
                   4481:             <em>$realm</em> $dc_info </div>
                   4482:             <ol class="LC_smallMenu LC_right">
                   4483:                 <li>$menu</li>
                   4484:             </ol>| unless $env{'form.inhibitmenu'};
1.245     matthew  4485:     #
1.94      www      4486:     return(<<ENDBODY);
1.60      matthew  4487: $bodytag
1.359     albertel 4488: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4489: <tr><td>$upperleft</td>
                   4490:     <td>$messages&nbsp;</td>
1.54      www      4491: </tr>
1.359     albertel 4492: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4493: </tr>
1.356     albertel 4494: </table>
1.54      www      4495: ENDBODY
1.182     matthew  4496: }
                   4497: 
1.330     albertel 4498: sub make_attr_string {
                   4499:     my ($register,$attr_ref) = @_;
                   4500: 
                   4501:     if ($attr_ref && !ref($attr_ref)) {
                   4502: 	die("addentries Must be a hash ref ".
                   4503: 	    join(':',caller(1))." ".
                   4504: 	    join(':',caller(0))." ");
                   4505:     }
                   4506: 
                   4507:     if ($register) {
1.339     albertel 4508: 	my ($on_load,$on_unload);
                   4509: 	foreach my $key (keys(%{$attr_ref})) {
                   4510: 	    if      (lc($key) eq 'onload') {
                   4511: 		$on_load.=$attr_ref->{$key}.';';
                   4512: 		delete($attr_ref->{$key});
                   4513: 
                   4514: 	    } elsif (lc($key) eq 'onunload') {
                   4515: 		$on_unload.=$attr_ref->{$key}.';';
                   4516: 		delete($attr_ref->{$key});
                   4517: 	    }
                   4518: 	}
                   4519: 	$attr_ref->{'onload'}  =
                   4520: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4521: 	$attr_ref->{'onunload'}=
                   4522: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4523:     }
                   4524: 
                   4525: # Accessibility font enhance
                   4526:     if ($env{'browser.fontenhance'} eq 'on') {
                   4527: 	my $style;
                   4528: 	foreach my $key (keys(%{$attr_ref})) {
                   4529: 	    if (lc($key) eq 'style') {
                   4530: 		$style.=$attr_ref->{$key}.';';
                   4531: 		delete($attr_ref->{$key});
                   4532: 	    }
                   4533: 	}
                   4534: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4535:     }
1.339     albertel 4536: 
1.330     albertel 4537:     my $attr_string;
                   4538:     foreach my $attr (keys(%$attr_ref)) {
                   4539: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4540:     }
                   4541:     return $attr_string;
                   4542: }
                   4543: 
                   4544: 
1.182     matthew  4545: ###############################################
1.251     albertel 4546: ###############################################
                   4547: 
                   4548: =pod
                   4549: 
                   4550: =item * &endbodytag()
                   4551: 
                   4552: Returns a uniform footer for LON-CAPA web pages.
                   4553: 
1.635     raeburn  4554: Inputs: 1 - optional reference to an args hash
                   4555: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4556: a 'Continue' link is not displayed if the page contains an
                   4557: internal redirect in the <head></head> section,
                   4558: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4559: 
                   4560: =cut
                   4561: 
                   4562: sub endbodytag {
1.635     raeburn  4563:     my ($args) = @_;
1.251     albertel 4564:     my $endbodytag='</body>';
1.269     albertel 4565:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4566:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4567:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4568: 	    $endbodytag=
                   4569: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4570: 	        &mt('Continue').'</a>'.
                   4571: 	        $endbodytag;
                   4572:         }
1.315     albertel 4573:     }
1.251     albertel 4574:     return $endbodytag;
                   4575: }
                   4576: 
1.352     albertel 4577: =pod
                   4578: 
                   4579: =item * &standard_css()
                   4580: 
                   4581: Returns a style sheet
                   4582: 
                   4583: Inputs: (all optional)
                   4584:             domain         -> force to color decorate a page for a specific
                   4585:                                domain
                   4586:             function       -> force usage of a specific rolish color scheme
                   4587:             bgcolor        -> override the default page bgcolor
                   4588: 
                   4589: =cut
                   4590: 
1.343     albertel 4591: sub standard_css {
1.345     albertel 4592:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4593:     $function  = &get_users_function() if (!$function);
                   4594:     my $img    = &designparm($function.'.img',   $domain);
                   4595:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4596:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4597:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4598: #second colour for later usage
1.345     albertel 4599:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4600:     my $pgbg_or_bgcolor =
                   4601: 	         $bgcolor ||
1.352     albertel 4602: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4603:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4604:     my $alink  = &designparm($function.'.alink', $domain);
                   4605:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4606:     my $link   = &designparm($function.'.link',  $domain);
                   4607: 
1.704     muellerd 4608:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4609:     my $bgcol = &designparm('login.bgcol',$domain);
                   4610:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4611: 
1.602     albertel 4612:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4613:     my $mono                 = 'monospace';
1.850     bisitz   4614:     my $data_table_head      = $sidebg;
                   4615:     my $data_table_light     = '#FAFAFA';
                   4616:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4617:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4618:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4619:     my $mail_new             = '#FFBB77';
                   4620:     my $mail_new_hover       = '#DD9955';
                   4621:     my $mail_read            = '#BBBB77';
                   4622:     my $mail_read_hover      = '#999944';
                   4623:     my $mail_replied         = '#AAAA88';
                   4624:     my $mail_replied_hover   = '#888855';
                   4625:     my $mail_other           = '#99BBBB';
                   4626:     my $mail_other_hover     = '#669999';
1.391     albertel 4627:     my $table_header         = '#DDDDDD';
1.489     raeburn  4628:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4629:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4630: 
1.608     albertel 4631:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4632: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4633: 	                                                 : '0 3px 0 4px';
1.448     albertel 4634: 
1.523     albertel 4635: 
1.343     albertel 4636:     return <<END;
1.795     www      4637: body {
                   4638:    font-family: $sans;
                   4639:    line-height:130%;
                   4640:    font-size:0.83em;
                   4641:    color:$font;
                   4642: }
                   4643: 
                   4644: a:link, a:visited { 
                   4645:   font-size:100%; 
                   4646: }
                   4647: 
                   4648: a:focus { 
                   4649:   color: red;
                   4650:   background: yellow 
                   4651: }
1.698     harmsja  4652: 
1.846     bisitz   4653: hr {
                   4654:   clear: both;
                   4655:   color: $tabbg;
                   4656:   background-color: $tabbg;
                   4657:   height: 3px;
                   4658:   border: none;
                   4659: }
                   4660: 
1.795     www      4661: form, .inline { 
                   4662:    display: inline; 
                   4663: }
1.721     harmsja  4664: 
1.795     www      4665: .LC_right {
                   4666:    text-align:right;
                   4667: }
                   4668: 
                   4669: .LC_middle {
                   4670:    vertical-align:middle;
                   4671: }
1.721     harmsja  4672: 
                   4673: /* just for tests */
1.754     droeschl 4674: .LC_400Box {width:400px; }
1.721     harmsja  4675: /* end */
                   4676: 
1.778     bisitz   4677: .LC_filename {
                   4678:   font-family: $mono;
                   4679:   white-space:pre;
                   4680: }
                   4681: 
                   4682: .LC_fileicon {
                   4683:   border: none;
                   4684:   height: 1.3em;
                   4685:   vertical-align: text-bottom;
                   4686:   margin-right: 0.3em;
                   4687:   text-decoration:none;
                   4688: }
                   4689: 
1.350     albertel 4690: .LC_error {
                   4691:   color: red;
                   4692:   font-size: larger;
                   4693: }
1.795     www      4694: 
1.457     albertel 4695: .LC_warning,
                   4696: .LC_diff_removed {
1.733     bisitz   4697:   color: red;
1.394     albertel 4698: }
1.532     albertel 4699: 
                   4700: .LC_info,
1.457     albertel 4701: .LC_success,
                   4702: .LC_diff_added {
1.350     albertel 4703:   color: green;
                   4704: }
1.795     www      4705: 
1.802     bisitz   4706: div.LC_confirm_box {
                   4707:   background-color: #FAFAFA;
                   4708:   border: 1px solid $lg_border_color;
                   4709:   margin-right: 0;
                   4710:   padding: 5px;
                   4711: }
                   4712: 
                   4713: div.LC_confirm_box .LC_error img,
                   4714: div.LC_confirm_box .LC_success img {
                   4715:   vertical-align: middle;
                   4716: }
                   4717: 
1.440     albertel 4718: .LC_icon {
1.771     droeschl 4719:   border: none;
1.790     droeschl 4720:   vertical-align: middle;
1.771     droeschl 4721: }
                   4722: 
1.543     albertel 4723: .LC_docs_spacer {
                   4724:   width: 25px;
                   4725:   height: 1px;
1.771     droeschl 4726:   border: none;
1.543     albertel 4727: }
1.346     albertel 4728: 
1.532     albertel 4729: .LC_internal_info {
1.735     bisitz   4730:   color: #999999;
1.532     albertel 4731: }
                   4732: 
1.794     www      4733: .LC_discussion {
                   4734:    background: $tabbg;
                   4735:    border: 1px solid black;
                   4736:    margin: 2px;
                   4737: }
                   4738: 
                   4739: .LC_disc_action_links_bar {
                   4740:    background: $tabbg;
1.803     bisitz   4741:    border: none;
1.795     www      4742:    margin: 4px;
1.794     www      4743: }
                   4744: 
                   4745: .LC_disc_action_left {
                   4746:    text-align: left;
                   4747: }
                   4748: 
                   4749: .LC_disc_action_right {
                   4750:    text-align: right;
                   4751: }
                   4752: 
                   4753: .LC_disc_new_item {
                   4754:    background: white;
                   4755:    border: 2px solid red;
                   4756:    margin: 2px;
                   4757: }
                   4758: 
                   4759: .LC_disc_old_item {
                   4760:    background: white;
                   4761:    border: 1px solid black;
                   4762:    margin: 2px;
                   4763: }
                   4764: 
1.458     albertel 4765: table.LC_pastsubmission {
                   4766:   border: 1px solid black;
                   4767:   margin: 2px;
                   4768: }
                   4769: 
1.795     www      4770: table#LC_top_nav,
                   4771: table#LC_menubuttons,
                   4772: table#LC_nav_location {
1.345     albertel 4773:   width: 100%;
                   4774:   background: $pgbg;
1.392     albertel 4775:   border: 2px;
1.402     albertel 4776:   border-collapse: separate;
1.803     bisitz   4777:   padding: 0;
1.345     albertel 4778: }
1.392     albertel 4779: 
1.801     tempelho 4780: table#LC_title_bar a {
                   4781:   color: $fontmenu;
                   4782: }
1.836     bisitz   4783: 
1.807     droeschl 4784: table#LC_title_bar {
1.819     tempelho 4785:   clear: both;
1.836     bisitz   4786:   display: none;
1.807     droeschl 4787: }
                   4788: 
1.795     www      4789: table#LC_title_bar,
                   4790: table.LC_breadcrumbs,
1.393     albertel 4791: table#LC_title_bar.LC_with_remote {
1.359     albertel 4792:   width: 100%;
1.392     albertel 4793:   border-color: $pgbg;
                   4794:   border-style: solid;
                   4795:   border-width: $border;
1.379     albertel 4796:   background: $pgbg;
1.801     tempelho 4797:   color: $fontmenu;
1.392     albertel 4798:   border-collapse: collapse;
1.803     bisitz   4799:   padding: 0;
1.819     tempelho 4800:   margin: 0;
1.359     albertel 4801: }
1.795     www      4802: 
1.359     albertel 4803: table#LC_title_bar td {
                   4804:   background: $tabbg;
                   4805: }
1.795     www      4806: 
1.706     harmsja  4807: table#LC_menubuttons img{
1.803     bisitz   4808:   border: none;
1.346     albertel 4809: }
1.795     www      4810: 
1.345     albertel 4811: table#LC_top_nav td {
                   4812:   background: $tabbg;
1.803     bisitz   4813:   border: none;
1.407     albertel 4814:   font-size: small;
1.706     harmsja  4815:   vertical-align:top;
                   4816:   padding:2px 5px 2px 5px;
1.345     albertel 4817: }
1.795     www      4818: 
                   4819: table#LC_top_nav td a,
                   4820: div#LC_top_nav a {
1.345     albertel 4821:   color: $font;
                   4822: }
1.795     www      4823: 
1.364     albertel 4824: table#LC_top_nav td.LC_top_nav_logo {
                   4825:   background: $tabbg;
1.432     albertel 4826:   text-align: left;
1.408     albertel 4827:   white-space: nowrap;
1.432     albertel 4828:   width: 31px;
1.408     albertel 4829: }
1.795     www      4830: 
1.408     albertel 4831: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4832:   border: none;
1.408     albertel 4833:   vertical-align: bottom;
1.364     albertel 4834: }
1.795     www      4835: 
1.777     tempelho 4836: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4837: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4838:   width: 2.0em;
                   4839: }
1.795     www      4840: 
1.442     albertel 4841: table#LC_top_nav td.LC_top_nav_login {
                   4842:   width: 4.0em;
                   4843:   text-align: center;
                   4844: }
1.795     www      4845: 
1.842     droeschl 4846: .LC_breadcrumbs_component {
                   4847:     float: right;
                   4848:     margin: 0 1em;
1.357     albertel 4849: }
1.842     droeschl 4850: .LC_breadcrumbs_component img {
                   4851:     vertical-align: middle;
1.777     tempelho 4852: }
1.795     www      4853: 
1.383     albertel 4854: td.LC_table_cell_checkbox {
                   4855:   text-align: center;
                   4856: }
1.795     www      4857: 
1.779     bisitz   4858: table#LC_mainmenu td.LC_mainmenu_column {
                   4859:     vertical-align: top;
1.777     tempelho 4860: }
1.522     albertel 4861: 
1.795     www      4862: .LC_fontsize_small {
1.705     tempelho 4863:  font-size: 70%;
                   4864: }
                   4865: 
1.844     bisitz   4866: #LC_breadcrumbs {
1.819     tempelho 4867:  clear:both;
                   4868:  background: $sidebg;
1.822     bisitz   4869:  border-bottom: 1px solid $lg_border_color;
1.819     tempelho 4870:  line-height: 32px; 
1.822     bisitz   4871:  margin: 0;
1.819     tempelho 4872:  padding: 0;
                   4873: }
1.862     bisitz   4874: 
1.839     droeschl 4875: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   4876: #LC_remote #LC_breadcrumbs {
1.839     droeschl 4877:     display:none;
                   4878: }
1.819     tempelho 4879: 
1.844     bisitz   4880: #LC_head_subbox {
1.822     bisitz   4881:  clear:both;
                   4882:  background: #F8F8F8; /* $sidebg; */
                   4883:  border-bottom: 1px solid $lg_border_color;
                   4884:  margin: 0 0 10px 0;
                   4885:  padding: 5px;
                   4886: }
                   4887: 
1.795     www      4888: .LC_fontsize_medium {
1.705     tempelho 4889:  font-size: 85%;
                   4890: }
                   4891: 
1.795     www      4892: .LC_fontsize_large {
1.705     tempelho 4893:  font-size: 120%;
                   4894: }
                   4895: 
1.346     albertel 4896: .LC_menubuttons_inline_text {
                   4897:   color: $font;
1.698     harmsja  4898:   font-size: 90%;
1.701     harmsja  4899:   padding-left:3px;
1.346     albertel 4900: }
                   4901: 
1.526     www      4902: .LC_menubuttons_link {
                   4903:   text-decoration: none;
                   4904: }
1.795     www      4905: 
1.522     albertel 4906: .LC_menubuttons_category {
1.521     www      4907:   color: $font;
1.526     www      4908:   background: $pgbg;
1.521     www      4909:   font-size: larger;
                   4910:   font-weight: bold;
                   4911: }
                   4912: 
1.346     albertel 4913: td.LC_menubuttons_text {
1.779     bisitz   4914:  	color: $font;
1.346     albertel 4915: }
1.706     harmsja  4916: 
1.346     albertel 4917: .LC_current_location {
                   4918:   background: $tabbg;
                   4919: }
1.795     www      4920: 
1.346     albertel 4921: .LC_new_mail {
1.634     www      4922:   background: $tabbg;
1.346     albertel 4923:   font-weight: bold;
                   4924: }
1.347     albertel 4925: 
1.795     www      4926: table.LC_data_table,
                   4927: table.LC_mail_list {
1.347     albertel 4928:   border: 1px solid #000000;
1.402     albertel 4929:   border-collapse: separate;
1.426     albertel 4930:   border-spacing: 1px;
1.610     albertel 4931:   background: $pgbg;
1.347     albertel 4932: }
1.795     www      4933: 
1.422     albertel 4934: .LC_data_table_dense {
                   4935:   font-size: small;
                   4936: }
1.795     www      4937: 
1.507     raeburn  4938: table.LC_nested_outer {
                   4939:   border: 1px solid #000000;
1.589     raeburn  4940:   border-collapse: collapse;
1.803     bisitz   4941:   border-spacing: 0;
1.507     raeburn  4942:   width: 100%;
                   4943: }
1.795     www      4944: 
1.879     raeburn  4945: table.LC_innerpickbox,
1.507     raeburn  4946: table.LC_nested {
1.803     bisitz   4947:   border: none;
1.589     raeburn  4948:   border-collapse: collapse;
1.803     bisitz   4949:   border-spacing: 0;
1.507     raeburn  4950:   width: 100%;
                   4951: }
1.795     www      4952: 
                   4953: table.LC_data_table tr th, 
                   4954: table.LC_calendar tr th, 
                   4955: table.LC_mail_list tr th,
1.879     raeburn  4956: table.LC_prior_tries tr th,
                   4957: table.LC_innerpickbox tr th {
1.349     albertel 4958:   font-weight: bold;
                   4959:   background-color: $data_table_head;
1.801     tempelho 4960:   color:$fontmenu;
1.701     harmsja  4961:   font-size:90%;
1.347     albertel 4962: }
1.795     www      4963: 
1.879     raeburn  4964: table.LC_innerpickbox tr th,
                   4965: table.LC_innerpickbox tr td {
                   4966:   vertical-align: top;
                   4967: }
                   4968: 
1.711     raeburn  4969: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   4970:   background-color: #CCCCCC;
1.711     raeburn  4971:   font-weight: bold;
                   4972:   text-align: left;
                   4973: }
1.795     www      4974: 
1.779     bisitz   4975: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   4976: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 4977:   background-color: $data_table_light;
1.425     albertel 4978:   padding: 2px;
1.347     albertel 4979: }
1.795     www      4980: 
1.610     albertel 4981: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   4982: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 4983:   background-color: $data_table_dark;
1.709     bisitz   4984:   padding: 2px;
1.347     albertel 4985: }
1.795     www      4986: 
1.425     albertel 4987: table.LC_data_table tr.LC_data_table_highlight td {
                   4988:   background-color: $data_table_darker;
                   4989: }
1.795     www      4990: 
1.639     raeburn  4991: table.LC_data_table tr td.LC_leftcol_header {
                   4992:   background-color: $data_table_head;
                   4993:   font-weight: bold;
                   4994: }
1.795     www      4995: 
1.451     albertel 4996: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  4997: table.LC_nested tr.LC_empty_row td {
1.347     albertel 4998:   background-color: #FFFFFF;
1.421     albertel 4999:   font-weight: bold;
                   5000:   font-style: italic;
                   5001:   text-align: center;
                   5002:   padding: 8px;
1.347     albertel 5003: }
1.795     www      5004: 
1.507     raeburn  5005: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5006:   padding: 4ex
                   5007: }
1.795     www      5008: 
1.507     raeburn  5009: table.LC_nested_outer tr th {
                   5010:   font-weight: bold;
1.801     tempelho 5011:   color:$fontmenu;
1.507     raeburn  5012:   background-color: $data_table_head;
1.701     harmsja  5013:   font-size: small;
1.507     raeburn  5014:   border-bottom: 1px solid #000000;
                   5015: }
1.795     www      5016: 
1.507     raeburn  5017: table.LC_nested_outer tr td.LC_subheader {
                   5018:   background-color: $data_table_head;
                   5019:   font-weight: bold;
                   5020:   font-size: small;
                   5021:   border-bottom: 1px solid #000000;
                   5022:   text-align: right;
1.451     albertel 5023: }
1.795     www      5024: 
1.507     raeburn  5025: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5026:   background-color: #CCCCCC;
1.451     albertel 5027:   font-weight: bold;
                   5028:   font-size: small;
1.507     raeburn  5029:   text-align: center;
                   5030: }
1.795     www      5031: 
1.589     raeburn  5032: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5033: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5034:   text-align: left;
1.451     albertel 5035: }
1.795     www      5036: 
1.507     raeburn  5037: table.LC_nested td {
1.735     bisitz   5038:   background-color: #FFFFFF;
1.451     albertel 5039:   font-size: small;
1.507     raeburn  5040: }
1.795     www      5041: 
1.507     raeburn  5042: table.LC_nested_outer tr th.LC_right_item,
                   5043: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5044: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5045: table.LC_nested tr td.LC_right_item {
1.451     albertel 5046:   text-align: right;
                   5047: }
                   5048: 
1.507     raeburn  5049: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5050:   background-color: #EEEEEE;
1.451     albertel 5051: }
                   5052: 
1.473     raeburn  5053: table.LC_createuser {
                   5054: }
                   5055: 
                   5056: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5057:   font-size: small;
1.473     raeburn  5058: }
                   5059: 
                   5060: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5061:   background-color: #CCCCCC;
1.473     raeburn  5062:   font-weight: bold;
                   5063:   text-align: center;
                   5064: }
                   5065: 
1.349     albertel 5066: table.LC_calendar {
                   5067:   border: 1px solid #000000;
                   5068:   border-collapse: collapse;
                   5069: }
1.795     www      5070: 
1.349     albertel 5071: table.LC_calendar_pickdate {
                   5072:   font-size: xx-small;
                   5073: }
1.795     www      5074: 
1.349     albertel 5075: table.LC_calendar tr td {
                   5076:   border: 1px solid #000000;
                   5077:   vertical-align: top;
                   5078: }
1.795     www      5079: 
1.349     albertel 5080: table.LC_calendar tr td.LC_calendar_day_empty {
                   5081:   background-color: $data_table_dark;
                   5082: }
1.795     www      5083: 
1.779     bisitz   5084: table.LC_calendar tr td.LC_calendar_day_current {
                   5085:   background-color: $data_table_highlight;
1.777     tempelho 5086: }
1.795     www      5087: 
1.349     albertel 5088: table.LC_mail_list tr.LC_mail_new {
                   5089:   background-color: $mail_new;
                   5090: }
1.795     www      5091: 
1.349     albertel 5092: table.LC_mail_list tr.LC_mail_new:hover {
                   5093:   background-color: $mail_new_hover;
                   5094: }
1.795     www      5095: 
                   5096: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5097: }
1.795     www      5098: 
                   5099: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5100: }
1.795     www      5101: 
1.349     albertel 5102: table.LC_mail_list tr.LC_mail_read {
                   5103:   background-color: $mail_read;
                   5104: }
1.795     www      5105: 
1.349     albertel 5106: table.LC_mail_list tr.LC_mail_read:hover {
                   5107:   background-color: $mail_read_hover;
                   5108: }
1.795     www      5109: 
1.349     albertel 5110: table.LC_mail_list tr.LC_mail_replied {
                   5111:   background-color: $mail_replied;
                   5112: }
1.795     www      5113: 
1.349     albertel 5114: table.LC_mail_list tr.LC_mail_replied:hover {
                   5115:   background-color: $mail_replied_hover;
                   5116: }
1.795     www      5117: 
1.349     albertel 5118: table.LC_mail_list tr.LC_mail_other {
                   5119:   background-color: $mail_other;
                   5120: }
1.795     www      5121: 
1.349     albertel 5122: table.LC_mail_list tr.LC_mail_other:hover {
                   5123:   background-color: $mail_other_hover;
                   5124: }
1.494     raeburn  5125: 
1.777     tempelho 5126: table.LC_data_table tr > td.LC_browser_file,
                   5127: table.LC_data_table tr > td.LC_browser_file_published {
1.389     albertel 5128:   background: #CCFF88;
                   5129: }
1.795     www      5130: 
1.777     tempelho 5131: table.LC_data_table tr > td.LC_browser_file_locked,
                   5132: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5133:   background: #FFAA99;
1.387     albertel 5134: }
1.795     www      5135: 
1.777     tempelho 5136: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779     bisitz   5137:   background: #AAAAAA;
                   5138: }
1.795     www      5139: 
1.777     tempelho 5140: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5141: table.LC_data_table tr > td.LC_browser_file_metamodified {
                   5142:   background: #FFFF77;
1.777     tempelho 5143: }
1.795     www      5144: 
1.696     bisitz   5145: table.LC_data_table tr.LC_browser_folder > td {
1.389     albertel 5146:   background: #CCCCFF;
1.387     albertel 5147: }
1.696     bisitz   5148: 
1.707     bisitz   5149: table.LC_data_table tr > td.LC_roles_is {
                   5150: /*  background: #77FF77; */
                   5151: }
1.795     www      5152: 
1.707     bisitz   5153: table.LC_data_table tr > td.LC_roles_future {
                   5154:   background: #FFFF77;
                   5155: }
1.795     www      5156: 
1.707     bisitz   5157: table.LC_data_table tr > td.LC_roles_will {
                   5158:   background: #FFAA77;
                   5159: }
1.795     www      5160: 
1.707     bisitz   5161: table.LC_data_table tr > td.LC_roles_expired {
                   5162:   background: #FF7777;
                   5163: }
1.795     www      5164: 
1.707     bisitz   5165: table.LC_data_table tr > td.LC_roles_will_not {
                   5166:   background: #AAFF77;
                   5167: }
1.795     www      5168: 
1.707     bisitz   5169: table.LC_data_table tr > td.LC_roles_selected {
                   5170:   background: #11CC55;
                   5171: }
                   5172: 
1.388     albertel 5173: span.LC_current_location {
1.701     harmsja  5174:   font-size:larger;
1.388     albertel 5175:   background: $pgbg;
                   5176: }
1.387     albertel 5177: 
1.395     albertel 5178: span.LC_parm_menu_item {
                   5179:   font-size: larger;
                   5180: }
1.795     www      5181: 
1.395     albertel 5182: span.LC_parm_scope_all {
                   5183:   color: red;
                   5184: }
1.795     www      5185: 
1.395     albertel 5186: span.LC_parm_scope_folder {
                   5187:   color: green;
                   5188: }
1.795     www      5189: 
1.395     albertel 5190: span.LC_parm_scope_resource {
                   5191:   color: orange;
                   5192: }
1.795     www      5193: 
1.395     albertel 5194: span.LC_parm_part {
                   5195:   color: blue;
                   5196: }
1.795     www      5197: 
1.395     albertel 5198: span.LC_parm_folder, span.LC_parm_symb {
                   5199:   font-size: x-small;
                   5200:   font-family: $mono;
                   5201:   color: #AAAAAA;
                   5202: }
                   5203: 
1.795     www      5204: td.LC_parm_overview_level_menu,
                   5205: td.LC_parm_overview_map_menu,
                   5206: td.LC_parm_overview_parm_selectors,
                   5207: td.LC_parm_overview_restrictions  {
1.396     albertel 5208:   border: 1px solid black;
                   5209:   border-collapse: collapse;
                   5210: }
1.795     www      5211: 
1.396     albertel 5212: table.LC_parm_overview_restrictions td {
                   5213:   border-width: 1px 4px 1px 4px;
                   5214:   border-style: solid;
                   5215:   border-color: $pgbg;
                   5216:   text-align: center;
                   5217: }
1.795     www      5218: 
1.396     albertel 5219: table.LC_parm_overview_restrictions th {
                   5220:   background: $tabbg;
                   5221:   border-width: 1px 4px 1px 4px;
                   5222:   border-style: solid;
                   5223:   border-color: $pgbg;
                   5224: }
1.795     www      5225: 
1.398     albertel 5226: table#LC_helpmenu {
1.803     bisitz   5227:   border: none;
1.398     albertel 5228:   height: 55px;
1.803     bisitz   5229:   border-spacing: 0;
1.398     albertel 5230: }
                   5231: 
                   5232: table#LC_helpmenu fieldset legend {
                   5233:   font-size: larger;
                   5234: }
1.795     www      5235: 
1.397     albertel 5236: table#LC_helpmenu_links {
                   5237:   width: 100%;
                   5238:   border: 1px solid black;
                   5239:   background: $pgbg;
1.803     bisitz   5240:   padding: 0;
1.397     albertel 5241:   border-spacing: 1px;
                   5242: }
1.795     www      5243: 
1.397     albertel 5244: table#LC_helpmenu_links tr td {
                   5245:   padding: 1px;
                   5246:   background: $tabbg;
1.399     albertel 5247:   text-align: center;
                   5248:   font-weight: bold;
1.397     albertel 5249: }
1.396     albertel 5250: 
1.795     www      5251: table#LC_helpmenu_links a:link,
                   5252: table#LC_helpmenu_links a:visited,
1.397     albertel 5253: table#LC_helpmenu_links a:active {
                   5254:   text-decoration: none;
                   5255:   color: $font;
                   5256: }
1.795     www      5257: 
1.397     albertel 5258: table#LC_helpmenu_links a:hover {
                   5259:   text-decoration: underline;
                   5260:   color: $vlink;
                   5261: }
1.396     albertel 5262: 
1.417     albertel 5263: .LC_chrt_popup_exists {
                   5264:   border: 1px solid #339933;
                   5265:   margin: -1px;
                   5266: }
1.795     www      5267: 
1.417     albertel 5268: .LC_chrt_popup_up {
                   5269:   border: 1px solid yellow;
                   5270:   margin: -1px;
                   5271: }
1.795     www      5272: 
1.417     albertel 5273: .LC_chrt_popup {
                   5274:   border: 1px solid #8888FF;
                   5275:   background: #CCCCFF;
                   5276: }
1.795     www      5277: 
1.421     albertel 5278: table.LC_pick_box {
                   5279:   border-collapse: separate;
                   5280:   background: white;
                   5281:   border: 1px solid black;
                   5282:   border-spacing: 1px;
                   5283: }
1.795     www      5284: 
1.421     albertel 5285: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5286:   background: $sidebg;
1.421     albertel 5287:   font-weight: bold;
                   5288:   text-align: right;
1.740     bisitz   5289:   vertical-align: top;
1.421     albertel 5290:   width: 184px;
                   5291:   padding: 8px;
                   5292: }
1.795     www      5293: 
1.579     raeburn  5294: table.LC_pick_box td.LC_pick_box_value {
                   5295:   text-align: left;
                   5296:   padding: 8px;
                   5297: }
1.795     www      5298: 
1.579     raeburn  5299: table.LC_pick_box td.LC_pick_box_select {
                   5300:   text-align: left;
                   5301:   padding: 8px;
                   5302: }
1.795     www      5303: 
1.424     albertel 5304: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5305:   padding: 0;
1.421     albertel 5306:   height: 1px;
                   5307:   background: black;
                   5308: }
1.795     www      5309: 
1.421     albertel 5310: table.LC_pick_box td.LC_pick_box_submit {
                   5311:   text-align: right;
                   5312: }
1.795     www      5313: 
1.579     raeburn  5314: table.LC_pick_box td.LC_evenrow_value {
                   5315:   text-align: left;
                   5316:   padding: 8px;
                   5317:   background-color: $data_table_light;
                   5318: }
1.795     www      5319: 
1.579     raeburn  5320: table.LC_pick_box td.LC_oddrow_value {
                   5321:   text-align: left;
                   5322:   padding: 8px;
                   5323:   background-color: $data_table_light;
                   5324: }
1.795     www      5325: 
1.579     raeburn  5326: table.LC_helpform_receipt {
                   5327:   width: 620px;
                   5328:   border-collapse: separate;
                   5329:   background: white;
                   5330:   border: 1px solid black;
                   5331:   border-spacing: 1px;
                   5332: }
1.795     www      5333: 
1.579     raeburn  5334: table.LC_helpform_receipt td.LC_pick_box_title {
                   5335:   background: $tabbg;
                   5336:   font-weight: bold;
                   5337:   text-align: right;
                   5338:   width: 184px;
                   5339:   padding: 8px;
                   5340: }
1.795     www      5341: 
1.579     raeburn  5342: table.LC_helpform_receipt td.LC_evenrow_value {
                   5343:   text-align: left;
                   5344:   padding: 8px;
                   5345:   background-color: $data_table_light;
                   5346: }
1.795     www      5347: 
1.579     raeburn  5348: table.LC_helpform_receipt td.LC_oddrow_value {
                   5349:   text-align: left;
                   5350:   padding: 8px;
                   5351:   background-color: $data_table_light;
                   5352: }
1.795     www      5353: 
1.579     raeburn  5354: table.LC_helpform_receipt td.LC_pick_box_separator {
1.803     bisitz   5355:   padding: 0;
1.579     raeburn  5356:   height: 1px;
                   5357:   background: black;
                   5358: }
1.795     www      5359: 
1.579     raeburn  5360: span.LC_helpform_receipt_cat {
                   5361:   font-weight: bold;
                   5362: }
1.795     www      5363: 
1.424     albertel 5364: table.LC_group_priv_box {
                   5365:   background: white;
                   5366:   border: 1px solid black;
                   5367:   border-spacing: 1px;
                   5368: }
1.795     www      5369: 
1.424     albertel 5370: table.LC_group_priv_box td.LC_pick_box_title {
                   5371:   background: $tabbg;
                   5372:   font-weight: bold;
                   5373:   text-align: right;
                   5374:   width: 184px;
                   5375: }
1.795     www      5376: 
1.424     albertel 5377: table.LC_group_priv_box td.LC_groups_fixed {
                   5378:   background: $data_table_light;
                   5379:   text-align: center;
                   5380: }
1.795     www      5381: 
1.424     albertel 5382: table.LC_group_priv_box td.LC_groups_optional {
                   5383:   background: $data_table_dark;
                   5384:   text-align: center;
                   5385: }
1.795     www      5386: 
1.424     albertel 5387: table.LC_group_priv_box td.LC_groups_functionality {
                   5388:   background: $data_table_darker;
                   5389:   text-align: center;
                   5390:   font-weight: bold;
                   5391: }
1.795     www      5392: 
1.424     albertel 5393: table.LC_group_priv td {
                   5394:   text-align: left;
1.803     bisitz   5395:   padding: 0;
1.424     albertel 5396: }
                   5397: 
1.421     albertel 5398: table.LC_notify_front_page {
                   5399:   background: white;
                   5400:   border: 1px solid black;
                   5401:   padding: 8px;
                   5402: }
1.795     www      5403: 
1.421     albertel 5404: table.LC_notify_front_page td {
                   5405:   padding: 8px;
                   5406: }
1.795     www      5407: 
1.424     albertel 5408: .LC_navbuttons {
                   5409:   margin: 2ex 0ex 2ex 0ex;
                   5410: }
1.795     www      5411: 
1.423     albertel 5412: .LC_topic_bar {
                   5413:   font-weight: bold;
                   5414:   width: 100%;
                   5415:   background: $tabbg;
                   5416:   vertical-align: middle;
                   5417:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5418:   padding: 3px;
1.423     albertel 5419: }
1.795     www      5420: 
1.423     albertel 5421: .LC_topic_bar span {
                   5422:   vertical-align: middle;
                   5423: }
1.795     www      5424: 
1.423     albertel 5425: .LC_topic_bar img {
                   5426:   vertical-align: bottom;
                   5427: }
1.795     www      5428: 
1.423     albertel 5429: table.LC_course_group_status {
                   5430:   margin: 20px;
                   5431: }
1.795     www      5432: 
1.423     albertel 5433: table.LC_status_selector td {
                   5434:   vertical-align: top;
                   5435:   text-align: center;
1.424     albertel 5436:   padding: 4px;
                   5437: }
1.795     www      5438: 
1.599     albertel 5439: div.LC_feedback_link {
1.616     albertel 5440:   clear: both;
1.829     kalberla 5441:   background: $sidebg;
1.779     bisitz   5442:   width: 100%;
1.829     kalberla 5443:   padding-bottom: 10px;
                   5444:   border: 1px $tabbg solid;
1.833     kalberla 5445:   height: 22px;
                   5446:   line-height: 22px;
                   5447:   padding-top: 5px;
                   5448: }
                   5449: 
                   5450: div.LC_feedback_link img {
                   5451:   height: 22px;
1.867     kalberla 5452:   vertical-align:middle;
1.829     kalberla 5453: }
                   5454: 
                   5455: div.LC_feedback_link a{
                   5456:   text-decoration: none;
1.489     raeburn  5457: }
1.795     www      5458: 
1.867     kalberla 5459: div.LC_comblock {
                   5460:   display:inline; 
                   5461:   color:$font;
                   5462:   font-size:90%;
                   5463: }
                   5464: 
                   5465: div.LC_feedback_link div.LC_comblock {
                   5466:   padding-left:5px;
                   5467: }
                   5468: 
                   5469: div.LC_feedback_link div.LC_comblock a {
                   5470:   color:$font;
                   5471: }
                   5472: 
1.489     raeburn  5473: span.LC_feedback_link {
1.858     bisitz   5474:   /* background: $feedback_link_bg; */
1.599     albertel 5475:   font-size: larger;
                   5476: }
1.795     www      5477: 
1.599     albertel 5478: span.LC_message_link {
1.858     bisitz   5479:   /* background: $feedback_link_bg; */
1.599     albertel 5480:   font-size: larger;
                   5481:   position: absolute;
                   5482:   right: 1em;
1.489     raeburn  5483: }
1.421     albertel 5484: 
1.515     albertel 5485: table.LC_prior_tries {
1.524     albertel 5486:   border: 1px solid #000000;
                   5487:   border-collapse: separate;
                   5488:   border-spacing: 1px;
1.515     albertel 5489: }
1.523     albertel 5490: 
1.515     albertel 5491: table.LC_prior_tries td {
1.524     albertel 5492:   padding: 2px;
1.515     albertel 5493: }
1.523     albertel 5494: 
                   5495: .LC_answer_correct {
1.795     www      5496:   background: lightgreen;
                   5497:   color: darkgreen;
                   5498:   padding: 6px;
1.523     albertel 5499: }
1.795     www      5500: 
1.523     albertel 5501: .LC_answer_charged_try {
1.797     www      5502:   background: #FFAAAA;
1.795     www      5503:   color: darkred;
                   5504:   padding: 6px;
1.523     albertel 5505: }
1.795     www      5506: 
1.779     bisitz   5507: .LC_answer_not_charged_try,
1.523     albertel 5508: .LC_answer_no_grade,
                   5509: .LC_answer_late {
1.795     www      5510:   background: lightyellow;
1.523     albertel 5511:   color: black;
1.795     www      5512:   padding: 6px;
1.523     albertel 5513: }
1.795     www      5514: 
1.523     albertel 5515: .LC_answer_previous {
1.795     www      5516:   background: lightblue;
                   5517:   color: darkblue;
                   5518:   padding: 6px;
1.523     albertel 5519: }
1.795     www      5520: 
1.779     bisitz   5521: .LC_answer_no_message {
1.777     tempelho 5522:   background: #FFFFFF;
                   5523:   color: black;
1.795     www      5524:   padding: 6px;
1.779     bisitz   5525: }
1.795     www      5526: 
1.779     bisitz   5527: .LC_answer_unknown {
                   5528:   background: orange;
                   5529:   color: black;
1.795     www      5530:   padding: 6px;
1.777     tempelho 5531: }
1.795     www      5532: 
1.529     albertel 5533: span.LC_prior_numerical,
                   5534: span.LC_prior_string,
                   5535: span.LC_prior_custom,
                   5536: span.LC_prior_reaction,
                   5537: span.LC_prior_math {
1.523     albertel 5538:   font-family: monospace;
                   5539:   white-space: pre;
                   5540: }
                   5541: 
1.525     albertel 5542: span.LC_prior_string {
                   5543:   font-family: monospace;
                   5544:   white-space: pre;
                   5545: }
                   5546: 
1.523     albertel 5547: table.LC_prior_option {
                   5548:   width: 100%;
                   5549:   border-collapse: collapse;
                   5550: }
1.795     www      5551: 
                   5552: table.LC_prior_rank, 
                   5553: table.LC_prior_match {
1.528     albertel 5554:   border-collapse: collapse;
                   5555: }
1.795     www      5556: 
1.528     albertel 5557: table.LC_prior_option tr td,
                   5558: table.LC_prior_rank tr td,
                   5559: table.LC_prior_match tr td {
1.524     albertel 5560:   border: 1px solid #000000;
1.515     albertel 5561: }
                   5562: 
1.855     bisitz   5563: .LC_nobreak {
1.544     albertel 5564:   white-space: nowrap;
1.519     raeburn  5565: }
                   5566: 
1.576     raeburn  5567: span.LC_cusr_emph {
                   5568:   font-style: italic;
                   5569: }
                   5570: 
1.633     raeburn  5571: span.LC_cusr_subheading {
                   5572:   font-weight: normal;
                   5573:   font-size: 85%;
                   5574: }
                   5575: 
1.545     albertel 5576: table.LC_docs_documents {
                   5577:   background: #BBBBBB;
1.803     bisitz   5578:   border-width: 0;
1.545     albertel 5579:   border-collapse: collapse;
                   5580: }
1.795     www      5581: 
1.777     tempelho 5582: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5583:   border: 2px solid black;
                   5584:   padding: 4px;
1.777     tempelho 5585: }
1.795     www      5586: 
1.861     bisitz   5587: div.LC_docs_entry_move {
1.859     bisitz   5588:   border: 1px solid #BBBBBB;
1.545     albertel 5589:   background: #DDDDDD;
1.861     bisitz   5590:   width: 22px;
1.859     bisitz   5591:   padding: 1px;
                   5592:   margin: 0;
1.545     albertel 5593: }
                   5594: 
1.861     bisitz   5595: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5596: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5597:   background: #DDDDDD;
                   5598:   font-size: x-small;
                   5599: }
1.795     www      5600: 
1.861     bisitz   5601: .LC_docs_entry_parameter {
                   5602:   white-space: nowrap;
                   5603: }
                   5604: 
1.544     albertel 5605: .LC_docs_copy {
1.545     albertel 5606:   color: #000099;
1.544     albertel 5607: }
1.795     www      5608: 
1.544     albertel 5609: .LC_docs_cut {
1.545     albertel 5610:   color: #550044;
1.544     albertel 5611: }
1.795     www      5612: 
1.544     albertel 5613: .LC_docs_rename {
1.545     albertel 5614:   color: #009900;
1.544     albertel 5615: }
1.795     www      5616: 
1.544     albertel 5617: .LC_docs_remove {
1.545     albertel 5618:   color: #990000;
                   5619: }
                   5620: 
1.547     albertel 5621: .LC_docs_reinit_warn,
                   5622: .LC_docs_ext_edit {
                   5623:   font-size: x-small;
                   5624: }
                   5625: 
1.545     albertel 5626: table.LC_docs_adddocs td,
                   5627: table.LC_docs_adddocs th {
                   5628:   border: 1px solid #BBBBBB;
                   5629:   padding: 4px;
                   5630:   background: #DDDDDD;
1.543     albertel 5631: }
                   5632: 
1.584     albertel 5633: table.LC_sty_begin {
                   5634:   background: #BBFFBB;
                   5635: }
1.795     www      5636: 
1.584     albertel 5637: table.LC_sty_end {
                   5638:   background: #FFBBBB;
                   5639: }
                   5640: 
1.589     raeburn  5641: table.LC_double_column {
1.803     bisitz   5642:   border-width: 0;
1.589     raeburn  5643:   border-collapse: collapse;
                   5644:   width: 100%;
                   5645:   padding: 2px;
                   5646: }
                   5647: 
                   5648: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5649:   top: 2px;
1.589     raeburn  5650:   left: 2px;
                   5651:   width: 47%;
                   5652:   vertical-align: top;
                   5653: }
                   5654: 
                   5655: table.LC_double_column tr td.LC_right_col {
                   5656:   top: 2px;
1.779     bisitz   5657:   right: 2px;
1.589     raeburn  5658:   width: 47%;
                   5659:   vertical-align: top;
                   5660: }
                   5661: 
1.591     raeburn  5662: div.LC_left_float {
                   5663:   float: left;
                   5664:   padding-right: 5%;
1.597     albertel 5665:   padding-bottom: 4px;
1.591     raeburn  5666: }
                   5667: 
                   5668: div.LC_clear_float_header {
1.597     albertel 5669:   padding-bottom: 2px;
1.591     raeburn  5670: }
                   5671: 
                   5672: div.LC_clear_float_footer {
1.597     albertel 5673:   padding-top: 10px;
1.591     raeburn  5674:   clear: both;
                   5675: }
                   5676: 
1.597     albertel 5677: div.LC_grade_show_user {
                   5678:   margin-top: 20px;
                   5679:   border: 1px solid black;
                   5680: }
1.795     www      5681: 
1.597     albertel 5682: div.LC_grade_user_name {
                   5683:   background: #DDDDEE;
                   5684:   border-bottom: 1px solid black;
1.705     tempelho 5685:   font-weight: bold;
                   5686:   font-size: large;
1.597     albertel 5687: }
1.795     www      5688: 
1.597     albertel 5689: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5690:   background: #DDEEDD;
                   5691: }
                   5692: 
                   5693: div.LC_grade_show_problem,
                   5694: div.LC_grade_submissions,
                   5695: div.LC_grade_message_center,
                   5696: div.LC_grade_info_links,
                   5697: div.LC_grade_assign {
                   5698:   margin: 5px;
                   5699:   width: 99%;
                   5700:   background: #FFFFFF;
                   5701: }
1.795     www      5702: 
1.597     albertel 5703: div.LC_grade_show_problem_header,
                   5704: div.LC_grade_submissions_header,
                   5705: div.LC_grade_message_center_header,
                   5706: div.LC_grade_assign_header {
1.705     tempelho 5707:   font-weight: bold;
                   5708:   font-size: large;
1.597     albertel 5709: }
1.795     www      5710: 
1.597     albertel 5711: div.LC_grade_show_problem_problem,
                   5712: div.LC_grade_submissions_body,
                   5713: div.LC_grade_message_center_body,
                   5714: div.LC_grade_assign_body {
                   5715:   border: 1px solid black;
                   5716:   width: 99%;
                   5717:   background: #FFFFFF;
                   5718: }
1.795     www      5719: 
1.598     albertel 5720: span.LC_grade_check_note {
1.705     tempelho 5721:   font-weight: normal;
                   5722:   font-size: medium;
1.598     albertel 5723:   display: inline;
                   5724:   position: absolute;
                   5725:   right: 1em;
                   5726: }
1.597     albertel 5727: 
1.613     albertel 5728: table.LC_scantron_action {
                   5729:   width: 100%;
                   5730: }
1.795     www      5731: 
1.613     albertel 5732: table.LC_scantron_action tr th {
1.698     harmsja  5733:   font-weight:bold;
                   5734:   font-style:normal;
1.613     albertel 5735: }
1.795     www      5736: 
1.779     bisitz   5737: .LC_edit_problem_header,
1.614     albertel 5738: div.LC_edit_problem_footer {
1.705     tempelho 5739:   font-weight: normal;
                   5740:   font-size:  medium;
1.602     albertel 5741:   margin: 2px;
1.600     albertel 5742: }
1.795     www      5743: 
1.600     albertel 5744: div.LC_edit_problem_header,
1.602     albertel 5745: div.LC_edit_problem_header div,
1.614     albertel 5746: div.LC_edit_problem_footer,
                   5747: div.LC_edit_problem_footer div,
1.602     albertel 5748: div.LC_edit_problem_editxml_header,
                   5749: div.LC_edit_problem_editxml_header div {
1.600     albertel 5750:   margin-top: 5px;
                   5751: }
1.795     www      5752: 
1.600     albertel 5753: div.LC_edit_problem_header_title {
1.705     tempelho 5754:   font-weight: bold;
                   5755:   font-size: larger;
1.602     albertel 5756:   background: $tabbg;
                   5757:   padding: 3px;
                   5758: }
1.795     www      5759: 
1.602     albertel 5760: table.LC_edit_problem_header_title {
1.705     tempelho 5761:   font-size: larger;
                   5762:   font-weight:  bold;
1.602     albertel 5763:   width: 100%;
                   5764:   border-color: $pgbg;
                   5765:   border-style: solid;
                   5766:   border-width: $border;
1.600     albertel 5767:   background: $tabbg;
1.602     albertel 5768:   border-collapse: collapse;
1.803     bisitz   5769:   padding: 0;
1.602     albertel 5770: }
                   5771: 
                   5772: div.LC_edit_problem_discards {
                   5773:   float: left;
                   5774:   padding-bottom: 5px;
                   5775: }
1.795     www      5776: 
1.602     albertel 5777: div.LC_edit_problem_saves {
                   5778:   float: right;
                   5779:   padding-bottom: 5px;
1.600     albertel 5780: }
1.795     www      5781: 
1.679     riegler  5782: img.stift{
1.803     bisitz   5783:   border-width: 0;
                   5784:   vertical-align: middle;
1.677     riegler  5785: }
1.680     riegler  5786: 
1.681     riegler  5787: table#LC_mainmenu{
                   5788:  margin-top:10px;
                   5789:  width:80%;
                   5790: }
                   5791: 
1.680     riegler  5792: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5793:   vertical-align: top;
                   5794:   width: 45%;
                   5795: }
1.795     www      5796: 
1.779     bisitz   5797: .LC_mainmenu_fieldset_category {
                   5798:   color: $font;
                   5799:   background: $pgbg;
                   5800:   font-size: small;
                   5801:   font-weight: bold;
1.777     tempelho 5802: }
1.795     www      5803: 
1.716     raeburn  5804: div.LC_createcourse {
                   5805:     margin: 10px 10px 10px 10px;
                   5806: }
                   5807: 
1.693     droeschl 5808: /* ---- Remove when done ----
                   5809: # The following styles is part of the redesign of LON-CAPA and are
                   5810: # subject to change during this project.
                   5811: # Don't rely on their current functionality as they might be 
                   5812: # changed or removed.
                   5813: # --------------------------*/
                   5814: 
1.698     harmsja  5815: a:hover,
1.721     harmsja  5816: ol.LC_smallMenu a:hover,
                   5817: ol#LC_MenuBreadcrumbs a:hover,
                   5818: ol#LC_PathBreadcrumbs a:hover,
                   5819: ul#LC_TabMainMenuContent a:hover,
                   5820: .LC_FormSectionClearButton input:hover
1.795     www      5821: ul.LC_TabContent   li:hover a {
1.698     harmsja  5822: 	color:#BF2317;
                   5823:         text-decoration:none;
1.693     droeschl 5824: }
                   5825: 
1.779     bisitz   5826: h1 {
1.813     bisitz   5827: 	padding: 0;
1.693     droeschl 5828: 	line-height:130%;
                   5829: }
1.698     harmsja  5830: 
1.795     www      5831: h2,h3,h4,h5,h6 {
1.803     bisitz   5832: 	margin: 5px 0 5px 0;
                   5833: 	padding: 0;
1.721     harmsja  5834: 	line-height:130%;
1.693     droeschl 5835: }
1.795     www      5836: 
                   5837: .LC_hcell {
1.698     harmsja  5838:         padding:3px 15px 3px 15px;
1.803     bisitz   5839:         margin: 0;
1.703     harmsja  5840: 	background-color:$tabbg;
1.801     tempelho 5841: 	color:$fontmenu;
1.779     bisitz   5842: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5843: }
1.795     www      5844: 
1.840     bisitz   5845: .LC_Box > .LC_hcell {
1.847     tempelho 5846:     margin: 0 -10px 10px -10px;
1.835     bisitz   5847: }
                   5848: 
1.721     harmsja  5849: .LC_noBorder {
1.803     bisitz   5850:         border: 0;
1.698     harmsja  5851: }
1.693     droeschl 5852: 
1.761     tempelho 5853: .LC_Right {
                   5854:         float: right;
1.803     bisitz   5855:         margin: 0;
                   5856:         padding: 0;
1.761     tempelho 5857: }
                   5858: 
1.721     harmsja  5859: .LC_FormSectionClearButton input {
1.779     bisitz   5860:         background-color:transparent;
1.803     bisitz   5861:         border: none;
1.698     harmsja  5862:         cursor:pointer;
                   5863:         text-decoration:underline;
1.693     droeschl 5864: }
1.763     bisitz   5865: 
                   5866: .LC_help_open_topic {
                   5867:         color: #FFFFFF;
                   5868:         background-color: #EEEEFF;
                   5869:         margin: 1px;
                   5870:         padding: 4px;
                   5871:         border: 1px solid #000033;
                   5872:         white-space: nowrap;
1.783     amueller 5873: /*		vertical-align: middle; */
1.759     neumanie 5874: }
1.693     droeschl 5875: 
1.698     harmsja  5876: dl,ul,div,fieldset {
1.803     bisitz   5877: 	margin: 10px 10px 10px 0;
1.806     bisitz   5878: /*	overflow: hidden; */
1.693     droeschl 5879: }
1.795     www      5880: 
1.838     bisitz   5881: fieldset > legend {
                   5882:     font-weight: bold;
                   5883:     padding: 0 5px 0 5px;
                   5884: }
                   5885: 
1.813     bisitz   5886: #LC_nav_bar {
1.807     droeschl 5887:     float: left;
1.852     droeschl 5888:     margin: 0.2em 0 0 0;
1.807     droeschl 5889: }
                   5890: 
1.813     bisitz   5891: #LC_nav_bar em{
1.807     droeschl 5892:     font-weight: bold;
                   5893:     font-style: normal;
                   5894: }
                   5895: 
                   5896: ol.LC_smallMenu {
                   5897:     float: right;
1.852     droeschl 5898:     margin: 0.2em 0 0 0;
1.807     droeschl 5899: }
                   5900: 
1.852     droeschl 5901: ol#LC_PathBreadcrumbs {
1.803     bisitz   5902: 	margin: 0;
1.693     droeschl 5903: }
                   5904: 
1.721     harmsja  5905: ol.LC_smallMenu li {
1.693     droeschl 5906: 	display: inline;
1.803     bisitz   5907: 	padding: 5px 5px 0 10px;
1.693     droeschl 5908: 	vertical-align: top;
                   5909: }
                   5910: 
1.721     harmsja  5911: ol.LC_smallMenu li img {
1.693     droeschl 5912: 	vertical-align: bottom;
                   5913: }
                   5914: 
1.721     harmsja  5915: ol.LC_smallMenu a {
1.693     droeschl 5916: 	font-size: 90%;
                   5917: 	color: RGB(80, 80, 80);
                   5918: 	text-decoration: none;
                   5919: }
1.795     www      5920: 
1.808     droeschl 5921: ul#LC_TabMainMenuContent {
1.807     droeschl 5922:     clear: both;
1.808     droeschl 5923:     color: $fontmenu;
                   5924:     background: $tabbg;
                   5925:     list-style: none;
                   5926:     padding: 0;
                   5927:     margin: 0;
                   5928:     width: 100%;
                   5929: }
                   5930: 
                   5931: ul#LC_TabMainMenuContent li {
                   5932:     font-weight: bold;
                   5933:     line-height: 1.8em;
                   5934:     padding: 0 0.8em; 
                   5935:     border-right: 1px solid black;
                   5936:     display: inline;
                   5937:     vertical-align: middle;
1.807     droeschl 5938: }
                   5939: 
1.847     tempelho 5940: ul.LC_TabContent {
1.721     harmsja  5941: 	display:block;
1.847     tempelho 5942: 	background: $sidebg;
1.858     bisitz   5943: 	border-bottom: solid 1px $lg_border_color;
1.721     harmsja  5944: 	list-style:none;
1.870     tempelho 5945: 	margin: 0 -10px;
1.803     bisitz   5946: 	padding: 0;
1.693     droeschl 5947: }
                   5948: 
1.795     www      5949: ul.LC_TabContent li,
                   5950: ul.LC_TabContentBigger li {
1.741     harmsja  5951: 	float:left;
                   5952: }
1.795     www      5953: 
1.808     droeschl 5954: ul#LC_TabMainMenuContent li a {
                   5955:     color: $fontmenu;
1.693     droeschl 5956: 	text-decoration: none;
                   5957: }
1.795     www      5958: 
1.721     harmsja  5959: ul.LC_TabContent {
1.847     tempelho 5960: 	min-height:1.5em;
1.721     harmsja  5961: }
1.795     www      5962: 
                   5963: ul.LC_TabContent li {
1.741     harmsja  5964: 	vertical-align:middle;
1.803     bisitz   5965: 	padding: 0 10px 0 10px;
1.745     ehlerst  5966: 	background-color:$tabbg;
                   5967: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  5968: }
1.795     www      5969: 
1.847     tempelho 5970: ul.LC_TabContent .right {
                   5971: 	float:right;
                   5972: }
                   5973: 
1.795     www      5974: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  5975: 	color:rgb(47,47,47);
                   5976: 	text-decoration:none;
                   5977: 	font-size:95%;
                   5978: 	font-weight:bold;
1.761     tempelho 5979: 	padding-right: 16px;
1.721     harmsja  5980: }
1.795     www      5981: 
                   5982: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 5983:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.841     tempelho 5984: 	border-bottom:solid 2px #FFFFFF;
1.761     tempelho 5985: 	padding-right: 16px;
1.744     ehlerst  5986: }
1.795     www      5987: 
1.870     tempelho 5988: #maincoursedoc {
                   5989: 	clear:both;
                   5990: }
                   5991: 
                   5992: ul.LC_TabContentBigger {
                   5993:         display:block;
                   5994:         list-style:none;
                   5995:         padding: 0;
                   5996: }
                   5997: 
1.795     www      5998: ul.LC_TabContentBigger li {
1.870     tempelho 5999:         vertical-align:bottom;
                   6000:         height: 30px;
                   6001:         font-size:110%;
                   6002:         font-weight:bold;
                   6003:         color: #737373;
1.841     tempelho 6004: }
                   6005: 
1.870     tempelho 6006: 
                   6007: ul.LC_TabContentBigger li a {
                   6008:         background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6009: 	height: 30px;
                   6010: 	line-height: 30px;
                   6011: 	text-align: center;
                   6012: 	display: block;
                   6013: 	text-decoration: none;
1.741     harmsja  6014: }
1.795     www      6015: 
1.870     tempelho 6016: ul.LC_TabContentBigger li:hover a, 
                   6017: ul.LC_TabContentBigger li.active a {
                   6018: 	background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
1.857     tempelho 6019: 	color:$font;
1.870     tempelho 6020: 	text-decoration: underline;
1.744     ehlerst  6021: }
1.795     www      6022: 
1.870     tempelho 6023: 
                   6024: ul.LC_TabContentBigger li b {
                   6025: 	background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6026: 	display: block;
                   6027: 	float: left;
                   6028: 	padding: 0 30px;
                   6029: }
                   6030: 
                   6031: ul.LC_TabContentBigger li:hover b,
                   6032: ul.LC_TabContentBigger li.active b {
                   6033:         background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6034:         color:$font;
                   6035: 	border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6036: }
1.693     droeschl 6037: 
1.870     tempelho 6038: 
1.862     bisitz   6039: ul.LC_CourseBreadcrumbs {
                   6040:   background: $sidebg;
                   6041:   line-height: 32px;
                   6042:   padding-left: 10px;
                   6043:   margin: 0 0 10px 0;
                   6044:   list-style-position: inside;
                   6045: 
                   6046: }
                   6047: 
1.795     www      6048: ol#LC_MenuBreadcrumbs, 
1.862     bisitz   6049: ol#LC_PathBreadcrumbs {
1.693     droeschl 6050: 	padding-left: 10px;
1.819     tempelho 6051: 	margin: 0;
1.693     droeschl 6052: 	list-style-position: inside;
                   6053: }
                   6054: 
1.795     www      6055: ol#LC_MenuBreadcrumbs li, 
                   6056: ol#LC_PathBreadcrumbs li, 
1.862     bisitz   6057: ul.LC_CourseBreadcrumbs li {
1.842     droeschl 6058:     display: inline;
                   6059:     white-space: nowrap;
1.693     droeschl 6060: }
                   6061: 
1.823     bisitz   6062: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6063: ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 6064: 	text-decoration: none;
                   6065: 	font-size:90%;
                   6066: }
1.795     www      6067: 
                   6068: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6069: 	text-decoration:none;
                   6070: 	font-size:100%;
                   6071: 	font-weight:bold;
1.693     droeschl 6072: }
1.795     www      6073: 
1.840     bisitz   6074: .LC_Box {
1.835     bisitz   6075:     border: solid 1px $lg_border_color;
                   6076:     padding: 0 10px 10px 10px;
1.746     neumanie 6077: }
1.795     www      6078: 
                   6079: .LC_AboutMe_Image {
1.747     neumanie 6080: 	float:left;
                   6081: 	margin-right:10px;
                   6082: }
1.795     www      6083: 
                   6084: .LC_Clear_AboutMe_Image {
1.747     neumanie 6085: 	clear:left;
                   6086: }
1.795     www      6087: 
1.721     harmsja  6088: dl.LC_ListStyleClean dt {
1.693     droeschl 6089: 	padding-right: 5px;
                   6090: 	display: table-header-group;
                   6091: }
                   6092: 
1.721     harmsja  6093: dl.LC_ListStyleClean dd {
1.693     droeschl 6094: 	display: table-row;
                   6095: }
                   6096: 
1.721     harmsja  6097: .LC_ListStyleClean,
                   6098: .LC_ListStyleSimple,
                   6099: .LC_ListStyleNormal,
1.777     tempelho 6100: .LC_ListStyle_Border,
1.795     www      6101: .LC_ListStyleSpecial {
1.693     droeschl 6102: 	/*display:block;	*/
                   6103: 	list-style-position: inside;
                   6104: 	list-style-type: none;
                   6105: 	overflow: hidden;
1.803     bisitz   6106: 	padding: 0;
1.693     droeschl 6107: }
                   6108: 
1.721     harmsja  6109: .LC_ListStyleSimple li,
                   6110: .LC_ListStyleSimple dd,
                   6111: .LC_ListStyleNormal li,
                   6112: .LC_ListStyleNormal dd,
                   6113: .LC_ListStyleSpecial li,
1.795     www      6114: .LC_ListStyleSpecial dd {
1.803     bisitz   6115: 	margin: 0;
1.693     droeschl 6116: 	padding: 5px 5px 5px 10px;
                   6117: 	clear: both;
                   6118: }
                   6119: 
1.721     harmsja  6120: .LC_ListStyleClean li,
                   6121: .LC_ListStyleClean dd {
1.803     bisitz   6122: 	padding-top: 0;
                   6123: 	padding-bottom: 0;
1.693     droeschl 6124: }
                   6125: 
1.721     harmsja  6126: .LC_ListStyleSimple dd,
1.795     www      6127: .LC_ListStyleSimple li {
1.698     harmsja  6128: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6129: }
                   6130: 
1.721     harmsja  6131: .LC_ListStyleSpecial li,
                   6132: .LC_ListStyleSpecial dd {
1.693     droeschl 6133: 	list-style-type: none;
                   6134: 	background-color: RGB(220, 220, 220);
                   6135: 	margin-bottom: 4px;
                   6136: }
                   6137: 
1.721     harmsja  6138: table.LC_SimpleTable {
1.698     harmsja  6139: 	margin:5px;
                   6140: 	border:solid 1px $lg_border_color;
1.795     www      6141: }
1.693     droeschl 6142: 
1.721     harmsja  6143: table.LC_SimpleTable tr {
1.803     bisitz   6144: 	padding: 0;
1.698     harmsja  6145: 	border:solid 1px $lg_border_color;
1.693     droeschl 6146: }
1.795     www      6147: 
                   6148: table.LC_SimpleTable thead {
1.698     harmsja  6149: 	 background:rgb(220,220,220);
1.693     droeschl 6150: }
                   6151: 
1.721     harmsja  6152: div.LC_columnSection {
1.693     droeschl 6153: 	display: block;
                   6154: 	clear: both;
                   6155: 	overflow: hidden;
1.803     bisitz   6156: 	margin: 0;
1.693     droeschl 6157: }
                   6158: 
1.721     harmsja  6159: div.LC_columnSection>* {
1.693     droeschl 6160: 	float: left;
1.803     bisitz   6161: 	margin: 10px 20px 10px 0;
1.747     neumanie 6162: 	overflow:hidden;
1.693     droeschl 6163: }
1.721     harmsja  6164: 
1.694     tempelho 6165: .LC_loginpage_container {
                   6166: 	text-align:left;
                   6167: 	margin : 0 auto;
1.785     tempelho 6168: 	width:90%;
1.694     tempelho 6169: 	padding: 10px;
                   6170: 	height: auto;
1.712     muellerd 6171: 	background-color:#FFFFFF;
1.694     tempelho 6172: 	border:1px solid #CCCCCC;
                   6173: }
                   6174: 
                   6175: 
                   6176: .LC_loginpage_loginContainer {
                   6177: 	float:left;
1.712     muellerd 6178: 	width: 182px;
1.785     tempelho 6179: 	padding: 2px;
1.712     muellerd 6180: 	border:1px solid #CCCCCC;
                   6181: 	background-color:$loginbg;
1.694     tempelho 6182: }
                   6183: 
1.795     www      6184: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6185: 	margin-top: 0;
1.712     muellerd 6186: 	display:block;
                   6187: 	background:$bgcol;
                   6188: 	color:$textcol;
                   6189: 	padding-left:5px;
                   6190: }
1.785     tempelho 6191: 
1.694     tempelho 6192: .LC_loginpage_loginInfo {
                   6193: 	float:left;
1.785     tempelho 6194: 	width:182px;
1.694     tempelho 6195: 	border:1px solid #CCCCCC;
1.785     tempelho 6196: 	padding:2px;
1.712     muellerd 6197: }
                   6198: 
1.694     tempelho 6199: .LC_loginpage_space {
1.754     droeschl 6200: 	clear: both;
                   6201: 	margin-bottom: 20px;
1.694     tempelho 6202: 	border-bottom: 1px solid #CCCCCC;
                   6203: }
                   6204: 
1.785     tempelho 6205: .LC_loginpage_floatLeft {
                   6206: 	float: left;
                   6207: 	width: 200px;
                   6208: 	margin: 0;
                   6209: }
                   6210: 
1.795     www      6211: table em {
1.754     droeschl 6212: 	font-weight: bold;
                   6213: 	font-style: normal;
1.748     schulted 6214: }
1.795     www      6215: 
1.779     bisitz   6216: table.LC_tableBrowseRes,
1.795     www      6217: table.LC_tableOfContent {
1.769     schulted 6218:         border:none;
1.858     bisitz   6219: 	border-spacing: 1px;
1.754     droeschl 6220: 	padding: 3px;
                   6221: 	background-color: #FFFFFF;
                   6222: 	font-size: 90%;
1.753     droeschl 6223: }
1.789     droeschl 6224: 
                   6225: table.LC_tableOfContent{
                   6226:     border-collapse: collapse;
                   6227: }
                   6228: 
1.771     droeschl 6229: table.LC_tableBrowseRes a,
1.768     schulted 6230: table.LC_tableOfContent a {
1.771     droeschl 6231:         background-color: transparent;
1.753     droeschl 6232: 	text-decoration: none;
                   6233: }
                   6234: 
1.771     droeschl 6235: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6236: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6237: 	background-color: #EEEEEE;
1.753     droeschl 6238: }
                   6239: 
1.795     www      6240: table.LC_tableOfContent img {
1.753     droeschl 6241: 	border: none;
                   6242: 	height: 1.3em;
                   6243: 	vertical-align: text-bottom;
                   6244: 	margin-right: 0.3em;
                   6245: }
1.757     schulted 6246: 
1.795     www      6247: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6248: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6249: }
                   6250: 
1.795     www      6251: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6252: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6253: }
                   6254: 
1.795     www      6255: a#LC_content_toolbar_closenav {
1.774     ehlerst  6256: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6257: }
                   6258: 
1.795     www      6259: a#LC_content_toolbar_everything {
1.774     ehlerst  6260: 	background-image:url(/res/adm/pages/show-all.gif);
                   6261: }
                   6262: 
1.795     www      6263: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6264: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6265: }
                   6266: 
1.795     www      6267: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6268: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6269: }
                   6270: 
1.795     www      6271: a#LC_content_toolbar_changefolder {
1.757     schulted 6272: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6273: }
                   6274: 
1.795     www      6275: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6276: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6277: }
                   6278: 
1.795     www      6279: ul#LC_toolbar li a:hover {
1.757     schulted 6280: 	background-position: bottom center;
                   6281: }
                   6282: 
1.795     www      6283: ul#LC_toolbar {
1.803     bisitz   6284: 	padding: 0;
1.757     schulted 6285: 	margin: 2px;
                   6286: 	list-style:none;
                   6287: 	position:relative;
                   6288: 	background-color:white;
                   6289: }
                   6290: 
1.795     www      6291: ul#LC_toolbar li {
1.757     schulted 6292: 	border:1px solid white;
1.803     bisitz   6293: 	padding: 0;
1.757     schulted 6294: 	margin: 0;
1.795     www      6295:         float: left;
1.767     droeschl 6296: 	display:inline;
1.757     schulted 6297: 	vertical-align:middle;
1.795     www      6298: } 
1.757     schulted 6299: 
1.783     amueller 6300: 
1.795     www      6301: a.LC_toolbarItem {
1.767     droeschl 6302: 	display:block;
1.803     bisitz   6303: 	padding: 0;
                   6304: 	margin: 0;
1.757     schulted 6305: 	height: 32px;
                   6306: 	width: 32px;
1.779     bisitz   6307: 	color:white;
1.803     bisitz   6308: 	border: none;
1.757     schulted 6309: 	background-repeat:no-repeat;
                   6310: 	background-color:transparent;
                   6311: }
                   6312: 
1.843     bisitz   6313: ul.LC_funclist li {
1.782     bisitz   6314:   float: left;
                   6315:   white-space: nowrap;
                   6316:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6317:   margin: 0 15px 15px 10px;
1.782     bisitz   6318: }
                   6319: 
1.757     schulted 6320: 
1.343     albertel 6321: END
                   6322: }
                   6323: 
1.306     albertel 6324: =pod
                   6325: 
                   6326: =item * &headtag()
                   6327: 
                   6328: Returns a uniform footer for LON-CAPA web pages.
                   6329: 
1.307     albertel 6330: Inputs: $title - optional title for the head
                   6331:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6332:         $args - optional arguments
1.319     albertel 6333:             force_register - if is true call registerurl so the remote is 
                   6334:                              informed
1.415     albertel 6335:             redirect       -> array ref of
                   6336:                                    1- seconds before redirect occurs
                   6337:                                    2- url to redirect to
                   6338:                                    3- whether the side effect should occur
1.315     albertel 6339:                            (side effect of setting 
                   6340:                                $env{'internal.head.redirect'} to the url 
                   6341:                                redirected too)
1.352     albertel 6342:             domain         -> force to color decorate a page for a specific
                   6343:                                domain
                   6344:             function       -> force usage of a specific rolish color scheme
                   6345:             bgcolor        -> override the default page bgcolor
1.460     albertel 6346:             no_auto_mt_title
                   6347:                            -> prevent &mt()ing the title arg
1.464     albertel 6348: 
1.306     albertel 6349: =cut
                   6350: 
                   6351: sub headtag {
1.313     albertel 6352:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6353:     
1.363     albertel 6354:     my $function = $args->{'function'} || &get_users_function();
                   6355:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6356:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6357:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6358: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6359: 		   #time(),
1.418     albertel 6360: 		   $env{'environment.color.timestamp'},
1.363     albertel 6361: 		   $function,$domain,$bgcolor);
                   6362: 
1.369     www      6363:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6364: 
1.308     albertel 6365:     my $result =
                   6366: 	'<head>'.
1.461     albertel 6367: 	&font_settings();
1.319     albertel 6368: 
1.461     albertel 6369:     if (!$args->{'frameset'}) {
                   6370: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6371:     }
1.319     albertel 6372:     if ($args->{'force_register'}) {
                   6373: 	$result .= &Apache::lonmenu::registerurl(1);
                   6374:     }
1.436     albertel 6375:     if (!$args->{'no_nav_bar'} 
                   6376: 	&& !$args->{'only_body'}
                   6377: 	&& !$args->{'frameset'}) {
                   6378: 	$result .= &help_menu_js();
                   6379:     }
1.319     albertel 6380: 
1.314     albertel 6381:     if (ref($args->{'redirect'})) {
1.414     albertel 6382: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6383: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6384: 	if (!$inhibit_continue) {
                   6385: 	    $env{'internal.head.redirect'} = $url;
                   6386: 	}
1.313     albertel 6387: 	$result.=<<ADDMETA
                   6388: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6389: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6390: ADDMETA
                   6391:     }
1.306     albertel 6392:     if (!defined($title)) {
                   6393: 	$title = 'The LearningOnline Network with CAPA';
                   6394:     }
1.460     albertel 6395:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6396:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6397: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6398: 	.$head_extra;
1.306     albertel 6399:     return $result;
                   6400: }
                   6401: 
                   6402: =pod
                   6403: 
1.340     albertel 6404: =item * &font_settings()
                   6405: 
                   6406: Returns neccessary <meta> to set the proper encoding
                   6407: 
                   6408: Inputs: none
                   6409: 
                   6410: =cut
                   6411: 
                   6412: sub font_settings {
                   6413:     my $headerstring='';
1.647     www      6414:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6415: 	$headerstring.=
                   6416: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6417:     }
                   6418:     return $headerstring;
                   6419: }
                   6420: 
1.341     albertel 6421: =pod
                   6422: 
                   6423: =item * &xml_begin()
                   6424: 
                   6425: Returns the needed doctype and <html>
                   6426: 
                   6427: Inputs: none
                   6428: 
                   6429: =cut
                   6430: 
                   6431: sub xml_begin {
                   6432:     my $output='';
                   6433: 
1.592     albertel 6434:     if ($env{'internal.start_page'}==1) {
                   6435: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6436:     }
1.342     albertel 6437: 
1.341     albertel 6438:     if ($env{'browser.mathml'}) {
                   6439: 	$output='<?xml version="1.0"?>'
                   6440:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6441: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6442:             
                   6443: #	    .'<!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">] >'
                   6444: 	    .'<!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">'
                   6445:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6446: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6447:     } else {
1.849     bisitz   6448: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6449:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6450:     }
                   6451:     return $output;
                   6452: }
1.340     albertel 6453: 
                   6454: =pod
                   6455: 
1.306     albertel 6456: =item * &endheadtag()
                   6457: 
                   6458: Returns a uniform </head> for LON-CAPA web pages.
                   6459: 
                   6460: Inputs: none
                   6461: 
                   6462: =cut
                   6463: 
                   6464: sub endheadtag {
                   6465:     return '</head>';
                   6466: }
                   6467: 
                   6468: =pod
                   6469: 
                   6470: =item * &head()
                   6471: 
                   6472: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6473: 
1.648     raeburn  6474: Inputs:
                   6475: 
                   6476: =over 4
                   6477: 
                   6478: $title - optional title for the page
                   6479: 
                   6480: $head_extra - optional extra HTML to put inside the <head>
                   6481: 
                   6482: =back
1.405     albertel 6483: 
1.306     albertel 6484: =cut
                   6485: 
                   6486: sub head {
1.325     albertel 6487:     my ($title,$head_extra,$args) = @_;
                   6488:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6489: }
                   6490: 
                   6491: =pod
                   6492: 
                   6493: =item * &start_page()
                   6494: 
                   6495: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6496: 
1.648     raeburn  6497: Inputs:
                   6498: 
                   6499: =over 4
                   6500: 
                   6501: $title - optional title for the page
                   6502: 
                   6503: $head_extra - optional extra HTML to incude inside the <head>
                   6504: 
                   6505: $args - additional optional args supported are:
                   6506: 
                   6507: =over 8
                   6508: 
                   6509:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6510:                                     arg on
1.814     bisitz   6511:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6512:              add_entries    -> additional attributes to add to the  <body>
                   6513:              domain         -> force to color decorate a page for a 
1.317     albertel 6514:                                     specific domain
1.648     raeburn  6515:              function       -> force usage of a specific rolish color
1.317     albertel 6516:                                     scheme
1.648     raeburn  6517:              redirect       -> see &headtag()
                   6518:              bgcolor        -> override the default page bg color
                   6519:              js_ready       -> return a string ready for being used in 
1.317     albertel 6520:                                     a javascript writeln
1.648     raeburn  6521:              html_encode    -> return a string ready for being used in 
1.320     albertel 6522:                                     a html attribute
1.648     raeburn  6523:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6524:                                     $forcereg arg
1.648     raeburn  6525:              frameset       -> if true will start with a <frameset>
1.330     albertel 6526:                                     rather than <body>
1.648     raeburn  6527:              skip_phases    -> hash ref of 
1.338     albertel 6528:                                     head -> skip the <html><head> generation
                   6529:                                     body -> skip all <body> generation
1.648     raeburn  6530:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6531:                                     'Switch To Inline Menu' link
1.648     raeburn  6532:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6533:              inherit_jsmath -> when creating popup window in a page,
                   6534:                                     should it have jsmath forced on by the
                   6535:                                     current page
1.867     kalberla 6536:              bread_crumbs ->             Array containing breadcrumbs
                   6537:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6538: 
1.648     raeburn  6539: =back
1.460     albertel 6540: 
1.648     raeburn  6541: =back
1.562     albertel 6542: 
1.306     albertel 6543: =cut
                   6544: 
                   6545: sub start_page {
1.309     albertel 6546:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6547:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6548:     my %head_args;
1.352     albertel 6549:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6550: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6551: 		     'no_auto_mt_title') {
1.319     albertel 6552: 	if (defined($args->{$arg})) {
1.324     raeburn  6553: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6554: 	}
1.313     albertel 6555:     }
1.319     albertel 6556: 
1.315     albertel 6557:     $env{'internal.start_page'}++;
1.338     albertel 6558:     my $result;
                   6559:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6560: 	$result.=
1.341     albertel 6561: 	    &xml_begin().
1.338     albertel 6562: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6563:     }
                   6564:     
                   6565:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6566: 	if ($args->{'frameset'}) {
                   6567: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6568: 						$args->{'add_entries'});
                   6569: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6570:         } else {
                   6571:             $result .=
                   6572:                 &bodytag($title, 
                   6573:                          $args->{'function'},       $args->{'add_entries'},
                   6574:                          $args->{'only_body'},      $args->{'domain'},
                   6575:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6576:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6577:                          $args);
                   6578:         }
1.330     albertel 6579:     }
1.338     albertel 6580: 
1.315     albertel 6581:     if ($args->{'js_ready'}) {
1.713     kaisler  6582: 		$result = &js_ready($result);
1.315     albertel 6583:     }
1.320     albertel 6584:     if ($args->{'html_encode'}) {
1.713     kaisler  6585: 		$result = &html_encode($result);
                   6586:     }
                   6587: 
1.813     bisitz   6588:     # Preparation for new and consistent functionlist at top of screen
                   6589:     # if ($args->{'functionlist'}) {
                   6590:     #            $result .= &build_functionlist();
                   6591:     #}
                   6592: 
                   6593:     # Don't add anything more if only_body wanted
                   6594:     return $result if $args->{'only_body'};
                   6595: 
                   6596:     #Breadcrumbs
1.758     kaisler  6597:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6598: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6599: 		#if any br links exists, add them to the breadcrumbs
                   6600: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6601: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6602: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6603: 			}
                   6604: 		}
                   6605: 
                   6606: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6607: 		if(exists($args->{'bread_crumbs_component'})){
                   6608: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6609: 		}else{
                   6610: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6611: 		}
1.320     albertel 6612:     }
1.315     albertel 6613:     return $result;
1.306     albertel 6614: }
                   6615: 
1.330     albertel 6616: 
1.306     albertel 6617: =pod
                   6618: 
                   6619: =item * &head()
                   6620: 
                   6621: Returns a complete </body></html> section for LON-CAPA web pages.
                   6622: 
1.315     albertel 6623: Inputs:         $args - additional optional args supported are:
                   6624:                  js_ready     -> return a string ready for being used in 
                   6625:                                  a javascript writeln
1.320     albertel 6626:                  html_encode  -> return a string ready for being used in 
                   6627:                                  a html attribute
1.330     albertel 6628:                  frameset     -> if true will start with a <frameset>
                   6629:                                  rather than <body>
1.493     albertel 6630:                  dicsussion   -> if true will get discussion from
                   6631:                                   lonxml::xmlend
                   6632:                                  (you can pass the target and parser arguments
                   6633:                                   through optional 'target' and 'parser' args
                   6634:                                   to this routine)
1.306     albertel 6635: 
                   6636: =cut
                   6637: 
                   6638: sub end_page {
1.315     albertel 6639:     my ($args) = @_;
                   6640:     $env{'internal.end_page'}++;
1.330     albertel 6641:     my $result;
1.335     albertel 6642:     if ($args->{'discussion'}) {
                   6643: 	my ($target,$parser);
                   6644: 	if (ref($args->{'discussion'})) {
                   6645: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6646: 				$args->{'discussion'}{'parser'});
                   6647: 	}
                   6648: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6649:     }
                   6650: 
1.330     albertel 6651:     if ($args->{'frameset'}) {
                   6652: 	$result .= '</frameset>';
                   6653:     } else {
1.635     raeburn  6654: 	$result .= &endbodytag($args);
1.330     albertel 6655:     }
                   6656:     $result .= "\n</html>";
                   6657: 
1.315     albertel 6658:     if ($args->{'js_ready'}) {
1.317     albertel 6659: 	$result = &js_ready($result);
1.315     albertel 6660:     }
1.335     albertel 6661: 
1.320     albertel 6662:     if ($args->{'html_encode'}) {
                   6663: 	$result = &html_encode($result);
                   6664:     }
1.335     albertel 6665: 
1.315     albertel 6666:     return $result;
                   6667: }
                   6668: 
1.320     albertel 6669: sub html_encode {
                   6670:     my ($result) = @_;
                   6671: 
1.322     albertel 6672:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6673:     
                   6674:     return $result;
                   6675: }
1.317     albertel 6676: sub js_ready {
                   6677:     my ($result) = @_;
                   6678: 
1.323     albertel 6679:     $result =~ s/[\n\r]/ /xmsg;
                   6680:     $result =~ s/\\/\\\\/xmsg;
                   6681:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6682:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6683:     
                   6684:     return $result;
                   6685: }
                   6686: 
1.315     albertel 6687: sub validate_page {
                   6688:     if (  exists($env{'internal.start_page'})
1.316     albertel 6689: 	  &&     $env{'internal.start_page'} > 1) {
                   6690: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6691: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6692: 				 $ENV{'request.filename'});
1.315     albertel 6693:     }
                   6694:     if (  exists($env{'internal.end_page'})
1.316     albertel 6695: 	  &&     $env{'internal.end_page'} > 1) {
                   6696: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6697: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6698: 				 $env{'request.filename'});
1.315     albertel 6699:     }
                   6700:     if (     exists($env{'internal.start_page'})
                   6701: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6702: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6703: 				 $env{'request.filename'});
1.315     albertel 6704:     }
                   6705:     if (   ! exists($env{'internal.start_page'})
                   6706: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6707: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6708: 				 $env{'request.filename'});
1.315     albertel 6709:     }
1.306     albertel 6710: }
1.315     albertel 6711: 
1.318     albertel 6712: sub simple_error_page {
                   6713:     my ($r,$title,$msg) = @_;
                   6714:     my $page =
                   6715: 	&Apache::loncommon::start_page($title).
                   6716: 	&mt($msg).
                   6717: 	&Apache::loncommon::end_page();
                   6718:     if (ref($r)) {
                   6719: 	$r->print($page);
1.327     albertel 6720: 	return;
1.318     albertel 6721:     }
                   6722:     return $page;
                   6723: }
1.347     albertel 6724: 
                   6725: {
1.610     albertel 6726:     my @row_count;
1.347     albertel 6727:     sub start_data_table {
1.422     albertel 6728: 	my ($add_class) = @_;
                   6729: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6730: 	unshift(@row_count,0);
1.422     albertel 6731: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6732:     }
                   6733: 
                   6734:     sub end_data_table {
1.610     albertel 6735: 	shift(@row_count);
1.389     albertel 6736: 	return '</table>'."\n";;
1.347     albertel 6737:     }
                   6738: 
                   6739:     sub start_data_table_row {
1.422     albertel 6740: 	my ($add_class) = @_;
1.610     albertel 6741: 	$row_count[0]++;
                   6742: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428     albertel 6743: 	$css_class = (join(' ',$css_class,$add_class));
1.422     albertel 6744: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6745:     }
1.471     banghart 6746:     
                   6747:     sub continue_data_table_row {
                   6748: 	my ($add_class) = @_;
1.610     albertel 6749: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471     banghart 6750: 	$css_class = (join(' ',$css_class,$add_class));
                   6751: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6752:     }
1.347     albertel 6753: 
                   6754:     sub end_data_table_row {
1.389     albertel 6755: 	return '</tr>'."\n";;
1.347     albertel 6756:     }
1.367     www      6757: 
1.421     albertel 6758:     sub start_data_table_empty_row {
1.707     bisitz   6759: #	$row_count[0]++;
1.421     albertel 6760: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6761:     }
                   6762: 
                   6763:     sub end_data_table_empty_row {
                   6764: 	return '</tr>'."\n";;
                   6765:     }
                   6766: 
1.367     www      6767:     sub start_data_table_header_row {
1.389     albertel 6768: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6769:     }
                   6770: 
                   6771:     sub end_data_table_header_row {
1.389     albertel 6772: 	return '</tr>'."\n";;
1.367     www      6773:     }
1.347     albertel 6774: }
                   6775: 
1.548     albertel 6776: =pod
                   6777: 
                   6778: =item * &inhibit_menu_check($arg)
                   6779: 
                   6780: Checks for a inhibitmenu state and generates output to preserve it
                   6781: 
                   6782: Inputs:         $arg - can be any of
                   6783:                      - undef - in which case the return value is a string 
                   6784:                                to add  into arguments list of a uri
                   6785:                      - 'input' - in which case the return value is a HTML
                   6786:                                  <form> <input> field of type hidden to
                   6787:                                  preserve the value
                   6788:                      - a url - in which case the return value is the url with
                   6789:                                the neccesary cgi args added to preserve the
                   6790:                                inhibitmenu state
                   6791:                      - a ref to a url - no return value, but the string is
                   6792:                                         updated to include the neccessary cgi
                   6793:                                         args to preserve the inhibitmenu state
                   6794: 
                   6795: =cut
                   6796: 
                   6797: sub inhibit_menu_check {
                   6798:     my ($arg) = @_;
                   6799:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6800:     if ($arg eq 'input') {
                   6801: 	if ($env{'form.inhibitmenu'}) {
                   6802: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6803: 	} else {
                   6804: 	    return
                   6805: 	}
                   6806:     }
                   6807:     if ($env{'form.inhibitmenu'}) {
                   6808: 	if (ref($arg)) {
                   6809: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6810: 	} elsif ($arg eq '') {
                   6811: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6812: 	} else {
                   6813: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6814: 	}
                   6815:     }
                   6816:     if (!ref($arg)) {
                   6817: 	return $arg;
                   6818:     }
                   6819: }
                   6820: 
1.251     albertel 6821: ###############################################
1.182     matthew  6822: 
                   6823: =pod
                   6824: 
1.549     albertel 6825: =back
                   6826: 
                   6827: =head1 User Information Routines
                   6828: 
                   6829: =over 4
                   6830: 
1.405     albertel 6831: =item * &get_users_function()
1.182     matthew  6832: 
                   6833: Used by &bodytag to determine the current users primary role.
                   6834: Returns either 'student','coordinator','admin', or 'author'.
                   6835: 
                   6836: =cut
                   6837: 
                   6838: ###############################################
                   6839: sub get_users_function {
1.815     tempelho 6840:     my $function = 'norole';
1.818     tempelho 6841:     if ($env{'request.role'}=~/^(st)/) {
                   6842:         $function='student';
                   6843:     }
1.258     albertel 6844:     if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182     matthew  6845:         $function='coordinator';
                   6846:     }
1.258     albertel 6847:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6848:         $function='admin';
                   6849:     }
1.826     bisitz   6850:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6851:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6852:         $function='author';
                   6853:     }
                   6854:     return $function;
1.54      www      6855: }
1.99      www      6856: 
                   6857: ###############################################
                   6858: 
1.233     raeburn  6859: =pod
                   6860: 
1.821     raeburn  6861: =item * &show_course()
                   6862: 
                   6863: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6864: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6865: 
                   6866: Inputs:
                   6867: None
                   6868: 
                   6869: Outputs:
                   6870: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6871: 
                   6872: =cut
                   6873: 
                   6874: ###############################################
                   6875: sub show_course {
                   6876:     my $course = !$env{'user.adv'};
                   6877:     if (!$env{'user.adv'}) {
                   6878:         foreach my $env (keys(%env)) {
                   6879:             next if ($env !~ m/^user\.priv\./);
                   6880:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6881:                 $course = 0;
                   6882:                 last;
                   6883:             }
                   6884:         }
                   6885:     }
                   6886:     return $course;
                   6887: }
                   6888: 
                   6889: ###############################################
                   6890: 
                   6891: =pod
                   6892: 
1.542     raeburn  6893: =item * &check_user_status()
1.274     raeburn  6894: 
                   6895: Determines current status of supplied role for a
                   6896: specific user. Roles can be active, previous or future.
                   6897: 
                   6898: Inputs: 
                   6899: user's domain, user's username, course's domain,
1.375     raeburn  6900: course's number, optional section ID.
1.274     raeburn  6901: 
                   6902: Outputs:
                   6903: role status: active, previous or future. 
                   6904: 
                   6905: =cut
                   6906: 
                   6907: sub check_user_status {
1.412     raeburn  6908:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6909:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6910:     my @uroles = keys %userinfo;
                   6911:     my $srchstr;
                   6912:     my $active_chk = 'none';
1.412     raeburn  6913:     my $now = time;
1.274     raeburn  6914:     if (@uroles > 0) {
1.412     raeburn  6915:         if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6916:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6917:         } else {
1.412     raeburn  6918:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6919:         }
                   6920:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6921:             my $role_end = 0;
                   6922:             my $role_start = 0;
                   6923:             $active_chk = 'active';
1.412     raeburn  6924:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6925:                 $role_end = $1;
                   6926:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6927:                     $role_start = $1;
1.274     raeburn  6928:                 }
                   6929:             }
                   6930:             if ($role_start > 0) {
1.412     raeburn  6931:                 if ($now < $role_start) {
1.274     raeburn  6932:                     $active_chk = 'future';
                   6933:                 }
                   6934:             }
                   6935:             if ($role_end > 0) {
1.412     raeburn  6936:                 if ($now > $role_end) {
1.274     raeburn  6937:                     $active_chk = 'previous';
                   6938:                 }
                   6939:             }
                   6940:         }
                   6941:     }
                   6942:     return $active_chk;
                   6943: }
                   6944: 
                   6945: ###############################################
                   6946: 
                   6947: =pod
                   6948: 
1.405     albertel 6949: =item * &get_sections()
1.233     raeburn  6950: 
                   6951: Determines all the sections for a course including
                   6952: sections with students and sections containing other roles.
1.419     raeburn  6953: Incoming parameters: 
                   6954: 
                   6955: 1. domain
                   6956: 2. course number 
                   6957: 3. reference to array containing roles for which sections should 
                   6958: be gathered (optional).
                   6959: 4. reference to array containing status types for which sections 
                   6960: should be gathered (optional).
                   6961: 
                   6962: If the third argument is undefined, sections are gathered for any role. 
                   6963: If the fourth argument is undefined, sections are gathered for any status.
                   6964: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  6965:  
1.374     raeburn  6966: Returns section hash (keys are section IDs, values are
                   6967: number of users in each section), subject to the
1.419     raeburn  6968: optional roles filter, optional status filter 
1.233     raeburn  6969: 
                   6970: =cut
                   6971: 
                   6972: ###############################################
                   6973: sub get_sections {
1.419     raeburn  6974:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 6975:     if (!defined($cdom) || !defined($cnum)) {
                   6976:         my $cid =  $env{'request.course.id'};
                   6977: 
                   6978: 	return if (!defined($cid));
                   6979: 
                   6980:         $cdom = $env{'course.'.$cid.'.domain'};
                   6981:         $cnum = $env{'course.'.$cid.'.num'};
                   6982:     }
                   6983: 
                   6984:     my %sectioncount;
1.419     raeburn  6985:     my $now = time;
1.240     albertel 6986: 
1.366     albertel 6987:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 6988: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 6989: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   6990: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  6991:         my $start_index = &Apache::loncoursedata::CL_START();
                   6992:         my $end_index = &Apache::loncoursedata::CL_END();
                   6993:         my $status;
1.366     albertel 6994: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  6995: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   6996: 				                     $data->[$status_index],
                   6997:                                                      $data->[$start_index],
                   6998:                                                      $data->[$end_index]);
                   6999:             if ($stu_status eq 'Active') {
                   7000:                 $status = 'active';
                   7001:             } elsif ($end < $now) {
                   7002:                 $status = 'previous';
                   7003:             } elsif ($start > $now) {
                   7004:                 $status = 'future';
                   7005:             } 
                   7006: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7007:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7008:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7009: 		    $sectioncount{$section}++;
                   7010:                 }
1.240     albertel 7011: 	    }
                   7012: 	}
                   7013:     }
                   7014:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7015:     foreach my $user (sort(keys(%courseroles))) {
                   7016: 	if ($user !~ /^(\w{2})/) { next; }
                   7017: 	my ($role) = ($user =~ /^(\w{2})/);
                   7018: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7019: 	my ($section,$status);
1.240     albertel 7020: 	if ($role eq 'cr' &&
                   7021: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7022: 	    $section=$1;
                   7023: 	}
                   7024: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7025: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7026:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7027:         if ($end == -1 && $start == -1) {
                   7028:             next; #deleted role
                   7029:         }
                   7030:         if (!defined($possible_status)) { 
                   7031:             $sectioncount{$section}++;
                   7032:         } else {
                   7033:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7034:                 $status = 'active';
                   7035:             } elsif ($end < $now) {
                   7036:                 $status = 'future';
                   7037:             } elsif ($start > $now) {
                   7038:                 $status = 'previous';
                   7039:             }
                   7040:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7041:                 $sectioncount{$section}++;
                   7042:             }
                   7043:         }
1.233     raeburn  7044:     }
1.366     albertel 7045:     return %sectioncount;
1.233     raeburn  7046: }
                   7047: 
1.274     raeburn  7048: ###############################################
1.294     raeburn  7049: 
                   7050: =pod
1.405     albertel 7051: 
                   7052: =item * &get_course_users()
                   7053: 
1.275     raeburn  7054: Retrieves usernames:domains for users in the specified course
                   7055: with specific role(s), and access status. 
                   7056: 
                   7057: Incoming parameters:
1.277     albertel 7058: 1. course domain
                   7059: 2. course number
                   7060: 3. access status: users must have - either active, 
1.275     raeburn  7061: previous, future, or all.
1.277     albertel 7062: 4. reference to array of permissible roles
1.288     raeburn  7063: 5. reference to array of section restrictions (optional)
                   7064: 6. reference to results object (hash of hashes).
                   7065: 7. reference to optional userdata hash
1.609     raeburn  7066: 8. reference to optional statushash
1.630     raeburn  7067: 9. flag if privileged users (except those set to unhide in
                   7068:    course settings) should be excluded    
1.609     raeburn  7069: Keys of top level results hash are roles.
1.275     raeburn  7070: Keys of inner hashes are username:domain, with 
                   7071: values set to access type.
1.288     raeburn  7072: Optional userdata hash returns an array with arguments in the 
                   7073: same order as loncoursedata::get_classlist() for student data.
                   7074: 
1.609     raeburn  7075: Optional statushash returns
                   7076: 
1.288     raeburn  7077: Entries for end, start, section and status are blank because
                   7078: of the possibility of multiple values for non-student roles.
                   7079: 
1.275     raeburn  7080: =cut
1.405     albertel 7081: 
1.275     raeburn  7082: ###############################################
1.405     albertel 7083: 
1.275     raeburn  7084: sub get_course_users {
1.630     raeburn  7085:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7086:     my %idx = ();
1.419     raeburn  7087:     my %seclists;
1.288     raeburn  7088: 
                   7089:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7090:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7091:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7092:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7093:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7094:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7095:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7096:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7097: 
1.290     albertel 7098:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7099:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7100:         my $now = time;
1.277     albertel 7101:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7102:             my $match = 0;
1.412     raeburn  7103:             my $secmatch = 0;
1.419     raeburn  7104:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7105:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7106:             if ($section eq '') {
                   7107:                 $section = 'none';
                   7108:             }
1.291     albertel 7109:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7110:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7111:                     $secmatch = 1;
                   7112:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7113:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7114:                         $secmatch = 1;
                   7115:                     }
                   7116:                 } else {  
1.419     raeburn  7117: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7118: 		        $secmatch = 1;
                   7119:                     }
1.290     albertel 7120: 		}
1.412     raeburn  7121:                 if (!$secmatch) {
                   7122:                     next;
                   7123:                 }
1.419     raeburn  7124:             }
1.275     raeburn  7125:             if (defined($$types{'active'})) {
1.288     raeburn  7126:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7127:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7128:                     $match = 1;
1.275     raeburn  7129:                 }
                   7130:             }
                   7131:             if (defined($$types{'previous'})) {
1.609     raeburn  7132:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7133:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7134:                     $match = 1;
1.275     raeburn  7135:                 }
                   7136:             }
                   7137:             if (defined($$types{'future'})) {
1.609     raeburn  7138:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7139:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7140:                     $match = 1;
1.275     raeburn  7141:                 }
                   7142:             }
1.609     raeburn  7143:             if ($match) {
                   7144:                 push(@{$seclists{$student}},$section);
                   7145:                 if (ref($userdata) eq 'HASH') {
                   7146:                     $$userdata{$student} = $$classlist{$student};
                   7147:                 }
                   7148:                 if (ref($statushash) eq 'HASH') {
                   7149:                     $statushash->{$student}{'st'}{$section} = $status;
                   7150:                 }
1.288     raeburn  7151:             }
1.275     raeburn  7152:         }
                   7153:     }
1.412     raeburn  7154:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7155:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7156:         my $now = time;
1.609     raeburn  7157:         my %displaystatus = ( previous => 'Expired',
                   7158:                               active   => 'Active',
                   7159:                               future   => 'Future',
                   7160:                             );
1.630     raeburn  7161:         my %nothide;
                   7162:         if ($hidepriv) {
                   7163:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7164:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7165:                 if ($user !~ /:/) {
                   7166:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7167:                 } else {
                   7168:                     $nothide{$user} = 1;
                   7169:                 }
                   7170:             }
                   7171:         }
1.439     raeburn  7172:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7173:             my $match = 0;
1.412     raeburn  7174:             my $secmatch = 0;
1.439     raeburn  7175:             my $status;
1.412     raeburn  7176:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7177:             $user =~ s/:$//;
1.439     raeburn  7178:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7179:             if ($end == -1 || $start == -1) {
                   7180:                 next;
                   7181:             }
                   7182:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7183:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7184:                 my ($uname,$udom) = split(/:/,$user);
                   7185:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7186:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7187:                         $secmatch = 1;
                   7188:                     } elsif ($usec eq '') {
1.420     albertel 7189:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7190:                             $secmatch = 1;
                   7191:                         }
                   7192:                     } else {
                   7193:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7194:                             $secmatch = 1;
                   7195:                         }
                   7196:                     }
                   7197:                     if (!$secmatch) {
                   7198:                         next;
                   7199:                     }
1.288     raeburn  7200:                 }
1.419     raeburn  7201:                 if ($usec eq '') {
                   7202:                     $usec = 'none';
                   7203:                 }
1.275     raeburn  7204:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7205:                     if ($hidepriv) {
                   7206:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7207:                             (!$nothide{$uname.':'.$udom})) {
                   7208:                             next;
                   7209:                         }
                   7210:                     }
1.503     raeburn  7211:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7212:                         $status = 'previous';
                   7213:                     } elsif ($start > $now) {
                   7214:                         $status = 'future';
                   7215:                     } else {
                   7216:                         $status = 'active';
                   7217:                     }
1.277     albertel 7218:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7219:                         if ($status eq $type) {
1.420     albertel 7220:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7221:                                 push(@{$$users{$role}{$user}},$type);
                   7222:                             }
1.288     raeburn  7223:                             $match = 1;
                   7224:                         }
                   7225:                     }
1.419     raeburn  7226:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7227:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7228: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7229:                         }
1.420     albertel 7230:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7231:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7232:                         }
1.609     raeburn  7233:                         if (ref($statushash) eq 'HASH') {
                   7234:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7235:                         }
1.275     raeburn  7236:                     }
                   7237:                 }
                   7238:             }
                   7239:         }
1.290     albertel 7240:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7241:             if ((defined($cdom)) && (defined($cnum))) {
                   7242:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7243:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7244:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7245:                     next if ($owner eq '');
                   7246:                     my ($ownername,$ownerdom);
                   7247:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7248:                         $ownername = $1;
                   7249:                         $ownerdom = $2;
                   7250:                     } else {
                   7251:                         $ownername = $owner;
                   7252:                         $ownerdom = $cdom;
                   7253:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7254:                     }
                   7255:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7256:                     if (defined($userdata) && 
1.609     raeburn  7257: 			!exists($$userdata{$owner})) {
                   7258: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7259:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7260:                             push(@{$seclists{$owner}},'none');
                   7261:                         }
                   7262:                         if (ref($statushash) eq 'HASH') {
                   7263:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7264:                         }
1.290     albertel 7265: 		    }
1.279     raeburn  7266:                 }
                   7267:             }
                   7268:         }
1.419     raeburn  7269:         foreach my $user (keys(%seclists)) {
                   7270:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7271:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7272:         }
1.275     raeburn  7273:     }
                   7274:     return;
                   7275: }
                   7276: 
1.288     raeburn  7277: sub get_user_info {
                   7278:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7279:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7280: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7281:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7282:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7283:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7284:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7285:     return;
                   7286: }
1.275     raeburn  7287: 
1.472     raeburn  7288: ###############################################
                   7289: 
                   7290: =pod
                   7291: 
                   7292: =item * &get_user_quota()
                   7293: 
                   7294: Retrieves quota assigned for storage of portfolio files for a user  
                   7295: 
                   7296: Incoming parameters:
                   7297: 1. user's username
                   7298: 2. user's domain
                   7299: 
                   7300: Returns:
1.536     raeburn  7301: 1. Disk quota (in Mb) assigned to student.
                   7302: 2. (Optional) Type of setting: custom or default
                   7303:    (individually assigned or default for user's 
                   7304:    institutional status).
                   7305: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7306:    or student - types as defined in localenroll::inst_usertypes 
                   7307:    for user's domain, which determines default quota for user.
                   7308: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7309: 
                   7310: If a value has been stored in the user's environment, 
1.536     raeburn  7311: it will return that, otherwise it returns the maximal default
                   7312: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7313: 
                   7314: =cut
                   7315: 
                   7316: ###############################################
                   7317: 
                   7318: 
                   7319: sub get_user_quota {
                   7320:     my ($uname,$udom) = @_;
1.536     raeburn  7321:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7322:     if (!defined($udom)) {
                   7323:         $udom = $env{'user.domain'};
                   7324:     }
                   7325:     if (!defined($uname)) {
                   7326:         $uname = $env{'user.name'};
                   7327:     }
                   7328:     if (($udom eq '' || $uname eq '') ||
                   7329:         ($udom eq 'public') && ($uname eq 'public')) {
                   7330:         $quota = 0;
1.536     raeburn  7331:         $quotatype = 'default';
                   7332:         $defquota = 0; 
1.472     raeburn  7333:     } else {
1.536     raeburn  7334:         my $inststatus;
1.472     raeburn  7335:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7336:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7337:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7338:         } else {
1.536     raeburn  7339:             my %userenv = 
                   7340:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7341:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7342:             my ($tmp) = keys(%userenv);
                   7343:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7344:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7345:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7346:             } else {
                   7347:                 undef(%userenv);
                   7348:             }
                   7349:         }
1.536     raeburn  7350:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7351:         if ($quota eq '') {
1.536     raeburn  7352:             $quota = $defquota;
                   7353:             $quotatype = 'default';
                   7354:         } else {
                   7355:             $quotatype = 'custom';
1.472     raeburn  7356:         }
                   7357:     }
1.536     raeburn  7358:     if (wantarray) {
                   7359:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7360:     } else {
                   7361:         return $quota;
                   7362:     }
1.472     raeburn  7363: }
                   7364: 
                   7365: ###############################################
                   7366: 
                   7367: =pod
                   7368: 
                   7369: =item * &default_quota()
                   7370: 
1.536     raeburn  7371: Retrieves default quota assigned for storage of user portfolio files,
                   7372: given an (optional) user's institutional status.
1.472     raeburn  7373: 
                   7374: Incoming parameters:
                   7375: 1. domain
1.536     raeburn  7376: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7377:    status types (e.g., faculty, staff, student etc.)
                   7378:    which apply to the user for whom the default is being retrieved.
                   7379:    If the institutional status string in undefined, the domain
                   7380:    default quota will be returned. 
1.472     raeburn  7381: 
                   7382: Returns:
                   7383: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7384: 2. (Optional) institutional type which determined the value of the
                   7385:    default quota.
1.472     raeburn  7386: 
                   7387: If a value has been stored in the domain's configuration db,
                   7388: it will return that, otherwise it returns 20 (for backwards 
                   7389: compatibility with domains which have not set up a configuration
                   7390: db file; the original statically defined portfolio quota was 20 Mb). 
                   7391: 
1.536     raeburn  7392: If the user's status includes multiple types (e.g., staff and student),
                   7393: the largest default quota which applies to the user determines the
                   7394: default quota returned.
                   7395: 
1.780     raeburn  7396: =back
                   7397: 
1.472     raeburn  7398: =cut
                   7399: 
                   7400: ###############################################
                   7401: 
                   7402: 
                   7403: sub default_quota {
1.536     raeburn  7404:     my ($udom,$inststatus) = @_;
                   7405:     my ($defquota,$settingstatus);
                   7406:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7407:                                             ['quotas'],$udom);
                   7408:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7409:         if ($inststatus ne '') {
1.765     raeburn  7410:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7411:             foreach my $item (@statuses) {
1.711     raeburn  7412:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7413:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7414:                         if ($defquota eq '') {
                   7415:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7416:                             $settingstatus = $item;
                   7417:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7418:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7419:                             $settingstatus = $item;
                   7420:                         }
                   7421:                     }
                   7422:                 } else {
                   7423:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7424:                         if ($defquota eq '') {
                   7425:                             $defquota = $quotahash{'quotas'}{$item};
                   7426:                             $settingstatus = $item;
                   7427:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7428:                             $defquota = $quotahash{'quotas'}{$item};
                   7429:                             $settingstatus = $item;
                   7430:                         }
1.536     raeburn  7431:                     }
                   7432:                 }
                   7433:             }
                   7434:         }
                   7435:         if ($defquota eq '') {
1.711     raeburn  7436:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7437:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7438:             } else {
                   7439:                 $defquota = $quotahash{'quotas'}{'default'};
                   7440:             }
1.536     raeburn  7441:             $settingstatus = 'default';
                   7442:         }
                   7443:     } else {
                   7444:         $settingstatus = 'default';
                   7445:         $defquota = 20;
                   7446:     }
                   7447:     if (wantarray) {
                   7448:         return ($defquota,$settingstatus);
1.472     raeburn  7449:     } else {
1.536     raeburn  7450:         return $defquota;
1.472     raeburn  7451:     }
                   7452: }
                   7453: 
1.384     raeburn  7454: sub get_secgrprole_info {
                   7455:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7456:     my %sections_count = &get_sections($cdom,$cnum);
                   7457:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7458:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7459:     my @groups = sort(keys(%curr_groups));
                   7460:     my $allroles = [];
                   7461:     my $rolehash;
                   7462:     my $accesshash = {
                   7463:                      active => 'Currently has access',
                   7464:                      future => 'Will have future access',
                   7465:                      previous => 'Previously had access',
                   7466:                   };
                   7467:     if ($needroles) {
                   7468:         $rolehash = {'all' => 'all'};
1.385     albertel 7469:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7470: 	if (&Apache::lonnet::error(%user_roles)) {
                   7471: 	    undef(%user_roles);
                   7472: 	}
                   7473:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7474:             my ($role)=split(/\:/,$item,2);
                   7475:             if ($role eq 'cr') { next; }
                   7476:             if ($role =~ /^cr/) {
                   7477:                 $$rolehash{$role} = (split('/',$role))[3];
                   7478:             } else {
                   7479:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7480:             }
                   7481:         }
                   7482:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7483:             push(@{$allroles},$key);
                   7484:         }
                   7485:         push (@{$allroles},'st');
                   7486:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7487:     }
                   7488:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7489: }
                   7490: 
1.555     raeburn  7491: sub user_picker {
1.627     raeburn  7492:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7493:     my $currdom = $dom;
                   7494:     my %curr_selected = (
                   7495:                         srchin => 'dom',
1.580     raeburn  7496:                         srchby => 'lastname',
1.555     raeburn  7497:                       );
                   7498:     my $srchterm;
1.625     raeburn  7499:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7500:         if ($srch->{'srchby'} ne '') {
                   7501:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7502:         }
                   7503:         if ($srch->{'srchin'} ne '') {
                   7504:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7505:         }
                   7506:         if ($srch->{'srchtype'} ne '') {
                   7507:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7508:         }
                   7509:         if ($srch->{'srchdomain'} ne '') {
                   7510:             $currdom = $srch->{'srchdomain'};
                   7511:         }
                   7512:         $srchterm = $srch->{'srchterm'};
                   7513:     }
                   7514:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7515:                     'usr'       => 'Search criteria',
1.563     raeburn  7516:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7517:                     'uname'     => 'username',
                   7518:                     'lastname'  => 'last name',
1.555     raeburn  7519:                     'lastfirst' => 'last name, first name',
1.558     albertel 7520:                     'crs'       => 'in this course',
1.576     raeburn  7521:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7522:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7523:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7524:                     'exact'     => 'is',
                   7525:                     'contains'  => 'contains',
1.569     raeburn  7526:                     'begins'    => 'begins with',
1.571     raeburn  7527:                     'youm'      => "You must include some text to search for.",
                   7528:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7529:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7530:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7531:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7532:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7533:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7534:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7535:                                        );
1.563     raeburn  7536:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7537:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7538: 
                   7539:     my @srchins = ('crs','dom','alc','instd');
                   7540: 
                   7541:     foreach my $option (@srchins) {
                   7542:         # FIXME 'alc' option unavailable until 
                   7543:         #       loncreateuser::print_user_query_page()
                   7544:         #       has been completed.
                   7545:         next if ($option eq 'alc');
1.880     raeburn  7546:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7547:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7548:         if ($curr_selected{'srchin'} eq $option) {
                   7549:             $srchinsel .= ' 
                   7550:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7551:         } else {
                   7552:             $srchinsel .= '
                   7553:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7554:         }
1.555     raeburn  7555:     }
1.563     raeburn  7556:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7557: 
                   7558:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7559:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7560:         if ($curr_selected{'srchby'} eq $option) {
                   7561:             $srchbysel .= '
                   7562:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7563:         } else {
                   7564:             $srchbysel .= '
                   7565:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7566:          }
                   7567:     }
                   7568:     $srchbysel .= "\n  </select>\n";
                   7569: 
                   7570:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7571:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7572:         if ($curr_selected{'srchtype'} eq $option) {
                   7573:             $srchtypesel .= '
                   7574:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7575:         } else {
                   7576:             $srchtypesel .= '
                   7577:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7578:         }
                   7579:     }
                   7580:     $srchtypesel .= "\n  </select>\n";
                   7581: 
1.558     albertel 7582:     my ($newuserscript,$new_user_create);
1.556     raeburn  7583: 
                   7584:     if ($forcenewuser) {
1.576     raeburn  7585:         if (ref($srch) eq 'HASH') {
                   7586:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7587:                 if ($cancreate) {
                   7588:                     $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>';
                   7589:                 } else {
1.799     bisitz   7590:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7591:                     my %usertypetext = (
                   7592:                         official   => 'institutional',
                   7593:                         unofficial => 'non-institutional',
                   7594:                     );
1.799     bisitz   7595:                     $new_user_create = '<p class="LC_warning">'
                   7596:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7597:                                       .' '
                   7598:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7599:                                           ,'<a href="'.$helplink.'">','</a>')
                   7600:                                       .'</p><br />';
1.627     raeburn  7601:                 }
1.576     raeburn  7602:             }
                   7603:         }
                   7604: 
1.556     raeburn  7605:         $newuserscript = <<"ENDSCRIPT";
                   7606: 
1.570     raeburn  7607: function setSearch(createnew,callingForm) {
1.556     raeburn  7608:     if (createnew == 1) {
1.570     raeburn  7609:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7610:             if (callingForm.srchby.options[i].value == 'uname') {
                   7611:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7612:             }
                   7613:         }
1.570     raeburn  7614:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7615:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7616: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7617:             }
                   7618:         }
1.570     raeburn  7619:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7620:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7621:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7622:             }
                   7623:         }
1.570     raeburn  7624:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7625:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7626:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7627:             }
                   7628:         }
                   7629:     }
                   7630: }
                   7631: ENDSCRIPT
1.558     albertel 7632: 
1.556     raeburn  7633:     }
                   7634: 
1.555     raeburn  7635:     my $output = <<"END_BLOCK";
1.556     raeburn  7636: <script type="text/javascript">
1.824     bisitz   7637: // <![CDATA[
1.570     raeburn  7638: function validateEntry(callingForm) {
1.558     albertel 7639: 
1.556     raeburn  7640:     var checkok = 1;
1.558     albertel 7641:     var srchin;
1.570     raeburn  7642:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7643: 	if ( callingForm.srchin[i].checked ) {
                   7644: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7645: 	}
                   7646:     }
                   7647: 
1.570     raeburn  7648:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7649:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7650:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7651:     var srchterm =  callingForm.srchterm.value;
                   7652:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7653:     var msg = "";
                   7654: 
                   7655:     if (srchterm == "") {
                   7656:         checkok = 0;
1.571     raeburn  7657:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7658:     }
                   7659: 
1.569     raeburn  7660:     if (srchtype== 'begins') {
                   7661:         if (srchterm.length < 2) {
                   7662:             checkok = 0;
1.571     raeburn  7663:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7664:         }
                   7665:     }
                   7666: 
1.556     raeburn  7667:     if (srchtype== 'contains') {
                   7668:         if (srchterm.length < 3) {
                   7669:             checkok = 0;
1.571     raeburn  7670:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7671:         }
                   7672:     }
                   7673:     if (srchin == 'instd') {
                   7674:         if (srchdomain == '') {
                   7675:             checkok = 0;
1.571     raeburn  7676:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7677:         }
                   7678:     }
                   7679:     if (srchin == 'dom') {
                   7680:         if (srchdomain == '') {
                   7681:             checkok = 0;
1.571     raeburn  7682:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7683:         }
                   7684:     }
                   7685:     if (srchby == 'lastfirst') {
                   7686:         if (srchterm.indexOf(",") == -1) {
                   7687:             checkok = 0;
1.571     raeburn  7688:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7689:         }
                   7690:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7691:             checkok = 0;
1.571     raeburn  7692:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7693:         }
                   7694:     }
                   7695:     if (checkok == 0) {
1.571     raeburn  7696:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7697:         return;
                   7698:     }
                   7699:     if (checkok == 1) {
1.570     raeburn  7700:         callingForm.submit();
1.556     raeburn  7701:     }
                   7702: }
                   7703: 
                   7704: $newuserscript
                   7705: 
1.824     bisitz   7706: // ]]>
1.556     raeburn  7707: </script>
1.558     albertel 7708: 
                   7709: $new_user_create
                   7710: 
1.555     raeburn  7711: END_BLOCK
1.558     albertel 7712: 
1.876     raeburn  7713:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7714:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7715:                $domform.
                   7716:                &Apache::lonhtmlcommon::row_closure().
                   7717:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7718:                $srchbysel.
                   7719:                $srchtypesel. 
                   7720:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7721:                $srchinsel.
                   7722:                &Apache::lonhtmlcommon::row_closure(1). 
                   7723:                &Apache::lonhtmlcommon::end_pick_box().
                   7724:                '<br />';
1.555     raeburn  7725:     return $output;
                   7726: }
                   7727: 
1.612     raeburn  7728: sub user_rule_check {
1.615     raeburn  7729:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7730:     my $response;
                   7731:     if (ref($usershash) eq 'HASH') {
                   7732:         foreach my $user (keys(%{$usershash})) {
                   7733:             my ($uname,$udom) = split(/:/,$user);
                   7734:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7735:             my ($id,$newuser);
1.612     raeburn  7736:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7737:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7738:                 $id = $usershash->{$user}->{'id'};
                   7739:             }
                   7740:             my $inst_response;
                   7741:             if (ref($checks) eq 'HASH') {
                   7742:                 if (defined($checks->{'username'})) {
1.615     raeburn  7743:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7744:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7745:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7746:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7747:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7748:                 }
1.615     raeburn  7749:             } else {
                   7750:                 ($inst_response,%{$inst_results->{$user}}) =
                   7751:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7752:                 return;
1.612     raeburn  7753:             }
1.615     raeburn  7754:             if (!$got_rules->{$udom}) {
1.612     raeburn  7755:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7756:                                                   ['usercreation'],$udom);
                   7757:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7758:                     foreach my $item ('username','id') {
1.612     raeburn  7759:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7760:                             $$curr_rules{$udom}{$item} = 
                   7761:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7762:                         }
                   7763:                     }
                   7764:                 }
1.615     raeburn  7765:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7766:             }
1.612     raeburn  7767:             foreach my $item (keys(%{$checks})) {
                   7768:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7769:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7770:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7771:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7772:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7773:                                 if ($rule_check{$rule}) {
                   7774:                                     $$rulematch{$user}{$item} = $rule;
                   7775:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7776:                                         if (ref($inst_results) eq 'HASH') {
                   7777:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7778:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7779:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7780:                                                 }
1.612     raeburn  7781:                                             }
                   7782:                                         }
1.615     raeburn  7783:                                     }
                   7784:                                     last;
1.585     raeburn  7785:                                 }
                   7786:                             }
                   7787:                         }
                   7788:                     }
                   7789:                 }
                   7790:             }
                   7791:         }
                   7792:     }
1.612     raeburn  7793:     return;
                   7794: }
                   7795: 
                   7796: sub user_rule_formats {
                   7797:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7798:     my %text = ( 
                   7799:                  'username' => 'Usernames',
                   7800:                  'id'       => 'IDs',
                   7801:                );
                   7802:     my $output;
                   7803:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7804:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7805:         if (@{$ruleorder} > 0) {
                   7806:             $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>';
                   7807:             foreach my $rule (@{$ruleorder}) {
                   7808:                 if (ref($curr_rules) eq 'ARRAY') {
                   7809:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7810:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7811:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7812:                                         $rules->{$rule}{'desc'}.'</li>';
                   7813:                         }
                   7814:                     }
                   7815:                 }
                   7816:             }
                   7817:             $output .= '</ul>';
                   7818:         }
                   7819:     }
                   7820:     return $output;
                   7821: }
                   7822: 
                   7823: sub instrule_disallow_msg {
1.615     raeburn  7824:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7825:     my $response;
                   7826:     my %text = (
                   7827:                   item   => 'username',
                   7828:                   items  => 'usernames',
                   7829:                   match  => 'matches',
                   7830:                   do     => 'does',
                   7831:                   action => 'a username',
                   7832:                   one    => 'one',
                   7833:                );
                   7834:     if ($count > 1) {
                   7835:         $text{'item'} = 'usernames';
                   7836:         $text{'match'} ='match';
                   7837:         $text{'do'} = 'do';
                   7838:         $text{'action'} = 'usernames',
                   7839:         $text{'one'} = 'ones';
                   7840:     }
                   7841:     if ($checkitem eq 'id') {
                   7842:         $text{'items'} = 'IDs';
                   7843:         $text{'item'} = 'ID';
                   7844:         $text{'action'} = 'an ID';
1.615     raeburn  7845:         if ($count > 1) {
                   7846:             $text{'item'} = 'IDs';
                   7847:             $text{'action'} = 'IDs';
                   7848:         }
1.612     raeburn  7849:     }
1.674     bisitz   7850:     $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  7851:     if ($mode eq 'upload') {
                   7852:         if ($checkitem eq 'username') {
                   7853:             $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'}.");
                   7854:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7855:             $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  7856:         }
1.669     raeburn  7857:     } elsif ($mode eq 'selfcreate') {
                   7858:         if ($checkitem eq 'id') {
                   7859:             $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.");
                   7860:         }
1.615     raeburn  7861:     } else {
                   7862:         if ($checkitem eq 'username') {
                   7863:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7864:         } elsif ($checkitem eq 'id') {
                   7865:             $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.");
                   7866:         }
1.612     raeburn  7867:     }
                   7868:     return $response;
1.585     raeburn  7869: }
                   7870: 
1.624     raeburn  7871: sub personal_data_fieldtitles {
                   7872:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7873:                         id => 'Student/Employee ID',
                   7874:                         permanentemail => 'E-mail address',
                   7875:                         lastname => 'Last Name',
                   7876:                         firstname => 'First Name',
                   7877:                         middlename => 'Middle Name',
                   7878:                         generation => 'Generation',
                   7879:                         gen => 'Generation',
1.765     raeburn  7880:                         inststatus => 'Affiliation',
1.624     raeburn  7881:                    );
                   7882:     return %fieldtitles;
                   7883: }
                   7884: 
1.642     raeburn  7885: sub sorted_inst_types {
                   7886:     my ($dom) = @_;
                   7887:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7888:     my $othertitle = &mt('All users');
                   7889:     if ($env{'request.course.id'}) {
1.668     raeburn  7890:         $othertitle  = &mt('Any users');
1.642     raeburn  7891:     }
                   7892:     my @types;
                   7893:     if (ref($order) eq 'ARRAY') {
                   7894:         @types = @{$order};
                   7895:     }
                   7896:     if (@types == 0) {
                   7897:         if (ref($usertypes) eq 'HASH') {
                   7898:             @types = sort(keys(%{$usertypes}));
                   7899:         }
                   7900:     }
                   7901:     if (keys(%{$usertypes}) > 0) {
                   7902:         $othertitle = &mt('Other users');
                   7903:     }
                   7904:     return ($othertitle,$usertypes,\@types);
                   7905: }
                   7906: 
1.645     raeburn  7907: sub get_institutional_codes {
                   7908:     my ($settings,$allcourses,$LC_code) = @_;
                   7909: # Get complete list of course sections to update
                   7910:     my @currsections = ();
                   7911:     my @currxlists = ();
                   7912:     my $coursecode = $$settings{'internal.coursecode'};
                   7913: 
                   7914:     if ($$settings{'internal.sectionnums'} ne '') {
                   7915:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7916:     }
                   7917: 
                   7918:     if ($$settings{'internal.crosslistings'} ne '') {
                   7919:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7920:     }
                   7921: 
                   7922:     if (@currxlists > 0) {
                   7923:         foreach (@currxlists) {
                   7924:             if (m/^([^:]+):(\w*)$/) {
                   7925:                 unless (grep/^$1$/,@{$allcourses}) {
                   7926:                     push @{$allcourses},$1;
                   7927:                     $$LC_code{$1} = $2;
                   7928:                 }
                   7929:             }
                   7930:         }
                   7931:     }
                   7932:  
                   7933:     if (@currsections > 0) {
                   7934:         foreach (@currsections) {
                   7935:             if (m/^(\w+):(\w*)$/) {
                   7936:                 my $sec = $coursecode.$1;
                   7937:                 my $lc_sec = $2;
                   7938:                 unless (grep/^$sec$/,@{$allcourses}) {
                   7939:                     push @{$allcourses},$sec;
                   7940:                     $$LC_code{$sec} = $lc_sec;
                   7941:                 }
                   7942:             }
                   7943:         }
                   7944:     }
                   7945:     return;
                   7946: }
                   7947: 
1.112     bowersj2 7948: =pod
                   7949: 
1.780     raeburn  7950: =head1 Slot Helpers
                   7951: 
                   7952: =over 4
                   7953: 
                   7954: =item * sorted_slots()
                   7955: 
                   7956: Sorts an array of slot names in order of slot start time (earliest first). 
                   7957: 
                   7958: Inputs:
                   7959: 
                   7960: =over 4
                   7961: 
                   7962: slotsarr  - Reference to array of unsorted slot names.
                   7963: 
                   7964: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   7965: 
1.549     albertel 7966: =back
                   7967: 
1.780     raeburn  7968: Returns:
                   7969: 
                   7970: =over 4
                   7971: 
                   7972: sorted   - An array of slot names sorted by the start time of the slot.
                   7973: 
                   7974: =back
                   7975: 
                   7976: =back
                   7977: 
                   7978: =cut
                   7979: 
                   7980: 
                   7981: sub sorted_slots {
                   7982:     my ($slotsarr,$slots) = @_;
                   7983:     my @sorted;
                   7984:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   7985:         @sorted =
                   7986:             sort {
                   7987:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   7988:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   7989:                      }
                   7990:                      if (ref($slots->{$a})) { return -1;}
                   7991:                      if (ref($slots->{$b})) { return 1;}
                   7992:                      return 0;
                   7993:                  } @{$slotsarr};
                   7994:     }
                   7995:     return @sorted;
                   7996: }
                   7997: 
                   7998: 
                   7999: =pod
                   8000: 
1.549     albertel 8001: =head1 HTTP Helpers
                   8002: 
                   8003: =over 4
                   8004: 
1.648     raeburn  8005: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8006: 
1.258     albertel 8007: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8008: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8009: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8010: 
                   8011: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8012: $possible_names is an ref to an array of form element names.  As an example:
                   8013: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8014: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8015: 
                   8016: =cut
1.1       albertel 8017: 
1.6       albertel 8018: sub get_unprocessed_cgi {
1.25      albertel 8019:   my ($query,$possible_names)= @_;
1.26      matthew  8020:   # $Apache::lonxml::debug=1;
1.356     albertel 8021:   foreach my $pair (split(/&/,$query)) {
                   8022:     my ($name, $value) = split(/=/,$pair);
1.369     www      8023:     $name = &unescape($name);
1.25      albertel 8024:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8025:       $value =~ tr/+/ /;
                   8026:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8027:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8028:     }
1.16      harris41 8029:   }
1.6       albertel 8030: }
                   8031: 
1.112     bowersj2 8032: =pod
                   8033: 
1.648     raeburn  8034: =item * &cacheheader() 
1.112     bowersj2 8035: 
                   8036: returns cache-controlling header code
                   8037: 
                   8038: =cut
                   8039: 
1.7       albertel 8040: sub cacheheader {
1.258     albertel 8041:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8042:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8043:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8044:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8045:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8046:     return $output;
1.7       albertel 8047: }
                   8048: 
1.112     bowersj2 8049: =pod
                   8050: 
1.648     raeburn  8051: =item * &no_cache($r) 
1.112     bowersj2 8052: 
                   8053: specifies header code to not have cache
                   8054: 
                   8055: =cut
                   8056: 
1.9       albertel 8057: sub no_cache {
1.216     albertel 8058:     my ($r) = @_;
                   8059:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8060: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8061:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8062:     $r->no_cache(1);
                   8063:     $r->header_out("Expires" => $date);
                   8064:     $r->header_out("Pragma" => "no-cache");
1.123     www      8065: }
                   8066: 
                   8067: sub content_type {
1.181     albertel 8068:     my ($r,$type,$charset) = @_;
1.299     foxr     8069:     if ($r) {
                   8070: 	#  Note that printout.pl calls this with undef for $r.
                   8071: 	&no_cache($r);
                   8072:     }
1.258     albertel 8073:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8074:     unless ($charset) {
                   8075: 	$charset=&Apache::lonlocal::current_encoding;
                   8076:     }
                   8077:     if ($charset) { $type.='; charset='.$charset; }
                   8078:     if ($r) {
                   8079: 	$r->content_type($type);
                   8080:     } else {
                   8081: 	print("Content-type: $type\n\n");
                   8082:     }
1.9       albertel 8083: }
1.25      albertel 8084: 
1.112     bowersj2 8085: =pod
                   8086: 
1.648     raeburn  8087: =item * &add_to_env($name,$value) 
1.112     bowersj2 8088: 
1.258     albertel 8089: adds $name to the %env hash with value
1.112     bowersj2 8090: $value, if $name already exists, the entry is converted to an array
                   8091: reference and $value is added to the array.
                   8092: 
                   8093: =cut
                   8094: 
1.25      albertel 8095: sub add_to_env {
                   8096:   my ($name,$value)=@_;
1.258     albertel 8097:   if (defined($env{$name})) {
                   8098:     if (ref($env{$name})) {
1.25      albertel 8099:       #already have multiple values
1.258     albertel 8100:       push(@{ $env{$name} },$value);
1.25      albertel 8101:     } else {
                   8102:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8103:       my $first=$env{$name};
                   8104:       undef($env{$name});
                   8105:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8106:     }
                   8107:   } else {
1.258     albertel 8108:     $env{$name}=$value;
1.25      albertel 8109:   }
1.31      albertel 8110: }
1.149     albertel 8111: 
                   8112: =pod
                   8113: 
1.648     raeburn  8114: =item * &get_env_multiple($name) 
1.149     albertel 8115: 
1.258     albertel 8116: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8117: values may be defined and end up as an array ref.
                   8118: 
                   8119: returns an array of values
                   8120: 
                   8121: =cut
                   8122: 
                   8123: sub get_env_multiple {
                   8124:     my ($name) = @_;
                   8125:     my @values;
1.258     albertel 8126:     if (defined($env{$name})) {
1.149     albertel 8127:         # exists is it an array
1.258     albertel 8128:         if (ref($env{$name})) {
                   8129:             @values=@{ $env{$name} };
1.149     albertel 8130:         } else {
1.258     albertel 8131:             $values[0]=$env{$name};
1.149     albertel 8132:         }
                   8133:     }
                   8134:     return(@values);
                   8135: }
                   8136: 
1.660     raeburn  8137: sub ask_for_embedded_content {
                   8138:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8139:     my $upload_output = '
                   8140:    <form name="upload_embedded" action="'.$actionurl.'"
                   8141:                   method="post" enctype="multipart/form-data">';
                   8142:     $upload_output .= $state;
1.661     raeburn  8143:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8144: 
                   8145:     my $num = 0;
                   8146:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8147:         $upload_output .= &start_data_table_row().
                   8148:             '<td>'.$embed_file.'</td><td>';
                   8149:         if ($args->{'ignore_remote_references'}
                   8150:             && $embed_file =~ m{^\w+://}) {
                   8151:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8152:         } elsif ($args->{'error_on_invalid_names'}
                   8153:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8154: 
                   8155:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8156: 
                   8157:         } else {
                   8158:             $upload_output .='
1.661     raeburn  8159:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8160:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8161:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8162:             $upload_output .=
                   8163:                 "\n\t\t".
                   8164:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8165:                 $attrib.'" />';
                   8166:             if (exists($$codebase{$embed_file})) {
                   8167:                 $upload_output .=
                   8168:                     "\n\t\t".
                   8169:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8170:                     &escape($$codebase{$embed_file}).'" />';
                   8171:             }
                   8172:         }
                   8173:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8174:         $num++;
                   8175:     }
                   8176:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8177:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8178:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8179:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8180:    </form>';
                   8181:     return $upload_output;
                   8182: }
                   8183: 
1.661     raeburn  8184: sub upload_embedded {
                   8185:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8186:         $current_disk_usage) = @_;
                   8187:     my $output;
                   8188:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8189:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8190:         my $orig_uploaded_filename =
                   8191:             $env{'form.embedded_item_'.$i.'.filename'};
                   8192: 
                   8193:         $env{'form.embedded_orig_'.$i} =
                   8194:             &unescape($env{'form.embedded_orig_'.$i});
                   8195:         my ($path,$fname) =
                   8196:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8197:         # no path, whole string is fname
                   8198:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8199: 
                   8200:         $path = $env{'form.currentpath'}.$path;
                   8201:         $fname = &Apache::lonnet::clean_filename($fname);
                   8202:         # See if there is anything left
                   8203:         next if ($fname eq '');
                   8204: 
                   8205:         # Check if file already exists as a file or directory.
                   8206:         my ($state,$msg);
                   8207:         if ($context eq 'portfolio') {
                   8208:             my $port_path = $dirpath;
                   8209:             if ($group ne '') {
                   8210:                 $port_path = "groups/$group/$port_path";
                   8211:             }
                   8212:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8213:                                               $dir_root,$port_path,$disk_quota,
                   8214:                                               $current_disk_usage,$uname,$udom);
                   8215:             if ($state eq 'will_exceed_quota'
                   8216:                 || $state eq 'file_locked'
                   8217:                 || $state eq 'file_exists' ) {
                   8218:                 $output .= $msg;
                   8219:                 next;
                   8220:             }
                   8221:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8222:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8223:             if ($state eq 'exists') {
                   8224:                 $output .= $msg;
                   8225:                 next;
                   8226:             }
                   8227:         }
                   8228:         # Check if extension is valid
                   8229:         if (($fname =~ /\.(\w+)$/) &&
                   8230:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8231:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8232:             next;
                   8233:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8234:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8235:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8236:             next;
                   8237:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8238:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8239:             next;
                   8240:         }
                   8241: 
                   8242:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8243:         if ($context eq 'portfolio') {
                   8244:             my $result=
                   8245:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8246:                                                 $dirpath.$path);
                   8247:             if ($result !~ m|^/uploaded/|) {
                   8248:                 $output .= '<span class="LC_error">'
                   8249:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8250:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8251:                       .'</span><br />';
                   8252:                 next;
                   8253:             } else {
                   8254:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8255:                            $path.$fname.'</span>').'</p>';     
                   8256:             }
                   8257:         } else {
                   8258: # Save the file
                   8259:             my $target = $env{'form.embedded_item_'.$i};
                   8260:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8261:             my $dest = $fullpath.$fname;
                   8262:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8263:             my @parts=split(/\//,$fullpath);
                   8264:             my $count;
                   8265:             my $filepath = $dir_root;
                   8266:             for ($count=4;$count<=$#parts;$count++) {
                   8267:                 $filepath .= "/$parts[$count]";
                   8268:                 if ((-e $filepath)!=1) {
                   8269:                     mkdir($filepath,0770);
                   8270:                 }
                   8271:             }
                   8272:             my $fh;
                   8273:             if (!open($fh,'>'.$dest)) {
                   8274:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8275:                 $output .= '<span class="LC_error">'.
                   8276:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8277:                            '</span><br />';
                   8278:             } else {
                   8279:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8280:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8281:                     $output .= '<span class="LC_error">'.
                   8282:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8283:                               '</span><br />';
                   8284:                 } else {
                   8285:                     if ($context eq 'testbank') {
                   8286:                         $output .= &mt('Embedded file uploaded successfully:').
                   8287:                                    '&nbsp;<a href="'.$url.'">'.
                   8288:                                    $orig_uploaded_filename.'</a><br />';
                   8289:                     } else {
1.705     tempelho 8290:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8291:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8292:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8293:                     }
                   8294:                 }
                   8295:                 close($fh);
                   8296:             }
                   8297:         }
                   8298:     }
                   8299:     return $output;
                   8300: }
                   8301: 
                   8302: sub check_for_existing {
                   8303:     my ($path,$fname,$element) = @_;
                   8304:     my ($state,$msg);
                   8305:     if (-d $path.'/'.$fname) {
                   8306:         $state = 'exists';
                   8307:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8308:     } elsif (-e $path.'/'.$fname) {
                   8309:         $state = 'exists';
                   8310:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8311:     }
                   8312:     if ($state eq 'exists') {
                   8313:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8314:     }
                   8315:     return ($state,$msg);
                   8316: }
                   8317: 
                   8318: sub check_for_upload {
                   8319:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8320:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8321:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8322:     my $getpropath = 1;
                   8323:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8324:                                             $getpropath);
                   8325:     my $found_file = 0;
                   8326:     my $locked_file = 0;
                   8327:     foreach my $line (@dir_list) {
                   8328:         my ($file_name)=split(/\&/,$line,2);
                   8329:         if ($file_name eq $fname){
                   8330:             $file_name = $path.$file_name;
                   8331:             if ($group ne '') {
                   8332:                 $file_name = $group.$file_name;
                   8333:             }
                   8334:             $found_file = 1;
                   8335:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8336:                 $locked_file = 1;
                   8337:             }
                   8338:         }
                   8339:     }
                   8340:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8341:         my $msg = '<span class="LC_error">'.
                   8342:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8343:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8344:         return ('will_exceed_quota',$msg);
                   8345:     } elsif ($found_file) {
                   8346:         if ($locked_file) {
                   8347:             my $msg = '<span class="LC_error">';
                   8348:             $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>');
                   8349:             $msg .= '</span><br />';
                   8350:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8351:             return ('file_locked',$msg);
                   8352:         } else {
                   8353:             my $msg = '<span class="LC_error">';
                   8354:             $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'});
                   8355:             $msg .= '</span>';
                   8356:             $msg .= '<br />';
                   8357:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8358:             return ('file_exists',$msg);
                   8359:         }
                   8360:     }
                   8361: }
                   8362: 
1.31      albertel 8363: 
1.41      ng       8364: =pod
1.45      matthew  8365: 
1.464     albertel 8366: =back
1.41      ng       8367: 
1.112     bowersj2 8368: =head1 CSV Upload/Handling functions
1.38      albertel 8369: 
1.41      ng       8370: =over 4
                   8371: 
1.648     raeburn  8372: =item * &upfile_store($r)
1.41      ng       8373: 
                   8374: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8375: needs $env{'form.upfile'}
1.41      ng       8376: returns $datatoken to be put into hidden field
                   8377: 
                   8378: =cut
1.31      albertel 8379: 
                   8380: sub upfile_store {
                   8381:     my $r=shift;
1.258     albertel 8382:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8383:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8384:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8385:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8386: 
1.258     albertel 8387:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8388: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8389:     {
1.158     raeburn  8390:         my $datafile = $r->dir_config('lonDaemons').
                   8391:                            '/tmp/'.$datatoken.'.tmp';
                   8392:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8393:             print $fh $env{'form.upfile'};
1.158     raeburn  8394:             close($fh);
                   8395:         }
1.31      albertel 8396:     }
                   8397:     return $datatoken;
                   8398: }
                   8399: 
1.56      matthew  8400: =pod
                   8401: 
1.648     raeburn  8402: =item * &load_tmp_file($r)
1.41      ng       8403: 
                   8404: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8405: needs $env{'form.datatoken'},
                   8406: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8407: 
                   8408: =cut
1.31      albertel 8409: 
                   8410: sub load_tmp_file {
                   8411:     my $r=shift;
                   8412:     my @studentdata=();
                   8413:     {
1.158     raeburn  8414:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8415:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8416:         if ( open(my $fh,"<$studentfile") ) {
                   8417:             @studentdata=<$fh>;
                   8418:             close($fh);
                   8419:         }
1.31      albertel 8420:     }
1.258     albertel 8421:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8422: }
                   8423: 
1.56      matthew  8424: =pod
                   8425: 
1.648     raeburn  8426: =item * &upfile_record_sep()
1.41      ng       8427: 
                   8428: Separate uploaded file into records
                   8429: returns array of records,
1.258     albertel 8430: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8431: 
                   8432: =cut
1.31      albertel 8433: 
                   8434: sub upfile_record_sep {
1.258     albertel 8435:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8436:     } else {
1.248     albertel 8437: 	my @records;
1.258     albertel 8438: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8439: 	    if ($line=~/^\s*$/) { next; }
                   8440: 	    push(@records,$line);
                   8441: 	}
                   8442: 	return @records;
1.31      albertel 8443:     }
                   8444: }
                   8445: 
1.56      matthew  8446: =pod
                   8447: 
1.648     raeburn  8448: =item * &record_sep($record)
1.41      ng       8449: 
1.258     albertel 8450: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8451: 
                   8452: =cut
                   8453: 
1.263     www      8454: sub takeleft {
                   8455:     my $index=shift;
                   8456:     return substr('0000'.$index,-4,4);
                   8457: }
                   8458: 
1.31      albertel 8459: sub record_sep {
                   8460:     my $record=shift;
                   8461:     my %components=();
1.258     albertel 8462:     if ($env{'form.upfiletype'} eq 'xml') {
                   8463:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8464:         my $i=0;
1.356     albertel 8465:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8466:             $field=~s/^(\"|\')//;
                   8467:             $field=~s/(\"|\')$//;
1.263     www      8468:             $components{&takeleft($i)}=$field;
1.31      albertel 8469:             $i++;
                   8470:         }
1.258     albertel 8471:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8472:         my $i=0;
1.356     albertel 8473:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8474:             $field=~s/^(\"|\')//;
                   8475:             $field=~s/(\"|\')$//;
1.263     www      8476:             $components{&takeleft($i)}=$field;
1.31      albertel 8477:             $i++;
                   8478:         }
                   8479:     } else {
1.561     www      8480:         my $separator=',';
1.480     banghart 8481:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8482:             $separator=';';
1.480     banghart 8483:         }
1.31      albertel 8484:         my $i=0;
1.561     www      8485: # the character we are looking for to indicate the end of a quote or a record 
                   8486:         my $looking_for=$separator;
                   8487: # do not add the characters to the fields
                   8488:         my $ignore=0;
                   8489: # we just encountered a separator (or the beginning of the record)
                   8490:         my $just_found_separator=1;
                   8491: # store the field we are working on here
                   8492:         my $field='';
                   8493: # work our way through all characters in record
                   8494:         foreach my $character ($record=~/(.)/g) {
                   8495:             if ($character eq $looking_for) {
                   8496:                if ($character ne $separator) {
                   8497: # Found the end of a quote, again looking for separator
                   8498:                   $looking_for=$separator;
                   8499:                   $ignore=1;
                   8500:                } else {
                   8501: # Found a separator, store away what we got
                   8502:                   $components{&takeleft($i)}=$field;
                   8503: 	          $i++;
                   8504:                   $just_found_separator=1;
                   8505:                   $ignore=0;
                   8506:                   $field='';
                   8507:                }
                   8508:                next;
                   8509:             }
                   8510: # single or double quotation marks after a separator indicate beginning of a quote
                   8511: # we are now looking for the end of the quote and need to ignore separators
                   8512:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8513:                $looking_for=$character;
                   8514:                next;
                   8515:             }
                   8516: # ignore would be true after we reached the end of a quote
                   8517:             if ($ignore) { next; }
                   8518:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8519:             $field.=$character;
                   8520:             $just_found_separator=0; 
1.31      albertel 8521:         }
1.561     www      8522: # catch the very last entry, since we never encountered the separator
                   8523:         $components{&takeleft($i)}=$field;
1.31      albertel 8524:     }
                   8525:     return %components;
                   8526: }
                   8527: 
1.144     matthew  8528: ######################################################
                   8529: ######################################################
                   8530: 
1.56      matthew  8531: =pod
                   8532: 
1.648     raeburn  8533: =item * &upfile_select_html()
1.41      ng       8534: 
1.144     matthew  8535: Return HTML code to select a file from the users machine and specify 
                   8536: the file type.
1.41      ng       8537: 
                   8538: =cut
                   8539: 
1.144     matthew  8540: ######################################################
                   8541: ######################################################
1.31      albertel 8542: sub upfile_select_html {
1.144     matthew  8543:     my %Types = (
                   8544:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8545:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8546:                  space => &mt('Space separated'),
                   8547:                  tab   => &mt('Tabulator separated'),
                   8548: #                 xml   => &mt('HTML/XML'),
                   8549:                  );
                   8550:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8551:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8552:     foreach my $type (sort(keys(%Types))) {
                   8553:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8554:     }
                   8555:     $Str .= "</select>\n";
                   8556:     return $Str;
1.31      albertel 8557: }
                   8558: 
1.301     albertel 8559: sub get_samples {
                   8560:     my ($records,$toget) = @_;
                   8561:     my @samples=({});
                   8562:     my $got=0;
                   8563:     foreach my $rec (@$records) {
                   8564: 	my %temp = &record_sep($rec);
                   8565: 	if (! grep(/\S/, values(%temp))) { next; }
                   8566: 	if (%temp) {
                   8567: 	    $samples[$got]=\%temp;
                   8568: 	    $got++;
                   8569: 	    if ($got == $toget) { last; }
                   8570: 	}
                   8571:     }
                   8572:     return \@samples;
                   8573: }
                   8574: 
1.144     matthew  8575: ######################################################
                   8576: ######################################################
                   8577: 
1.56      matthew  8578: =pod
                   8579: 
1.648     raeburn  8580: =item * &csv_print_samples($r,$records)
1.41      ng       8581: 
                   8582: Prints a table of sample values from each column uploaded $r is an
                   8583: Apache Request ref, $records is an arrayref from
                   8584: &Apache::loncommon::upfile_record_sep
                   8585: 
                   8586: =cut
                   8587: 
1.144     matthew  8588: ######################################################
                   8589: ######################################################
1.31      albertel 8590: sub csv_print_samples {
                   8591:     my ($r,$records) = @_;
1.662     bisitz   8592:     my $samples = &get_samples($records,5);
1.301     albertel 8593: 
1.594     raeburn  8594:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8595:               &start_data_table_header_row());
1.356     albertel 8596:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8597:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8598:     $r->print(&end_data_table_header_row());
1.301     albertel 8599:     foreach my $hash (@$samples) {
1.594     raeburn  8600: 	$r->print(&start_data_table_row());
1.356     albertel 8601: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8602: 	    $r->print('<td>');
1.356     albertel 8603: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8604: 	    $r->print('</td>');
                   8605: 	}
1.594     raeburn  8606: 	$r->print(&end_data_table_row());
1.31      albertel 8607:     }
1.594     raeburn  8608:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8609: }
                   8610: 
1.144     matthew  8611: ######################################################
                   8612: ######################################################
                   8613: 
1.56      matthew  8614: =pod
                   8615: 
1.648     raeburn  8616: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8617: 
                   8618: Prints a table to create associations between values and table columns.
1.144     matthew  8619: 
1.41      ng       8620: $r is an Apache Request ref,
                   8621: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8622: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8623: 
                   8624: =cut
                   8625: 
1.144     matthew  8626: ######################################################
                   8627: ######################################################
1.31      albertel 8628: sub csv_print_select_table {
                   8629:     my ($r,$records,$d) = @_;
1.301     albertel 8630:     my $i=0;
                   8631:     my $samples = &get_samples($records,1);
1.144     matthew  8632:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8633: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8634:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8635:               '<th>'.&mt('Column').'</th>'.
                   8636:               &end_data_table_header_row()."\n");
1.356     albertel 8637:     foreach my $array_ref (@$d) {
                   8638: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8639: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8640: 
1.875     bisitz   8641: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8642: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8643: 	$r->print('<option value="none"></option>');
1.356     albertel 8644: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8645: 	    $r->print('<option value="'.$sample.'"'.
                   8646:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8647:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8648: 	}
1.594     raeburn  8649: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8650: 	$i++;
                   8651:     }
1.594     raeburn  8652:     $r->print(&end_data_table());
1.31      albertel 8653:     $i--;
                   8654:     return $i;
                   8655: }
1.56      matthew  8656: 
1.144     matthew  8657: ######################################################
                   8658: ######################################################
                   8659: 
1.56      matthew  8660: =pod
1.31      albertel 8661: 
1.648     raeburn  8662: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8663: 
                   8664: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8665: 
                   8666: $r is an Apache Request ref,
                   8667: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8668: $d is an array of 2 element arrays (internal name, displayed name)
                   8669: 
                   8670: =cut
                   8671: 
1.144     matthew  8672: ######################################################
                   8673: ######################################################
1.31      albertel 8674: sub csv_samples_select_table {
                   8675:     my ($r,$records,$d) = @_;
                   8676:     my $i=0;
1.144     matthew  8677:     #
1.662     bisitz   8678:     my $max_samples = 5;
                   8679:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8680:     $r->print(&start_data_table().
                   8681:               &start_data_table_header_row().'<th>'.
                   8682:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8683:               &end_data_table_header_row());
1.301     albertel 8684: 
                   8685:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8686: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8687: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8688: 	foreach my $option (@$d) {
                   8689: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8690: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8691:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8692:                       $display.'</option>');
1.31      albertel 8693: 	}
                   8694: 	$r->print('</select></td><td>');
1.662     bisitz   8695: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8696: 	    if (defined($samples->[$line]{$key})) { 
                   8697: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8698: 	    }
                   8699: 	}
1.594     raeburn  8700: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8701: 	$i++;
                   8702:     }
1.594     raeburn  8703:     $r->print(&end_data_table());
1.31      albertel 8704:     $i--;
                   8705:     return($i);
1.115     matthew  8706: }
                   8707: 
1.144     matthew  8708: ######################################################
                   8709: ######################################################
                   8710: 
1.115     matthew  8711: =pod
                   8712: 
1.648     raeburn  8713: =item * &clean_excel_name($name)
1.115     matthew  8714: 
                   8715: Returns a replacement for $name which does not contain any illegal characters.
                   8716: 
                   8717: =cut
                   8718: 
1.144     matthew  8719: ######################################################
                   8720: ######################################################
1.115     matthew  8721: sub clean_excel_name {
                   8722:     my ($name) = @_;
                   8723:     $name =~ s/[:\*\?\/\\]//g;
                   8724:     if (length($name) > 31) {
                   8725:         $name = substr($name,0,31);
                   8726:     }
                   8727:     return $name;
1.25      albertel 8728: }
1.84      albertel 8729: 
1.85      albertel 8730: =pod
                   8731: 
1.648     raeburn  8732: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8733: 
                   8734: Returns either 1 or undef
                   8735: 
                   8736: 1 if the part is to be hidden, undef if it is to be shown
                   8737: 
                   8738: Arguments are:
                   8739: 
                   8740: $id the id of the part to be checked
                   8741: $symb, optional the symb of the resource to check
                   8742: $udom, optional the domain of the user to check for
                   8743: $uname, optional the username of the user to check for
                   8744: 
                   8745: =cut
1.84      albertel 8746: 
                   8747: sub check_if_partid_hidden {
                   8748:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8749:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8750: 					 $symb,$udom,$uname);
1.141     albertel 8751:     my $truth=1;
                   8752:     #if the string starts with !, then the list is the list to show not hide
                   8753:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8754:     my @hiddenlist=split(/,/,$hiddenparts);
                   8755:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8756: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8757:     }
1.141     albertel 8758:     return !$truth;
1.84      albertel 8759: }
1.127     matthew  8760: 
1.138     matthew  8761: 
                   8762: ############################################################
                   8763: ############################################################
                   8764: 
                   8765: =pod
                   8766: 
1.157     matthew  8767: =back 
                   8768: 
1.138     matthew  8769: =head1 cgi-bin script and graphing routines
                   8770: 
1.157     matthew  8771: =over 4
                   8772: 
1.648     raeburn  8773: =item * &get_cgi_id()
1.138     matthew  8774: 
                   8775: Inputs: none
                   8776: 
                   8777: Returns an id which can be used to pass environment variables
                   8778: to various cgi-bin scripts.  These environment variables will
                   8779: be removed from the users environment after a given time by
                   8780: the routine &Apache::lonnet::transfer_profile_to_env.
                   8781: 
                   8782: =cut
                   8783: 
                   8784: ############################################################
                   8785: ############################################################
1.152     albertel 8786: my $uniq=0;
1.136     matthew  8787: sub get_cgi_id {
1.154     albertel 8788:     $uniq=($uniq+1)%100000;
1.280     albertel 8789:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8790: }
                   8791: 
1.127     matthew  8792: ############################################################
                   8793: ############################################################
                   8794: 
                   8795: =pod
                   8796: 
1.648     raeburn  8797: =item * &DrawBarGraph()
1.127     matthew  8798: 
1.138     matthew  8799: Facilitates the plotting of data in a (stacked) bar graph.
                   8800: Puts plot definition data into the users environment in order for 
                   8801: graph.png to plot it.  Returns an <img> tag for the plot.
                   8802: The bars on the plot are labeled '1','2',...,'n'.
                   8803: 
                   8804: Inputs:
                   8805: 
                   8806: =over 4
                   8807: 
                   8808: =item $Title: string, the title of the plot
                   8809: 
                   8810: =item $xlabel: string, text describing the X-axis of the plot
                   8811: 
                   8812: =item $ylabel: string, text describing the Y-axis of the plot
                   8813: 
                   8814: =item $Max: scalar, the maximum Y value to use in the plot
                   8815: If $Max is < any data point, the graph will not be rendered.
                   8816: 
1.140     matthew  8817: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8818: they are plotted.  If undefined, default values will be used.
                   8819: 
1.178     matthew  8820: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8821: 
1.138     matthew  8822: =item @Values: An array of array references.  Each array reference holds data
                   8823: to be plotted in a stacked bar chart.
                   8824: 
1.239     matthew  8825: =item If the final element of @Values is a hash reference the key/value
                   8826: pairs will be added to the graph definition.
                   8827: 
1.138     matthew  8828: =back
                   8829: 
                   8830: Returns:
                   8831: 
                   8832: An <img> tag which references graph.png and the appropriate identifying
                   8833: information for the plot.
                   8834: 
1.127     matthew  8835: =cut
                   8836: 
                   8837: ############################################################
                   8838: ############################################################
1.134     matthew  8839: sub DrawBarGraph {
1.178     matthew  8840:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8841:     #
                   8842:     if (! defined($colors)) {
                   8843:         $colors = ['#33ff00', 
                   8844:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8845:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8846:                   ]; 
                   8847:     }
1.228     matthew  8848:     my $extra_settings = {};
                   8849:     if (ref($Values[-1]) eq 'HASH') {
                   8850:         $extra_settings = pop(@Values);
                   8851:     }
1.127     matthew  8852:     #
1.136     matthew  8853:     my $identifier = &get_cgi_id();
                   8854:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8855:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8856:         return '';
                   8857:     }
1.225     matthew  8858:     #
                   8859:     my @Labels;
                   8860:     if (defined($labels)) {
                   8861:         @Labels = @$labels;
                   8862:     } else {
                   8863:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8864:             push (@Labels,$i+1);
                   8865:         }
                   8866:     }
                   8867:     #
1.129     matthew  8868:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8869:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8870:     my %ValuesHash;
                   8871:     my $NumSets=1;
                   8872:     foreach my $array (@Values) {
                   8873:         next if (! ref($array));
1.136     matthew  8874:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8875:             join(',',@$array);
1.129     matthew  8876:     }
1.127     matthew  8877:     #
1.136     matthew  8878:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8879:     if ($NumBars < 3) {
                   8880:         $width = 120+$NumBars*32;
1.220     matthew  8881:         $xskip = 1;
1.225     matthew  8882:         $bar_width = 30;
                   8883:     } elsif ($NumBars < 5) {
                   8884:         $width = 120+$NumBars*20;
                   8885:         $xskip = 1;
                   8886:         $bar_width = 20;
1.220     matthew  8887:     } elsif ($NumBars < 10) {
1.136     matthew  8888:         $width = 120+$NumBars*15;
                   8889:         $xskip = 1;
                   8890:         $bar_width = 15;
                   8891:     } elsif ($NumBars <= 25) {
                   8892:         $width = 120+$NumBars*11;
                   8893:         $xskip = 5;
                   8894:         $bar_width = 8;
                   8895:     } elsif ($NumBars <= 50) {
                   8896:         $width = 120+$NumBars*8;
                   8897:         $xskip = 5;
                   8898:         $bar_width = 4;
                   8899:     } else {
                   8900:         $width = 120+$NumBars*8;
                   8901:         $xskip = 5;
                   8902:         $bar_width = 4;
                   8903:     }
                   8904:     #
1.137     matthew  8905:     $Max = 1 if ($Max < 1);
                   8906:     if ( int($Max) < $Max ) {
                   8907:         $Max++;
                   8908:         $Max = int($Max);
                   8909:     }
1.127     matthew  8910:     $Title  = '' if (! defined($Title));
                   8911:     $xlabel = '' if (! defined($xlabel));
                   8912:     $ylabel = '' if (! defined($ylabel));
1.369     www      8913:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8914:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8915:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8916:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8917:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8918:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8919:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8920:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8921:     $ValuesHash{$id.'.height'}   = $height;
                   8922:     $ValuesHash{$id.'.width'}    = $width;
                   8923:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8924:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8925:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8926:     #
1.228     matthew  8927:     # Deal with other parameters
                   8928:     while (my ($key,$value) = each(%$extra_settings)) {
                   8929:         $ValuesHash{$id.'.'.$key} = $value;
                   8930:     }
                   8931:     #
1.646     raeburn  8932:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8933:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8934: }
                   8935: 
                   8936: ############################################################
                   8937: ############################################################
                   8938: 
                   8939: =pod
                   8940: 
1.648     raeburn  8941: =item * &DrawXYGraph()
1.137     matthew  8942: 
1.138     matthew  8943: Facilitates the plotting of data in an XY graph.
                   8944: Puts plot definition data into the users environment in order for 
                   8945: graph.png to plot it.  Returns an <img> tag for the plot.
                   8946: 
                   8947: Inputs:
                   8948: 
                   8949: =over 4
                   8950: 
                   8951: =item $Title: string, the title of the plot
                   8952: 
                   8953: =item $xlabel: string, text describing the X-axis of the plot
                   8954: 
                   8955: =item $ylabel: string, text describing the Y-axis of the plot
                   8956: 
                   8957: =item $Max: scalar, the maximum Y value to use in the plot
                   8958: If $Max is < any data point, the graph will not be rendered.
                   8959: 
                   8960: =item $colors: Array ref containing the hex color codes for the data to be 
                   8961: plotted in.  If undefined, default values will be used.
                   8962: 
                   8963: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   8964: 
                   8965: =item $Ydata: Array ref containing Array refs.  
1.185     www      8966: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  8967: 
                   8968: =item %Values: hash indicating or overriding any default values which are 
                   8969: passed to graph.png.  
                   8970: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   8971: 
                   8972: =back
                   8973: 
                   8974: Returns:
                   8975: 
                   8976: An <img> tag which references graph.png and the appropriate identifying
                   8977: information for the plot.
                   8978: 
1.137     matthew  8979: =cut
                   8980: 
                   8981: ############################################################
                   8982: ############################################################
                   8983: sub DrawXYGraph {
                   8984:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   8985:     #
                   8986:     # Create the identifier for the graph
                   8987:     my $identifier = &get_cgi_id();
                   8988:     my $id = 'cgi.'.$identifier;
                   8989:     #
                   8990:     $Title  = '' if (! defined($Title));
                   8991:     $xlabel = '' if (! defined($xlabel));
                   8992:     $ylabel = '' if (! defined($ylabel));
                   8993:     my %ValuesHash = 
                   8994:         (
1.369     www      8995:          $id.'.title'  => &escape($Title),
                   8996:          $id.'.xlabel' => &escape($xlabel),
                   8997:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  8998:          $id.'.y_max_value'=> $Max,
                   8999:          $id.'.labels'     => join(',',@$Xlabels),
                   9000:          $id.'.PlotType'   => 'XY',
                   9001:          );
                   9002:     #
                   9003:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9004:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9005:     }
                   9006:     #
                   9007:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9008:         return '';
                   9009:     }
                   9010:     my $NumSets=1;
1.138     matthew  9011:     foreach my $array (@{$Ydata}){
1.137     matthew  9012:         next if (! ref($array));
                   9013:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9014:     }
1.138     matthew  9015:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9016:     #
                   9017:     # Deal with other parameters
                   9018:     while (my ($key,$value) = each(%Values)) {
                   9019:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9020:     }
                   9021:     #
1.646     raeburn  9022:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9023:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9024: }
                   9025: 
                   9026: ############################################################
                   9027: ############################################################
                   9028: 
                   9029: =pod
                   9030: 
1.648     raeburn  9031: =item * &DrawXYYGraph()
1.138     matthew  9032: 
                   9033: Facilitates the plotting of data in an XY graph with two Y axes.
                   9034: Puts plot definition data into the users environment in order for 
                   9035: graph.png to plot it.  Returns an <img> tag for the plot.
                   9036: 
                   9037: Inputs:
                   9038: 
                   9039: =over 4
                   9040: 
                   9041: =item $Title: string, the title of the plot
                   9042: 
                   9043: =item $xlabel: string, text describing the X-axis of the plot
                   9044: 
                   9045: =item $ylabel: string, text describing the Y-axis of the plot
                   9046: 
                   9047: =item $colors: Array ref containing the hex color codes for the data to be 
                   9048: plotted in.  If undefined, default values will be used.
                   9049: 
                   9050: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9051: 
                   9052: =item $Ydata1: The first data set
                   9053: 
                   9054: =item $Min1: The minimum value of the left Y-axis
                   9055: 
                   9056: =item $Max1: The maximum value of the left Y-axis
                   9057: 
                   9058: =item $Ydata2: The second data set
                   9059: 
                   9060: =item $Min2: The minimum value of the right Y-axis
                   9061: 
                   9062: =item $Max2: The maximum value of the left Y-axis
                   9063: 
                   9064: =item %Values: hash indicating or overriding any default values which are 
                   9065: passed to graph.png.  
                   9066: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9067: 
                   9068: =back
                   9069: 
                   9070: Returns:
                   9071: 
                   9072: An <img> tag which references graph.png and the appropriate identifying
                   9073: information for the plot.
1.136     matthew  9074: 
                   9075: =cut
                   9076: 
                   9077: ############################################################
                   9078: ############################################################
1.137     matthew  9079: sub DrawXYYGraph {
                   9080:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9081:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9082:     #
                   9083:     # Create the identifier for the graph
                   9084:     my $identifier = &get_cgi_id();
                   9085:     my $id = 'cgi.'.$identifier;
                   9086:     #
                   9087:     $Title  = '' if (! defined($Title));
                   9088:     $xlabel = '' if (! defined($xlabel));
                   9089:     $ylabel = '' if (! defined($ylabel));
                   9090:     my %ValuesHash = 
                   9091:         (
1.369     www      9092:          $id.'.title'  => &escape($Title),
                   9093:          $id.'.xlabel' => &escape($xlabel),
                   9094:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9095:          $id.'.labels' => join(',',@$Xlabels),
                   9096:          $id.'.PlotType' => 'XY',
                   9097:          $id.'.NumSets' => 2,
1.137     matthew  9098:          $id.'.two_axes' => 1,
                   9099:          $id.'.y1_max_value' => $Max1,
                   9100:          $id.'.y1_min_value' => $Min1,
                   9101:          $id.'.y2_max_value' => $Max2,
                   9102:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9103:          );
                   9104:     #
1.137     matthew  9105:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9106:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9107:     }
                   9108:     #
                   9109:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9110:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9111:         return '';
                   9112:     }
                   9113:     my $NumSets=1;
1.137     matthew  9114:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9115:         next if (! ref($array));
                   9116:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9117:     }
                   9118:     #
                   9119:     # Deal with other parameters
                   9120:     while (my ($key,$value) = each(%Values)) {
                   9121:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9122:     }
                   9123:     #
1.646     raeburn  9124:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9125:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9126: }
                   9127: 
                   9128: ############################################################
                   9129: ############################################################
                   9130: 
                   9131: =pod
                   9132: 
1.157     matthew  9133: =back 
                   9134: 
1.139     matthew  9135: =head1 Statistics helper routines?  
                   9136: 
                   9137: Bad place for them but what the hell.
                   9138: 
1.157     matthew  9139: =over 4
                   9140: 
1.648     raeburn  9141: =item * &chartlink()
1.139     matthew  9142: 
                   9143: Returns a link to the chart for a specific student.  
                   9144: 
                   9145: Inputs:
                   9146: 
                   9147: =over 4
                   9148: 
                   9149: =item $linktext: The text of the link
                   9150: 
                   9151: =item $sname: The students username
                   9152: 
                   9153: =item $sdomain: The students domain
                   9154: 
                   9155: =back
                   9156: 
1.157     matthew  9157: =back
                   9158: 
1.139     matthew  9159: =cut
                   9160: 
                   9161: ############################################################
                   9162: ############################################################
                   9163: sub chartlink {
                   9164:     my ($linktext, $sname, $sdomain) = @_;
                   9165:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9166:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9167:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9168:        '">'.$linktext.'</a>';
1.153     matthew  9169: }
                   9170: 
                   9171: #######################################################
                   9172: #######################################################
                   9173: 
                   9174: =pod
                   9175: 
                   9176: =head1 Course Environment Routines
1.157     matthew  9177: 
                   9178: =over 4
1.153     matthew  9179: 
1.648     raeburn  9180: =item * &restore_course_settings()
1.153     matthew  9181: 
1.648     raeburn  9182: =item * &store_course_settings()
1.153     matthew  9183: 
                   9184: Restores/Store indicated form parameters from the course environment.
                   9185: Will not overwrite existing values of the form parameters.
                   9186: 
                   9187: Inputs: 
                   9188: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9189: 
                   9190: a hash ref describing the data to be stored.  For example:
                   9191:    
                   9192: %Save_Parameters = ('Status' => 'scalar',
                   9193:     'chartoutputmode' => 'scalar',
                   9194:     'chartoutputdata' => 'scalar',
                   9195:     'Section' => 'array',
1.373     raeburn  9196:     'Group' => 'array',
1.153     matthew  9197:     'StudentData' => 'array',
                   9198:     'Maps' => 'array');
                   9199: 
                   9200: Returns: both routines return nothing
                   9201: 
1.631     raeburn  9202: =back
                   9203: 
1.153     matthew  9204: =cut
                   9205: 
                   9206: #######################################################
                   9207: #######################################################
                   9208: sub store_course_settings {
1.496     albertel 9209:     return &store_settings($env{'request.course.id'},@_);
                   9210: }
                   9211: 
                   9212: sub store_settings {
1.153     matthew  9213:     # save to the environment
                   9214:     # appenv the same items, just to be safe
1.300     albertel 9215:     my $udom  = $env{'user.domain'};
                   9216:     my $uname = $env{'user.name'};
1.496     albertel 9217:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9218:     my %SaveHash;
                   9219:     my %AppHash;
                   9220:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9221:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9222:         my $envname = 'environment.'.$basename;
1.258     albertel 9223:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9224:             # Save this value away
                   9225:             if ($type eq 'scalar' &&
1.258     albertel 9226:                 (! exists($env{$envname}) || 
                   9227:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9228:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9229:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9230:             } elsif ($type eq 'array') {
                   9231:                 my $stored_form;
1.258     albertel 9232:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9233:                     $stored_form = join(',',
                   9234:                                         map {
1.369     www      9235:                                             &escape($_);
1.258     albertel 9236:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9237:                 } else {
                   9238:                     $stored_form = 
1.369     www      9239:                         &escape($env{'form.'.$setting});
1.153     matthew  9240:                 }
                   9241:                 # Determine if the array contents are the same.
1.258     albertel 9242:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9243:                     $SaveHash{$basename} = $stored_form;
                   9244:                     $AppHash{$envname}   = $stored_form;
                   9245:                 }
                   9246:             }
                   9247:         }
                   9248:     }
                   9249:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9250:                                           $udom,$uname);
1.153     matthew  9251:     if ($put_result !~ /^(ok|delayed)/) {
                   9252:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9253:                                  'got error:'.$put_result);
                   9254:     }
                   9255:     # Make sure these settings stick around in this session, too
1.646     raeburn  9256:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9257:     return;
                   9258: }
                   9259: 
                   9260: sub restore_course_settings {
1.499     albertel 9261:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9262: }
                   9263: 
                   9264: sub restore_settings {
                   9265:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9266:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9267:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9268:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9269:             '.'.$setting;
1.258     albertel 9270:         if (exists($env{$envname})) {
1.153     matthew  9271:             if ($type eq 'scalar') {
1.258     albertel 9272:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9273:             } elsif ($type eq 'array') {
1.258     albertel 9274:                 $env{'form.'.$setting} = [ 
1.153     matthew  9275:                                            map { 
1.369     www      9276:                                                &unescape($_); 
1.258     albertel 9277:                                            } split(',',$env{$envname})
1.153     matthew  9278:                                            ];
                   9279:             }
                   9280:         }
                   9281:     }
1.127     matthew  9282: }
                   9283: 
1.618     raeburn  9284: #######################################################
                   9285: #######################################################
                   9286: 
                   9287: =pod
                   9288: 
                   9289: =head1 Domain E-mail Routines  
                   9290: 
                   9291: =over 4
                   9292: 
1.648     raeburn  9293: =item * &build_recipient_list()
1.618     raeburn  9294: 
1.884     raeburn  9295: Build recipient lists for five types of e-mail:
1.766     raeburn  9296: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9297: (d) Help requests, (e) Course requests needing approval,  generated by
                   9298: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9299: loncoursequeueadmin.pm respectively.
1.618     raeburn  9300: 
                   9301: Inputs:
1.619     raeburn  9302: defmail (scalar - email address of default recipient), 
1.618     raeburn  9303: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9304: defdom (domain for which to retrieve configuration settings),
                   9305: origmail (scalar - email address of recipient from loncapa.conf, 
                   9306: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9307: 
1.655     raeburn  9308: Returns: comma separated list of addresses to which to send e-mail.
                   9309: 
                   9310: =back
1.618     raeburn  9311: 
                   9312: =cut
                   9313: 
                   9314: ############################################################
                   9315: ############################################################
                   9316: sub build_recipient_list {
1.619     raeburn  9317:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9318:     my @recipients;
                   9319:     my $otheremails;
                   9320:     my %domconfig =
                   9321:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9322:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9323:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9324:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9325:                 my @contacts = ('adminemail','supportemail');
                   9326:                 foreach my $item (@contacts) {
                   9327:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9328:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9329:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9330:                             push(@recipients,$addr);
                   9331:                         }
1.619     raeburn  9332:                     }
1.766     raeburn  9333:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9334:                 }
                   9335:             }
1.766     raeburn  9336:         } elsif ($origmail ne '') {
                   9337:             push(@recipients,$origmail);
1.618     raeburn  9338:         }
1.619     raeburn  9339:     } elsif ($origmail ne '') {
                   9340:         push(@recipients,$origmail);
1.618     raeburn  9341:     }
1.688     raeburn  9342:     if (defined($defmail)) {
                   9343:         if ($defmail ne '') {
                   9344:             push(@recipients,$defmail);
                   9345:         }
1.618     raeburn  9346:     }
                   9347:     if ($otheremails) {
1.619     raeburn  9348:         my @others;
                   9349:         if ($otheremails =~ /,/) {
                   9350:             @others = split(/,/,$otheremails);
1.618     raeburn  9351:         } else {
1.619     raeburn  9352:             push(@others,$otheremails);
                   9353:         }
                   9354:         foreach my $addr (@others) {
                   9355:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9356:                 push(@recipients,$addr);
                   9357:             }
1.618     raeburn  9358:         }
                   9359:     }
1.619     raeburn  9360:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9361:     return $recipientlist;
                   9362: }
                   9363: 
1.127     matthew  9364: ############################################################
                   9365: ############################################################
1.154     albertel 9366: 
1.655     raeburn  9367: =pod
                   9368: 
                   9369: =head1 Course Catalog Routines
                   9370: 
                   9371: =over 4
                   9372: 
                   9373: =item * &gather_categories()
                   9374: 
                   9375: Converts category definitions - keys of categories hash stored in  
                   9376: coursecategories in configuration.db on the primary library server in a 
                   9377: domain - to an array.  Also generates javascript and idx hash used to 
                   9378: generate Domain Coordinator interface for editing Course Categories.
                   9379: 
                   9380: Inputs:
1.663     raeburn  9381: 
1.655     raeburn  9382: categories (reference to hash of category definitions).
1.663     raeburn  9383: 
1.655     raeburn  9384: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9385:       categories and subcategories).
1.663     raeburn  9386: 
1.655     raeburn  9387: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9388:       editing Course Categories).
1.663     raeburn  9389: 
1.655     raeburn  9390: jsarray (reference to array of categories used to create Javascript arrays for
                   9391:          Domain Coordinator interface for editing Course Categories).
                   9392: 
                   9393: Returns: nothing
                   9394: 
                   9395: Side effects: populates cats, idx and jsarray. 
                   9396: 
                   9397: =cut
                   9398: 
                   9399: sub gather_categories {
                   9400:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9401:     my %counters;
                   9402:     my $num = 0;
                   9403:     foreach my $item (keys(%{$categories})) {
                   9404:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9405:         if ($container eq '' && $depth == 0) {
                   9406:             $cats->[$depth][$categories->{$item}] = $cat;
                   9407:         } else {
                   9408:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9409:         }
                   9410:         my ($escitem,$tail) = split(/:/,$item,2);
                   9411:         if ($counters{$tail} eq '') {
                   9412:             $counters{$tail} = $num;
                   9413:             $num ++;
                   9414:         }
                   9415:         if (ref($idx) eq 'HASH') {
                   9416:             $idx->{$item} = $counters{$tail};
                   9417:         }
                   9418:         if (ref($jsarray) eq 'ARRAY') {
                   9419:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9420:         }
                   9421:     }
                   9422:     return;
                   9423: }
                   9424: 
                   9425: =pod
                   9426: 
                   9427: =item * &extract_categories()
                   9428: 
                   9429: Used to generate breadcrumb trails for course categories.
                   9430: 
                   9431: Inputs:
1.663     raeburn  9432: 
1.655     raeburn  9433: categories (reference to hash of category definitions).
1.663     raeburn  9434: 
1.655     raeburn  9435: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9436:       categories and subcategories).
1.663     raeburn  9437: 
1.655     raeburn  9438: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9439: 
1.655     raeburn  9440: allitems (reference to hash - key is category key 
                   9441:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9442: 
1.655     raeburn  9443: idx (reference to hash of counters used in Domain Coordinator interface for
                   9444:       editing Course Categories).
1.663     raeburn  9445: 
1.655     raeburn  9446: jsarray (reference to array of categories used to create Javascript arrays for
                   9447:          Domain Coordinator interface for editing Course Categories).
                   9448: 
1.665     raeburn  9449: subcats (reference to hash of arrays containing all subcategories within each 
                   9450:          category, -recursive)
                   9451: 
1.655     raeburn  9452: Returns: nothing
                   9453: 
                   9454: Side effects: populates trails and allitems hash references.
                   9455: 
                   9456: =cut
                   9457: 
                   9458: sub extract_categories {
1.665     raeburn  9459:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9460:     if (ref($categories) eq 'HASH') {
                   9461:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9462:         if (ref($cats->[0]) eq 'ARRAY') {
                   9463:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9464:                 my $name = $cats->[0][$i];
                   9465:                 my $item = &escape($name).'::0';
                   9466:                 my $trailstr;
                   9467:                 if ($name eq 'instcode') {
                   9468:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9469:                 } else {
                   9470:                     $trailstr = $name;
                   9471:                 }
                   9472:                 if ($allitems->{$item} eq '') {
                   9473:                     push(@{$trails},$trailstr);
                   9474:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9475:                 }
                   9476:                 my @parents = ($name);
                   9477:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9478:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9479:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9480:                         if (ref($subcats) eq 'HASH') {
                   9481:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9482:                         }
                   9483:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9484:                     }
                   9485:                 } else {
                   9486:                     if (ref($subcats) eq 'HASH') {
                   9487:                         $subcats->{$item} = [];
1.655     raeburn  9488:                     }
                   9489:                 }
                   9490:             }
                   9491:         }
                   9492:     }
                   9493:     return;
                   9494: }
                   9495: 
                   9496: =pod
                   9497: 
                   9498: =item *&recurse_categories()
                   9499: 
                   9500: Recursively used to generate breadcrumb trails for course categories.
                   9501: 
                   9502: Inputs:
1.663     raeburn  9503: 
1.655     raeburn  9504: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9505:       categories and subcategories).
1.663     raeburn  9506: 
1.655     raeburn  9507: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9508: 
                   9509: category (current course category, for which breadcrumb trail is being generated).
                   9510: 
                   9511: trails (reference to array of breadcrumb trails for each category).
                   9512: 
1.655     raeburn  9513: allitems (reference to hash - key is category key
                   9514:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9515: 
1.655     raeburn  9516: parents (array containing containers directories for current category, 
                   9517:          back to top level). 
                   9518: 
                   9519: Returns: nothing
                   9520: 
                   9521: Side effects: populates trails and allitems hash references
                   9522: 
                   9523: =cut
                   9524: 
                   9525: sub recurse_categories {
1.665     raeburn  9526:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9527:     my $shallower = $depth - 1;
                   9528:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9529:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9530:             my $name = $cats->[$depth]{$category}[$k];
                   9531:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9532:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9533:             if ($allitems->{$item} eq '') {
                   9534:                 push(@{$trails},$trailstr);
                   9535:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9536:             }
                   9537:             my $deeper = $depth+1;
                   9538:             push(@{$parents},$category);
1.665     raeburn  9539:             if (ref($subcats) eq 'HASH') {
                   9540:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9541:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9542:                     my $higher;
                   9543:                     if ($j > 0) {
                   9544:                         $higher = &escape($parents->[$j]).':'.
                   9545:                                   &escape($parents->[$j-1]).':'.$j;
                   9546:                     } else {
                   9547:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9548:                     }
                   9549:                     push(@{$subcats->{$higher}},$subcat);
                   9550:                 }
                   9551:             }
                   9552:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9553:                                 $subcats);
1.655     raeburn  9554:             pop(@{$parents});
                   9555:         }
                   9556:     } else {
                   9557:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9558:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9559:         if ($allitems->{$item} eq '') {
                   9560:             push(@{$trails},$trailstr);
                   9561:             $allitems->{$item} = scalar(@{$trails})-1;
                   9562:         }
                   9563:     }
                   9564:     return;
                   9565: }
                   9566: 
1.663     raeburn  9567: =pod
                   9568: 
                   9569: =item *&assign_categories_table()
                   9570: 
                   9571: Create a datatable for display of hierarchical categories in a domain,
                   9572: with checkboxes to allow a course to be categorized. 
                   9573: 
                   9574: Inputs:
                   9575: 
                   9576: cathash - reference to hash of categories defined for the domain (from
                   9577:           configuration.db)
                   9578: 
                   9579: currcat - scalar with an & separated list of categories assigned to a course. 
                   9580: 
                   9581: Returns: $output (markup to be displayed) 
                   9582: 
                   9583: =cut
                   9584: 
                   9585: sub assign_categories_table {
                   9586:     my ($cathash,$currcat) = @_;
                   9587:     my $output;
                   9588:     if (ref($cathash) eq 'HASH') {
                   9589:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9590:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9591:         $maxdepth = scalar(@cats);
                   9592:         if (@cats > 0) {
                   9593:             my $itemcount = 0;
                   9594:             if (ref($cats[0]) eq 'ARRAY') {
                   9595:                 $output = &Apache::loncommon::start_data_table();
                   9596:                 my @currcategories;
                   9597:                 if ($currcat ne '') {
                   9598:                     @currcategories = split('&',$currcat);
                   9599:                 }
                   9600:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9601:                     my $parent = $cats[0][$i];
                   9602:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9603:                     next if ($parent eq 'instcode');
                   9604:                     my $item = &escape($parent).'::0';
                   9605:                     my $checked = '';
                   9606:                     if (@currcategories > 0) {
                   9607:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9608:                             $checked = ' checked="checked"';
1.663     raeburn  9609:                         }
                   9610:                     }
1.675     raeburn  9611:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9612:                                '<input type="checkbox" name="usecategory" value="'.
                   9613:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9614:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9615:                     my $depth = 1;
                   9616:                     push(@path,$parent);
                   9617:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9618:                     pop(@path);
                   9619:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9620:                     $itemcount ++;
                   9621:                 }
                   9622:                 $output .= &Apache::loncommon::end_data_table();
                   9623:             }
                   9624:         }
                   9625:     }
                   9626:     return $output;
                   9627: }
                   9628: 
                   9629: =pod
                   9630: 
                   9631: =item *&assign_category_rows()
                   9632: 
                   9633: Create a datatable row for display of nested categories in a domain,
                   9634: with checkboxes to allow a course to be categorized,called recursively.
                   9635: 
                   9636: Inputs:
                   9637: 
                   9638: itemcount - track row number for alternating colors
                   9639: 
                   9640: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9641:       categories and subcategories.
                   9642: 
                   9643: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9644: 
                   9645: parent - parent of current category item
                   9646: 
                   9647: path - Array containing all categories back up through the hierarchy from the
                   9648:        current category to the top level.
                   9649: 
                   9650: currcategories - reference to array of current categories assigned to the course
                   9651: 
                   9652: Returns: $output (markup to be displayed).
                   9653: 
                   9654: =cut
                   9655: 
                   9656: sub assign_category_rows {
                   9657:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9658:     my ($text,$name,$item,$chgstr);
                   9659:     if (ref($cats) eq 'ARRAY') {
                   9660:         my $maxdepth = scalar(@{$cats});
                   9661:         if (ref($cats->[$depth]) eq 'HASH') {
                   9662:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9663:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9664:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9665:                 $text .= '<td><table class="LC_datatable">';
                   9666:                 for (my $j=0; $j<$numchildren; $j++) {
                   9667:                     $name = $cats->[$depth]{$parent}[$j];
                   9668:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9669:                     my $deeper = $depth+1;
                   9670:                     my $checked = '';
                   9671:                     if (ref($currcategories) eq 'ARRAY') {
                   9672:                         if (@{$currcategories} > 0) {
                   9673:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9674:                                 $checked = ' checked="checked"';
1.663     raeburn  9675:                             }
                   9676:                         }
                   9677:                     }
1.664     raeburn  9678:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9679:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9680:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9681:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9682:                              '</td><td>';
1.663     raeburn  9683:                     if (ref($path) eq 'ARRAY') {
                   9684:                         push(@{$path},$name);
                   9685:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9686:                         pop(@{$path});
                   9687:                     }
                   9688:                     $text .= '</td></tr>';
                   9689:                 }
                   9690:                 $text .= '</table></td>';
                   9691:             }
                   9692:         }
                   9693:     }
                   9694:     return $text;
                   9695: }
                   9696: 
1.655     raeburn  9697: ############################################################
                   9698: ############################################################
                   9699: 
                   9700: 
1.443     albertel 9701: sub commit_customrole {
1.664     raeburn  9702:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9703:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9704:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9705:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9706:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9707:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9708:                  '</b><br />';
                   9709:     return $output;
                   9710: }
                   9711: 
                   9712: sub commit_standardrole {
1.541     raeburn  9713:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9714:     my ($output,$logmsg,$linefeed);
                   9715:     if ($context eq 'auto') {
                   9716:         $linefeed = "\n";
                   9717:     } else {
                   9718:         $linefeed = "<br />\n";
                   9719:     }  
1.443     albertel 9720:     if ($three eq 'st') {
1.541     raeburn  9721:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9722:                                          $one,$two,$sec,$context);
                   9723:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9724:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9725:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9726:         } else {
1.541     raeburn  9727:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9728:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9729:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9730:             if ($context eq 'auto') {
                   9731:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9732:             } else {
                   9733:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9734:                &mt('Add to classlist').': <b>ok</b>';
                   9735:             }
                   9736:             $output .= $linefeed;
1.443     albertel 9737:         }
                   9738:     } else {
                   9739:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9740:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9741:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9742:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9743:         if ($context eq 'auto') {
                   9744:             $output .= $result.$linefeed;
                   9745:         } else {
                   9746:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9747:         }
1.443     albertel 9748:     }
                   9749:     return $output;
                   9750: }
                   9751: 
                   9752: sub commit_studentrole {
1.541     raeburn  9753:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9754:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9755:     if ($context eq 'auto') {
                   9756:         $linefeed = "\n";
                   9757:     } else {
                   9758:         $linefeed = '<br />'."\n";
                   9759:     }
1.443     albertel 9760:     if (defined($one) && defined($two)) {
                   9761:         my $cid=$one.'_'.$two;
                   9762:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9763:         my $secchange = 0;
                   9764:         my $expire_role_result;
                   9765:         my $modify_section_result;
1.628     raeburn  9766:         if ($oldsec ne '-1') { 
                   9767:             if ($oldsec ne $sec) {
1.443     albertel 9768:                 $secchange = 1;
1.628     raeburn  9769:                 my $now = time;
1.443     albertel 9770:                 my $uurl='/'.$cid;
                   9771:                 $uurl=~s/\_/\//g;
                   9772:                 if ($oldsec) {
                   9773:                     $uurl.='/'.$oldsec;
                   9774:                 }
1.626     raeburn  9775:                 $oldsecurl = $uurl;
1.628     raeburn  9776:                 $expire_role_result = 
1.652     raeburn  9777:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9778:                 if ($env{'request.course.sec'} ne '') { 
                   9779:                     if ($expire_role_result eq 'refused') {
                   9780:                         my @roles = ('st');
                   9781:                         my @statuses = ('previous');
                   9782:                         my @roledoms = ($one);
                   9783:                         my $withsec = 1;
                   9784:                         my %roleshash = 
                   9785:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9786:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9787:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9788:                             my ($oldstart,$oldend) = 
                   9789:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9790:                             if ($oldend > 0 && $oldend <= $now) {
                   9791:                                 $expire_role_result = 'ok';
                   9792:                             }
                   9793:                         }
                   9794:                     }
                   9795:                 }
1.443     albertel 9796:                 $result = $expire_role_result;
                   9797:             }
                   9798:         }
                   9799:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9800:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9801:             if ($modify_section_result =~ /^ok/) {
                   9802:                 if ($secchange == 1) {
1.628     raeburn  9803:                     if ($sec eq '') {
                   9804:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9805:                     } else {
                   9806:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9807:                     }
1.443     albertel 9808:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9809:                     if ($sec eq '') {
                   9810:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9811:                     } else {
                   9812:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9813:                     }
1.443     albertel 9814:                 } else {
1.628     raeburn  9815:                     if ($sec eq '') {
                   9816:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9817:                     } else {
                   9818:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9819:                     }
1.443     albertel 9820:                 }
                   9821:             } else {
1.628     raeburn  9822:                 if ($secchange) {       
                   9823:                     $$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;
                   9824:                 } else {
                   9825:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9826:                 }
1.443     albertel 9827:             }
                   9828:             $result = $modify_section_result;
                   9829:         } elsif ($secchange == 1) {
1.628     raeburn  9830:             if ($oldsec eq '') {
                   9831:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9832:             } else {
                   9833:                 $$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;
                   9834:             }
1.626     raeburn  9835:             if ($expire_role_result eq 'refused') {
                   9836:                 my $newsecurl = '/'.$cid;
                   9837:                 $newsecurl =~ s/\_/\//g;
                   9838:                 if ($sec ne '') {
                   9839:                     $newsecurl.='/'.$sec;
                   9840:                 }
                   9841:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9842:                     if ($sec eq '') {
                   9843:                         $$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;
                   9844:                     } else {
                   9845:                         $$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;
                   9846:                     }
                   9847:                 }
                   9848:             }
1.443     albertel 9849:         }
                   9850:     } else {
1.626     raeburn  9851:         $$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 9852:         $result = "error: incomplete course id\n";
                   9853:     }
                   9854:     return $result;
                   9855: }
                   9856: 
                   9857: ############################################################
                   9858: ############################################################
                   9859: 
1.566     albertel 9860: sub check_clone {
1.578     raeburn  9861:     my ($args,$linefeed) = @_;
1.566     albertel 9862:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9863:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9864:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9865:     my $clonemsg;
                   9866:     my $can_clone = 0;
                   9867: 
                   9868:     if ($clonehome eq 'no_host') {
1.578     raeburn  9869:         $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 9870:     } else {
                   9871: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.882     raeburn  9872: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   9873:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 9874: 	    $can_clone = 1;
                   9875: 	} else {
                   9876: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9877: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9878: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9879:             if (grep(/^\*$/,@cloners)) {
                   9880:                 $can_clone = 1;
                   9881:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9882:                 $can_clone = 1;
                   9883:             } else {
                   9884: 	        my %roleshash =
                   9885: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9886: 					 $args->{'ccdomain'},
                   9887:                                          'userroles',['active'],['cc'],
                   9888: 					 [$args->{'clonedomain'}]);
                   9889: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
                   9890: 		    $can_clone = 1;
                   9891: 	        } else {
                   9892:                     $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'});
                   9893: 	        }
1.566     albertel 9894: 	    }
1.578     raeburn  9895:         }
1.566     albertel 9896:     }
                   9897:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9898: }
                   9899: 
1.444     albertel 9900: sub construct_course {
1.885     raeburn  9901:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 9902:     my $outcome;
1.541     raeburn  9903:     my $linefeed =  '<br />'."\n";
                   9904:     if ($context eq 'auto') {
                   9905:         $linefeed = "\n";
                   9906:     }
1.566     albertel 9907: 
                   9908: #
                   9909: # Are we cloning?
                   9910: #
                   9911:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9912:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9913: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 9914: 	if ($context ne 'auto') {
1.578     raeburn  9915:             if ($clonemsg ne '') {
                   9916: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   9917:             }
1.566     albertel 9918: 	}
                   9919: 	$outcome .= $clonemsg.$linefeed;
                   9920: 
                   9921:         if (!$can_clone) {
                   9922: 	    return (0,$outcome);
                   9923: 	}
                   9924:     }
                   9925: 
1.444     albertel 9926: #
                   9927: # Open course
                   9928: #
                   9929:     my $crstype = lc($args->{'crstype'});
                   9930:     my %cenv=();
                   9931:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   9932:                                              $args->{'cdescr'},
                   9933:                                              $args->{'curl'},
                   9934:                                              $args->{'course_home'},
                   9935:                                              $args->{'nonstandard'},
                   9936:                                              $args->{'crscode'},
                   9937:                                              $args->{'ccuname'}.':'.
                   9938:                                              $args->{'ccdomain'},
1.882     raeburn  9939:                                              $args->{'crstype'},
1.885     raeburn  9940:                                              $cnum,$context,$category);
1.444     albertel 9941: 
                   9942:     # Note: The testing routines depend on this being output; see 
                   9943:     # Utils::Course. This needs to at least be output as a comment
                   9944:     # if anyone ever decides to not show this, and Utils::Course::new
                   9945:     # will need to be suitably modified.
1.541     raeburn  9946:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 9947: #
                   9948: # Check if created correctly
                   9949: #
1.479     albertel 9950:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 9951:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  9952:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 9953: 
1.444     albertel 9954: #
1.566     albertel 9955: # Do the cloning
                   9956: #   
                   9957:     if ($can_clone && $cloneid) {
                   9958: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   9959: 	if ($context ne 'auto') {
                   9960: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   9961: 	}
                   9962: 	$outcome .= $clonemsg.$linefeed;
                   9963: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 9964: # Copy all files
1.637     www      9965: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 9966: # Restore URL
1.566     albertel 9967: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 9968: # Restore title
1.566     albertel 9969: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 9970: # Mark as cloned
1.566     albertel 9971: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      9972: # Need to clone grading mode
                   9973:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   9974:         $cenv{'grading'}=$newenv{'grading'};
                   9975: # Do not clone these environment entries
                   9976:         &Apache::lonnet::del('environment',
                   9977:                   ['default_enrollment_start_date',
                   9978:                    'default_enrollment_end_date',
                   9979:                    'question.email',
                   9980:                    'policy.email',
                   9981:                    'comment.email',
                   9982:                    'pch.users.denied',
1.725     raeburn  9983:                    'plc.users.denied',
                   9984:                    'hidefromcat',
                   9985:                    'categories'],
1.638     www      9986:                    $$crsudom,$$crsunum);
1.444     albertel 9987:     }
1.566     albertel 9988: 
1.444     albertel 9989: #
                   9990: # Set environment (will override cloned, if existing)
                   9991: #
                   9992:     my @sections = ();
                   9993:     my @xlists = ();
                   9994:     if ($args->{'crstype'}) {
                   9995:         $cenv{'type'}=$args->{'crstype'};
                   9996:     }
                   9997:     if ($args->{'crsid'}) {
                   9998:         $cenv{'courseid'}=$args->{'crsid'};
                   9999:     }
                   10000:     if ($args->{'crscode'}) {
                   10001:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10002:     }
                   10003:     if ($args->{'crsquota'} ne '') {
                   10004:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10005:     } else {
                   10006:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10007:     }
                   10008:     if ($args->{'ccuname'}) {
                   10009:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10010:                                         ':'.$args->{'ccdomain'};
                   10011:     } else {
                   10012:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10013:     }
                   10014:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10015:     if ($args->{'crssections'}) {
                   10016:         $cenv{'internal.sectionnums'} = '';
                   10017:         if ($args->{'crssections'} =~ m/,/) {
                   10018:             @sections = split/,/,$args->{'crssections'};
                   10019:         } else {
                   10020:             $sections[0] = $args->{'crssections'};
                   10021:         }
                   10022:         if (@sections > 0) {
                   10023:             foreach my $item (@sections) {
                   10024:                 my ($sec,$gp) = split/:/,$item;
                   10025:                 my $class = $args->{'crscode'}.$sec;
                   10026:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10027:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10028:                 unless ($addcheck eq 'ok') {
                   10029:                     push @badclasses, $class;
                   10030:                 }
                   10031:             }
                   10032:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10033:         }
                   10034:     }
                   10035: # do not hide course coordinator from staff listing, 
                   10036: # even if privileged
                   10037:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10038: # add crosslistings
                   10039:     if ($args->{'crsxlist'}) {
                   10040:         $cenv{'internal.crosslistings'}='';
                   10041:         if ($args->{'crsxlist'} =~ m/,/) {
                   10042:             @xlists = split/,/,$args->{'crsxlist'};
                   10043:         } else {
                   10044:             $xlists[0] = $args->{'crsxlist'};
                   10045:         }
                   10046:         if (@xlists > 0) {
                   10047:             foreach my $item (@xlists) {
                   10048:                 my ($xl,$gp) = split/:/,$item;
                   10049:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10050:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10051:                 unless ($addcheck eq 'ok') {
                   10052:                     push @badclasses, $xl;
                   10053:                 }
                   10054:             }
                   10055:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10056:         }
                   10057:     }
                   10058:     if ($args->{'autoadds'}) {
                   10059:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10060:     }
                   10061:     if ($args->{'autodrops'}) {
                   10062:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10063:     }
                   10064: # check for notification of enrollment changes
                   10065:     my @notified = ();
                   10066:     if ($args->{'notify_owner'}) {
                   10067:         if ($args->{'ccuname'} ne '') {
                   10068:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10069:         }
                   10070:     }
                   10071:     if ($args->{'notify_dc'}) {
                   10072:         if ($uname ne '') { 
1.630     raeburn  10073:             push(@notified,$uname.':'.$udom);
1.444     albertel 10074:         }
                   10075:     }
                   10076:     if (@notified > 0) {
                   10077:         my $notifylist;
                   10078:         if (@notified > 1) {
                   10079:             $notifylist = join(',',@notified);
                   10080:         } else {
                   10081:             $notifylist = $notified[0];
                   10082:         }
                   10083:         $cenv{'internal.notifylist'} = $notifylist;
                   10084:     }
                   10085:     if (@badclasses > 0) {
                   10086:         my %lt=&Apache::lonlocal::texthash(
                   10087:                 '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',
                   10088:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10089:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10090:         );
1.541     raeburn  10091:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10092:                            ' ('.$lt{'adby'}.')';
                   10093:         if ($context eq 'auto') {
                   10094:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10095:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10096:             foreach my $item (@badclasses) {
                   10097:                 if ($context eq 'auto') {
                   10098:                     $outcome .= " - $item\n";
                   10099:                 } else {
                   10100:                     $outcome .= "<li>$item</li>\n";
                   10101:                 }
                   10102:             }
                   10103:             if ($context eq 'auto') {
                   10104:                 $outcome .= $linefeed;
                   10105:             } else {
1.566     albertel 10106:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10107:             }
                   10108:         } 
1.444     albertel 10109:     }
                   10110:     if ($args->{'no_end_date'}) {
                   10111:         $args->{'endaccess'} = 0;
                   10112:     }
                   10113:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10114:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10115:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10116:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10117:     if ($args->{'showphotos'}) {
                   10118:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10119:     }
                   10120:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10121:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10122:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10123:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10124:             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'); 
                   10125:             if ($context eq 'auto') {
                   10126:                 $outcome .= $krb_msg;
                   10127:             } else {
1.566     albertel 10128:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10129:             }
                   10130:             $outcome .= $linefeed;
1.444     albertel 10131:         }
                   10132:     }
                   10133:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10134:        if ($args->{'setpolicy'}) {
                   10135:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10136:        }
                   10137:        if ($args->{'setcontent'}) {
                   10138:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10139:        }
                   10140:     }
                   10141:     if ($args->{'reshome'}) {
                   10142: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10143: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10144:     }
                   10145: #
                   10146: # course has keyed access
                   10147: #
                   10148:     if ($args->{'setkeys'}) {
                   10149:        $cenv{'keyaccess'}='yes';
                   10150:     }
                   10151: # if specified, key authority is not course, but user
                   10152: # only active if keyaccess is yes
                   10153:     if ($args->{'keyauth'}) {
1.487     albertel 10154: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10155: 	$user = &LONCAPA::clean_username($user);
                   10156: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10157: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10158: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10159: 	}
                   10160:     }
                   10161: 
                   10162:     if ($args->{'disresdis'}) {
                   10163:         $cenv{'pch.roles.denied'}='st';
                   10164:     }
                   10165:     if ($args->{'disablechat'}) {
                   10166:         $cenv{'plc.roles.denied'}='st';
                   10167:     }
                   10168: 
                   10169:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10170:     # course
                   10171:     $cenv{'course.helper.not.run'} = 1;
                   10172:     #
                   10173:     # Use new Randomseed
                   10174:     #
                   10175:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10176:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10177:     #
                   10178:     # The encryption code and receipt prefix for this course
                   10179:     #
                   10180:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10181:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10182:     #
                   10183:     # By default, use standard grading
                   10184:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10185: 
1.541     raeburn  10186:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10187:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10188: #
                   10189: # Open all assignments
                   10190: #
                   10191:     if ($args->{'openall'}) {
                   10192:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10193:        my %storecontent = ($storeunder         => time,
                   10194:                            $storeunder.'.type' => 'date_start');
                   10195:        
                   10196:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10197:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10198:    }
                   10199: #
                   10200: # Set first page
                   10201: #
                   10202:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10203: 	    || ($cloneid)) {
1.445     albertel 10204: 	use LONCAPA::map;
1.444     albertel 10205: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10206: 
                   10207: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10208:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10209: 
1.444     albertel 10210:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10211:         my $title; my $url;
                   10212:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10213: 	    $title=&mt('Syllabus');
1.444     albertel 10214:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10215:         } else {
1.690     bisitz   10216:             $title=&mt('Navigate Contents');
1.444     albertel 10217:             $url='/adm/navmaps';
                   10218:         }
1.445     albertel 10219: 
                   10220:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10221: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10222: 
                   10223: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10224:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10225:     }
1.566     albertel 10226: 
                   10227:     return (1,$outcome);
1.444     albertel 10228: }
                   10229: 
                   10230: ############################################################
                   10231: ############################################################
                   10232: 
1.378     raeburn  10233: sub course_type {
                   10234:     my ($cid) = @_;
                   10235:     if (!defined($cid)) {
                   10236:         $cid = $env{'request.course.id'};
                   10237:     }
1.404     albertel 10238:     if (defined($env{'course.'.$cid.'.type'})) {
                   10239:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10240:     } else {
                   10241:         return 'Course';
1.377     raeburn  10242:     }
                   10243: }
1.156     albertel 10244: 
1.406     raeburn  10245: sub group_term {
                   10246:     my $crstype = &course_type();
                   10247:     my %names = (
                   10248:                   'Course' => 'group',
1.865     raeburn  10249:                   'Community' => 'group',
1.406     raeburn  10250:                 );
                   10251:     return $names{$crstype};
                   10252: }
                   10253: 
1.156     albertel 10254: sub icon {
                   10255:     my ($file)=@_;
1.505     albertel 10256:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10257:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10258:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10259:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10260: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10261: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10262: 	            $curfext.".gif") {
                   10263: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10264: 		$curfext.".gif";
                   10265: 	}
                   10266:     }
1.249     albertel 10267:     return &lonhttpdurl($iconname);
1.154     albertel 10268: } 
1.84      albertel 10269: 
1.575     albertel 10270: sub lonhttpdurl {
1.692     www      10271: #
                   10272: # Had been used for "small fry" static images on separate port 8080.
                   10273: # Modify here if lightweight http functionality desired again.
                   10274: # Currently eliminated due to increasing firewall issues.
                   10275: #
1.575     albertel 10276:     my ($url)=@_;
1.692     www      10277:     return $url;
1.215     albertel 10278: }
                   10279: 
1.213     albertel 10280: sub connection_aborted {
                   10281:     my ($r)=@_;
                   10282:     $r->print(" ");$r->rflush();
                   10283:     my $c = $r->connection;
                   10284:     return $c->aborted();
                   10285: }
                   10286: 
1.221     foxr     10287: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10288: #    strings as 'strings'.
                   10289: sub escape_single {
1.221     foxr     10290:     my ($input) = @_;
1.223     albertel 10291:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10292:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10293:     return $input;
                   10294: }
1.223     albertel 10295: 
1.222     foxr     10296: #  Same as escape_single, but escape's "'s  This 
                   10297: #  can be used for  "strings"
                   10298: sub escape_double {
                   10299:     my ($input) = @_;
                   10300:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10301:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10302:     return $input;
                   10303: }
1.223     albertel 10304:  
1.222     foxr     10305: #   Escapes the last element of a full URL.
                   10306: sub escape_url {
                   10307:     my ($url)   = @_;
1.238     raeburn  10308:     my @urlslices = split(/\//, $url,-1);
1.369     www      10309:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10310:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10311: }
1.462     albertel 10312: 
1.820     raeburn  10313: sub compare_arrays {
                   10314:     my ($arrayref1,$arrayref2) = @_;
                   10315:     my (@difference,%count);
                   10316:     @difference = ();
                   10317:     %count = ();
                   10318:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10319:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10320:         foreach my $element (keys(%count)) {
                   10321:             if ($count{$element} == 1) {
                   10322:                 push(@difference,$element);
                   10323:             }
                   10324:         }
                   10325:     }
                   10326:     return @difference;
                   10327: }
                   10328: 
1.817     bisitz   10329: # -------------------------------------------------------- Initialize user login
1.462     albertel 10330: sub init_user_environment {
1.463     albertel 10331:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10332:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10333: 
                   10334:     my $public=($username eq 'public' && $domain eq 'public');
                   10335: 
                   10336: # See if old ID present, if so, remove
                   10337: 
                   10338:     my ($filename,$cookie,$userroles);
                   10339:     my $now=time;
                   10340: 
                   10341:     if ($public) {
                   10342: 	my $max_public=100;
                   10343: 	my $oldest;
                   10344: 	my $oldest_time=0;
                   10345: 	for(my $next=1;$next<=$max_public;$next++) {
                   10346: 	    if (-e $lonids."/publicuser_$next.id") {
                   10347: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10348: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10349: 		    $oldest_time=$mtime;
                   10350: 		    $oldest=$next;
                   10351: 		}
                   10352: 	    } else {
                   10353: 		$cookie="publicuser_$next";
                   10354: 		last;
                   10355: 	    }
                   10356: 	}
                   10357: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10358:     } else {
1.463     albertel 10359: 	# if this isn't a robot, kill any existing non-robot sessions
                   10360: 	if (!$args->{'robot'}) {
                   10361: 	    opendir(DIR,$lonids);
                   10362: 	    while ($filename=readdir(DIR)) {
                   10363: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10364: 		    unlink($lonids.'/'.$filename);
                   10365: 		}
1.462     albertel 10366: 	    }
1.463     albertel 10367: 	    closedir(DIR);
1.462     albertel 10368: 	}
                   10369: # Give them a new cookie
1.463     albertel 10370: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10371: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10372: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10373:     
                   10374: # Initialize roles
                   10375: 
                   10376: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10377:     }
                   10378: # ------------------------------------ Check browser type and MathML capability
                   10379: 
                   10380:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10381:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10382: 
                   10383: # ------------------------------------------------------------- Get environment
                   10384: 
                   10385:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10386:     my ($tmp) = keys(%userenv);
                   10387:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10388: 	# default remote control to off
                   10389: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10390:     } else {
                   10391: 	undef(%userenv);
                   10392:     }
                   10393:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10394: 	$form->{'interface'}=$userenv{'interface'};
                   10395:     }
                   10396:     $env{'environment.remote'}=$userenv{'remote'};
                   10397:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10398: 
                   10399: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10400:     foreach my $option ('interface','localpath','localres') {
                   10401:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10402:     }
                   10403: # --------------------------------------------------------- Write first profile
                   10404: 
                   10405:     {
                   10406: 	my %initial_env = 
                   10407: 	    ("user.name"          => $username,
                   10408: 	     "user.domain"        => $domain,
                   10409: 	     "user.home"          => $authhost,
                   10410: 	     "browser.type"       => $clientbrowser,
                   10411: 	     "browser.version"    => $clientversion,
                   10412: 	     "browser.mathml"     => $clientmathml,
                   10413: 	     "browser.unicode"    => $clientunicode,
                   10414: 	     "browser.os"         => $clientos,
                   10415: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10416: 	     "request.course.fn"  => '',
                   10417: 	     "request.course.uri" => '',
                   10418: 	     "request.course.sec" => '',
                   10419: 	     "request.role"       => 'cm',
                   10420: 	     "request.role.adv"   => $env{'user.adv'},
                   10421: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10422: 
                   10423:         if ($form->{'localpath'}) {
                   10424: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10425: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10426:         }
                   10427: 	
                   10428: 	if ($public) {
                   10429: 	    $initial_env{"environment.remote"} = "off";
                   10430: 	}
                   10431: 	if ($form->{'interface'}) {
                   10432: 	    $form->{'interface'}=~s/\W//gs;
                   10433: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10434: 	    $env{'browser.interface'}=$form->{'interface'};
                   10435: 	}
                   10436: 
1.724     raeburn  10437:         foreach my $tool ('aboutme','blog','portfolio') {
                   10438:             $userenv{'availabletools.'.$tool} = 
                   10439:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10440:         }
                   10441: 
1.864     raeburn  10442:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10443:             $userenv{'canrequest.'.$crstype} =
                   10444:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10445:                                                   'reload','requestcourses');
                   10446:         }
                   10447: 
1.462     albertel 10448: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10449: 	
                   10450: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10451: 		 &GDBM_WRCREAT(),0640)) {
                   10452: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10453: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10454: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10455: 	    if (ref($args->{'extra_env'})) {
                   10456: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10457: 	    }
1.462     albertel 10458: 	    untie(%disk_env);
                   10459: 	} else {
1.705     tempelho 10460: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10461: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10462: 	    return 'error: '.$!;
                   10463: 	}
                   10464:     }
                   10465:     $env{'request.role'}='cm';
                   10466:     $env{'request.role.adv'}=$env{'user.adv'};
                   10467:     $env{'browser.type'}=$clientbrowser;
                   10468: 
                   10469:     return $cookie;
                   10470: 
                   10471: }
                   10472: 
                   10473: sub _add_to_env {
                   10474:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10475:     if (ref($env_data) eq 'HASH') {
                   10476:         while (my ($key,$value) = each(%$env_data)) {
                   10477: 	    $idf->{$prefix.$key} = $value;
                   10478: 	    $env{$prefix.$key}   = $value;
                   10479:         }
1.462     albertel 10480:     }
                   10481: }
                   10482: 
1.685     tempelho 10483: # --- Get the symbolic name of a problem and the url
                   10484: sub get_symb {
                   10485:     my ($request,$silent) = @_;
1.726     raeburn  10486:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10487:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10488:     if ($symb eq '') {
                   10489:         if (!$silent) {
                   10490:             $request->print("Unable to handle ambiguous references:$url:.");
                   10491:             return ();
                   10492:         }
                   10493:     }
                   10494:     &Apache::lonenc::check_decrypt(\$symb);
                   10495:     return ($symb);
                   10496: }
                   10497: 
                   10498: # --------------------------------------------------------------Get annotation
                   10499: 
                   10500: sub get_annotation {
                   10501:     my ($symb,$enc) = @_;
                   10502: 
                   10503:     my $key = $symb;
                   10504:     if (!$enc) {
                   10505:         $key =
                   10506:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10507:     }
                   10508:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10509:     return $annotation{$key};
                   10510: }
                   10511: 
                   10512: sub clean_symb {
1.731     raeburn  10513:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10514: 
                   10515:     &Apache::lonenc::check_decrypt(\$symb);
                   10516:     my $enc = $env{'request.enc'};
1.731     raeburn  10517:     if ($delete_enc) {
1.730     raeburn  10518:         delete($env{'request.enc'});
                   10519:     }
1.685     tempelho 10520: 
                   10521:     return ($symb,$enc);
                   10522: }
1.462     albertel 10523: 
1.41      ng       10524: =pod
                   10525: 
                   10526: =back
                   10527: 
1.112     bowersj2 10528: =cut
1.41      ng       10529: 
1.112     bowersj2 10530: 1;
                   10531: __END__;
1.41      ng       10532: 

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