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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.910   ! raeburn     4: # $Id: loncommon.pm,v 1.909 2009/11/04 14:08:36 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.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
                    486:     my $wintitle = &mt('Course Browser');
                    487:     if ($crstype ne '') {
                    488:         $wintitle = &mt($crstype);
                    489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
                    903:     return &select_form($selected,$name,%langchoices);
                    904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.648     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
                   1093: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1094: 
                   1095: =cut
                   1096: 
                   1097: sub help_open_topic {
1.48      bowersj2 1098:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1099:     $text = "" if (not defined $text);
1.44      bowersj2 1100:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1101:     $width = 350 if (not defined $width);
                   1102:     $height = 400 if (not defined $height);
                   1103:     my $filename = $topic;
                   1104:     $filename =~ s/ /_/g;
                   1105: 
1.48      bowersj2 1106:     my $template = "";
                   1107:     my $link;
1.572     banghart 1108:     
1.159     www      1109:     $topic=~s/\W/\_/g;
1.44      bowersj2 1110: 
1.572     banghart 1111:     if (!$stayOnPage) {
1.72      bowersj2 1112: 	$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 1113:     } else {
1.48      bowersj2 1114: 	$link = "/adm/help/${filename}.hlp";
                   1115:     }
                   1116: 
                   1117:     # Add the text
1.755     neumanie 1118:     if ($text ne "") {	
1.763     bisitz   1119: 	$template.='<span class="LC_help_open_topic">'
                   1120:                   .'<a target="_top" href="'.$link.'">'
                   1121:                   .$text.'</a>';
1.48      bowersj2 1122:     }
                   1123: 
1.763     bisitz   1124:     # (Always) Add the graphic
1.179     matthew  1125:     my $title = &mt('Online Help');
1.667     raeburn  1126:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1127:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1128:               .'<img src="'.$helpicon.'" border="0"'
                   1129:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1130:               .' title="'.$title.'"' 
1.763     bisitz   1131:               .' /></a>';
                   1132:     if ($text ne "") {	
                   1133:         $template.='</span>';
                   1134:     }
1.44      bowersj2 1135:     return $template;
                   1136: 
1.106     bowersj2 1137: }
                   1138: 
                   1139: # This is a quicky function for Latex cheatsheet editing, since it 
                   1140: # appears in at least four places
                   1141: sub helpLatexCheatsheet {
1.732     raeburn  1142:     my ($topic,$text,$not_author) = @_;
                   1143:     my $out;
1.106     bowersj2 1144:     my $addOther = '';
1.732     raeburn  1145:     if ($topic) {
1.763     bisitz   1146: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1147: 							       undef, undef, 600).
                   1148: 								   '</span> ';
                   1149:     }
                   1150:     $out = '<span>' # Start cheatsheet
                   1151: 	  .$addOther
                   1152:           .'<span>'
                   1153: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1154: 					       undef,undef,600)
                   1155: 	  .'</span> <span>'
                   1156: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1157: 					       undef,undef,600)
                   1158: 	  .'</span>';
1.732     raeburn  1159:     unless ($not_author) {
1.763     bisitz   1160:         $out .= ' <span>'
                   1161: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1162: 	                                            undef,undef,600)
                   1163: 	       .'</span>';
1.732     raeburn  1164:     }
1.763     bisitz   1165:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1166:     return $out;
1.172     www      1167: }
                   1168: 
1.430     albertel 1169: sub general_help {
                   1170:     my $helptopic='Student_Intro';
                   1171:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1172: 	$helptopic='Authoring_Intro';
1.907     raeburn  1173:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1174: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1175:     } elsif ($env{'request.role'}=~/^dc/) {
                   1176:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1177:     }
                   1178:     return $helptopic;
                   1179: }
                   1180: 
                   1181: sub update_help_link {
                   1182:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1183:     my $origurl = $ENV{'REQUEST_URI'};
                   1184:     $origurl=~s|^/~|/priv/|;
                   1185:     my $timestamp = time;
                   1186:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1187:         $$datum = &escape($$datum);
                   1188:     }
                   1189: 
                   1190:     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";
                   1191:     my $output .= <<"ENDOUTPUT";
                   1192: <script type="text/javascript">
1.824     bisitz   1193: // <![CDATA[
1.430     albertel 1194: banner_link = '$banner_link';
1.824     bisitz   1195: // ]]>
1.430     albertel 1196: </script>
                   1197: ENDOUTPUT
                   1198:     return $output;
                   1199: }
                   1200: 
                   1201: # now just updates the help link and generates a blue icon
1.193     raeburn  1202: sub help_open_menu {
1.430     albertel 1203:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1204: 	= @_;    
1.430     albertel 1205:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1206:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1207:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1208:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1209:         $stayOnPage=1;
1.430     albertel 1210:     }
                   1211:     my $output;
                   1212:     if ($component_help) {
                   1213: 	if (!$text) {
                   1214: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1215: 				       $width,$height);
                   1216: 	} else {
                   1217: 	    my $help_text;
                   1218: 	    $help_text=&unescape($topic);
                   1219: 	    $output='<table><tr><td>'.
                   1220: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1221: 				 $width,$height).'</td></tr></table>';
                   1222: 	}
                   1223:     }
                   1224:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1225:     return $output.$banner_link;
                   1226: }
                   1227: 
                   1228: sub top_nav_help {
                   1229:     my ($text) = @_;
1.436     albertel 1230:     $text = &mt($text);
1.572     banghart 1231:     my $stay_on_page = 
1.798     tempelho 1232: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1233:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1234: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1235:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1236: 
1.201     raeburn  1237:     my $title = &mt('Get help');
1.436     albertel 1238: 
                   1239:     return <<"END";
                   1240: $banner_link
                   1241:  <a href="$link" title="$title">$text</a>
                   1242: END
                   1243: }
                   1244: 
                   1245: sub help_menu_js {
                   1246:     my ($text) = @_;
                   1247: 
                   1248:     my $stayOnPage = 
1.798     tempelho 1249: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1250: 
                   1251:     my $width = 620;
                   1252:     my $height = 600;
1.430     albertel 1253:     my $helptopic=&general_help();
                   1254:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1255:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1256:     my $start_page =
                   1257:         &Apache::loncommon::start_page('Help Menu', undef,
                   1258: 				       {'frameset'    => 1,
                   1259: 					'js_ready'    => 1,
                   1260: 					'add_entries' => {
                   1261: 					    'border' => '0',
1.579     raeburn  1262: 					    'rows'   => "110,*",},});
1.331     albertel 1263:     my $end_page =
                   1264:         &Apache::loncommon::end_page({'frameset' => 1,
                   1265: 				      'js_ready' => 1,});
                   1266: 
1.436     albertel 1267:     my $template .= <<"ENDTEMPLATE";
                   1268: <script type="text/javascript">
1.877     bisitz   1269: // <![CDATA[
1.253     albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1271: var banner_link = '';
1.243     raeburn  1272: function helpMenu(target) {
                   1273:     var caller = this;
                   1274:     if (target == 'open') {
                   1275:         var newWindow = null;
                   1276:         try {
1.262     albertel 1277:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1278:         }
                   1279:         catch(error) {
                   1280:             writeHelp(caller);
                   1281:             return;
                   1282:         }
                   1283:         if (newWindow) {
                   1284:             caller = newWindow;
                   1285:         }
1.193     raeburn  1286:     }
1.243     raeburn  1287:     writeHelp(caller);
                   1288:     return;
                   1289: }
                   1290: function writeHelp(caller) {
1.430     albertel 1291:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1292:     caller.document.close()
                   1293:     caller.focus()
1.193     raeburn  1294: }
1.877     bisitz   1295: // END LON-CAPA Internal -->
1.253     albertel 1296: // ]]>
1.436     albertel 1297: </script>
1.193     raeburn  1298: ENDTEMPLATE
                   1299:     return $template;
                   1300: }
                   1301: 
1.172     www      1302: sub help_open_bug {
                   1303:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1304:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1305:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1306:     $text = "" if (not defined $text);
                   1307:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1308:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1309: 	$stayOnPage=1;
                   1310:     }
1.184     albertel 1311:     $width = 600 if (not defined $width);
                   1312:     $height = 600 if (not defined $height);
1.172     www      1313: 
                   1314:     $topic=~s/\W+/\+/g;
                   1315:     my $link='';
                   1316:     my $template='';
1.379     albertel 1317:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1318: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1319:     if (!$stayOnPage)
                   1320:     {
                   1321: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1322:     }
                   1323:     else
                   1324:     {
                   1325: 	$link = $url;
                   1326:     }
                   1327:     # Add the text
                   1328:     if ($text ne "")
                   1329:     {
                   1330: 	$template .= 
                   1331:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1332:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1333:     }
                   1334: 
                   1335:     # Add the graphic
1.179     matthew  1336:     my $title = &mt('Report a Bug');
1.215     albertel 1337:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1338:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1339:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1340: ENDTEMPLATE
                   1341:     if ($text ne '') { $template.='</td></tr></table>' };
                   1342:     return $template;
                   1343: 
                   1344: }
                   1345: 
                   1346: sub help_open_faq {
                   1347:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1348:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1349:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1350:     $text = "" if (not defined $text);
                   1351:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1352:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1353: 	$stayOnPage=1;
                   1354:     }
                   1355:     $width = 350 if (not defined $width);
                   1356:     $height = 400 if (not defined $height);
                   1357: 
                   1358:     $topic=~s/\W+/\+/g;
                   1359:     my $link='';
                   1360:     my $template='';
                   1361:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1362:     if (!$stayOnPage)
                   1363:     {
                   1364: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1365:     }
                   1366:     else
                   1367:     {
                   1368: 	$link = $url;
                   1369:     }
                   1370: 
                   1371:     # Add the text
                   1372:     if ($text ne "")
                   1373:     {
                   1374: 	$template .= 
1.173     www      1375:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1376:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1377:     }
                   1378: 
                   1379:     # Add the graphic
1.179     matthew  1380:     my $title = &mt('View the FAQ');
1.215     albertel 1381:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1382:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1383:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1384: ENDTEMPLATE
                   1385:     if ($text ne '') { $template.='</td></tr></table>' };
                   1386:     return $template;
                   1387: 
1.44      bowersj2 1388: }
1.37      matthew  1389: 
1.180     matthew  1390: ###############################################################
                   1391: ###############################################################
                   1392: 
1.45      matthew  1393: =pod
                   1394: 
1.648     raeburn  1395: =item * &change_content_javascript():
1.256     matthew  1396: 
                   1397: This and the next function allow you to create small sections of an
                   1398: otherwise static HTML page that you can update on the fly with
                   1399: Javascript, even in Netscape 4.
                   1400: 
                   1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1402: must be written to the HTML page once. It will prove the Javascript
                   1403: function "change(name, content)". Calling the change function with the
                   1404: name of the section 
                   1405: you want to update, matching the name passed to C<changable_area>, and
                   1406: the new content you want to put in there, will put the content into
                   1407: that area.
                   1408: 
                   1409: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1410: to contain room for the original contents. You need to "make space"
                   1411: for whatever changes you wish to make, and be B<sure> to check your
                   1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1413: it's adequate for updating a one-line status display, but little more.
                   1414: This script will set the space to 100% width, so you only need to
                   1415: worry about height in Netscape 4.
                   1416: 
                   1417: Modern browsers are much less limiting, and if you can commit to the
                   1418: user not using Netscape 4, this feature may be used freely with
                   1419: pretty much any HTML.
                   1420: 
                   1421: =cut
                   1422: 
                   1423: sub change_content_javascript {
                   1424:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1425:     if ($env{'browser.type'} eq 'netscape' &&
                   1426: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1427: 	return (<<NETSCAPE4);
                   1428: 	function change(name, content) {
                   1429: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1430: 	    doc.open();
                   1431: 	    doc.write(content);
                   1432: 	    doc.close();
                   1433: 	}
                   1434: NETSCAPE4
                   1435:     } else {
                   1436: 	# Otherwise, we need to use semi-standards-compliant code
                   1437: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1438: 	# is really scary, and every useful browser supports it
                   1439: 	return (<<DOMBASED);
                   1440: 	function change(name, content) {
                   1441: 	    element = document.getElementById(name);
                   1442: 	    element.innerHTML = content;
                   1443: 	}
                   1444: DOMBASED
                   1445:     }
                   1446: }
                   1447: 
                   1448: =pod
                   1449: 
1.648     raeburn  1450: =item * &changable_area($name,$origContent):
1.256     matthew  1451: 
                   1452: This provides a "changable area" that can be modified on the fly via
                   1453: the Javascript code provided in C<change_content_javascript>. $name is
                   1454: the name you will use to reference the area later; do not repeat the
                   1455: same name on a given HTML page more then once. $origContent is what
                   1456: the area will originally contain, which can be left blank.
                   1457: 
                   1458: =cut
                   1459: 
                   1460: sub changable_area {
                   1461:     my ($name, $origContent) = @_;
                   1462: 
1.258     albertel 1463:     if ($env{'browser.type'} eq 'netscape' &&
                   1464: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1465: 	# If this is netscape 4, we need to use the Layer tag
                   1466: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1467:     } else {
                   1468: 	return "<span id='$name'>$origContent</span>";
                   1469:     }
                   1470: }
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &viewport_geometry_js 
1.590     raeburn  1475: 
                   1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1477: 
                   1478: =cut
                   1479: 
                   1480: 
                   1481: sub viewport_geometry_js { 
                   1482:     return <<"GEOMETRY";
                   1483: var Geometry = {};
                   1484: function init_geometry() {
                   1485:     if (Geometry.init) { return };
                   1486:     Geometry.init=1;
                   1487:     if (window.innerHeight) {
                   1488:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1489:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1490:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1491:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1492:     }
                   1493:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1494:         Geometry.getViewportHeight =
                   1495:             function() { return document.documentElement.clientHeight; };
                   1496:         Geometry.getViewportWidth =
                   1497:             function() { return document.documentElement.clientWidth; };
                   1498: 
                   1499:         Geometry.getHorizontalScroll =
                   1500:             function() { return document.documentElement.scrollLeft; };
                   1501:         Geometry.getVerticalScroll =
                   1502:             function() { return document.documentElement.scrollTop; };
                   1503:     }
                   1504:     else if (document.body.clientHeight) {
                   1505:         Geometry.getViewportHeight =
                   1506:             function() { return document.body.clientHeight; };
                   1507:         Geometry.getViewportWidth =
                   1508:             function() { return document.body.clientWidth; };
                   1509:         Geometry.getHorizontalScroll =
                   1510:             function() { return document.body.scrollLeft; };
                   1511:         Geometry.getVerticalScroll =
                   1512:             function() { return document.body.scrollTop; };
                   1513:     }
                   1514: }
                   1515: 
                   1516: GEOMETRY
                   1517: }
                   1518: 
                   1519: =pod
                   1520: 
1.648     raeburn  1521: =item * &viewport_size_js()
1.590     raeburn  1522: 
                   1523: 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. 
                   1524: 
                   1525: =cut
                   1526: 
                   1527: sub viewport_size_js {
                   1528:     my $geometry = &viewport_geometry_js();
                   1529:     return <<"DIMS";
                   1530: 
                   1531: $geometry
                   1532: 
                   1533: function getViewportDims(width,height) {
                   1534:     init_geometry();
                   1535:     width.value = Geometry.getViewportWidth();
                   1536:     height.value = Geometry.getViewportHeight();
                   1537:     return;
                   1538: }
                   1539: 
                   1540: DIMS
                   1541: }
                   1542: 
                   1543: =pod
                   1544: 
1.648     raeburn  1545: =item * &resize_textarea_js()
1.565     albertel 1546: 
                   1547: emits the needed javascript to resize a textarea to be as big as possible
                   1548: 
                   1549: creates a function resize_textrea that takes two IDs first should be
                   1550: the id of the element to resize, second should be the id of a div that
                   1551: surrounds everything that comes after the textarea, this routine needs
                   1552: to be attached to the <body> for the onload and onresize events.
                   1553: 
1.648     raeburn  1554: =back
1.565     albertel 1555: 
                   1556: =cut
                   1557: 
                   1558: sub resize_textarea_js {
1.590     raeburn  1559:     my $geometry = &viewport_geometry_js();
1.565     albertel 1560:     return <<"RESIZE";
                   1561:     <script type="text/javascript">
1.824     bisitz   1562: // <![CDATA[
1.590     raeburn  1563: $geometry
1.565     albertel 1564: 
1.588     albertel 1565: function getX(element) {
                   1566:     var x = 0;
                   1567:     while (element) {
                   1568: 	x += element.offsetLeft;
                   1569: 	element = element.offsetParent;
                   1570:     }
                   1571:     return x;
                   1572: }
                   1573: function getY(element) {
                   1574:     var y = 0;
                   1575:     while (element) {
                   1576: 	y += element.offsetTop;
                   1577: 	element = element.offsetParent;
                   1578:     }
                   1579:     return y;
                   1580: }
                   1581: 
                   1582: 
1.565     albertel 1583: function resize_textarea(textarea_id,bottom_id) {
                   1584:     init_geometry();
                   1585:     var textarea        = document.getElementById(textarea_id);
                   1586:     //alert(textarea);
                   1587: 
1.588     albertel 1588:     var textarea_top    = getY(textarea);
1.565     albertel 1589:     var textarea_height = textarea.offsetHeight;
                   1590:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1591:     var bottom_top      = getY(bottom);
1.565     albertel 1592:     var bottom_height   = bottom.offsetHeight;
                   1593:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1594:     var fudge           = 23;
1.565     albertel 1595:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1596:     if (new_height < 300) {
                   1597: 	new_height = 300;
                   1598:     }
                   1599:     textarea.style.height=new_height+'px';
                   1600: }
1.824     bisitz   1601: // ]]>
1.565     albertel 1602: </script>
                   1603: RESIZE
                   1604: 
                   1605: }
                   1606: 
                   1607: =pod
                   1608: 
1.256     matthew  1609: =head1 Excel and CSV file utility routines
                   1610: 
                   1611: =over 4
                   1612: 
                   1613: =cut
                   1614: 
                   1615: ###############################################################
                   1616: ###############################################################
                   1617: 
                   1618: =pod
                   1619: 
1.648     raeburn  1620: =item * &csv_translate($text) 
1.37      matthew  1621: 
1.185     www      1622: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1623: format.
                   1624: 
                   1625: =cut
                   1626: 
1.180     matthew  1627: ###############################################################
                   1628: ###############################################################
1.37      matthew  1629: sub csv_translate {
                   1630:     my $text = shift;
                   1631:     $text =~ s/\"/\"\"/g;
1.209     albertel 1632:     $text =~ s/\n/ /g;
1.37      matthew  1633:     return $text;
                   1634: }
1.180     matthew  1635: 
                   1636: ###############################################################
                   1637: ###############################################################
                   1638: 
                   1639: =pod
                   1640: 
1.648     raeburn  1641: =item * &define_excel_formats()
1.180     matthew  1642: 
                   1643: Define some commonly used Excel cell formats.
                   1644: 
                   1645: Currently supported formats:
                   1646: 
                   1647: =over 4
                   1648: 
                   1649: =item header
                   1650: 
                   1651: =item bold
                   1652: 
                   1653: =item h1
                   1654: 
                   1655: =item h2
                   1656: 
                   1657: =item h3
                   1658: 
1.256     matthew  1659: =item h4
                   1660: 
                   1661: =item i
                   1662: 
1.180     matthew  1663: =item date
                   1664: 
                   1665: =back
                   1666: 
                   1667: Inputs: $workbook
                   1668: 
                   1669: Returns: $format, a hash reference.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: sub define_excel_formats {
                   1676:     my ($workbook) = @_;
                   1677:     my $format;
                   1678:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1679:                                                 bottom    => 1,
                   1680:                                                 align     => 'center');
                   1681:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1682:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1683:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1684:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1685:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1686:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1687:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1688:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1689:     return $format;
                   1690: }
                   1691: 
                   1692: ###############################################################
                   1693: ###############################################################
1.113     bowersj2 1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &create_workbook()
1.255     matthew  1698: 
                   1699: Create an Excel worksheet.  If it fails, output message on the
                   1700: request object and return undefs.
                   1701: 
                   1702: Inputs: Apache request object
                   1703: 
                   1704: Returns (undef) on failure, 
                   1705:     Excel worksheet object, scalar with filename, and formats 
                   1706:     from &Apache::loncommon::define_excel_formats on success
                   1707: 
                   1708: =cut
                   1709: 
                   1710: ###############################################################
                   1711: ###############################################################
                   1712: sub create_workbook {
                   1713:     my ($r) = @_;
                   1714:         #
                   1715:     # Create the excel spreadsheet
                   1716:     my $filename = '/prtspool/'.
1.258     albertel 1717:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1718:         time.'_'.rand(1000000000).'.xls';
                   1719:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1720:     if (! defined($workbook)) {
                   1721:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1722:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1723:                             "This error has been logged.  ".
                   1724:                             "Please alert your LON-CAPA administrator").
                   1725:                   '</p>');
                   1726:         return (undef);
                   1727:     }
                   1728:     #
                   1729:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1730:     #
                   1731:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1732:     return ($workbook,$filename,$format);
                   1733: }
                   1734: 
                   1735: ###############################################################
                   1736: ###############################################################
                   1737: 
                   1738: =pod
                   1739: 
1.648     raeburn  1740: =item * &create_text_file()
1.113     bowersj2 1741: 
1.542     raeburn  1742: Create a file to write to and eventually make available to the user.
1.256     matthew  1743: If file creation fails, outputs an error message on the request object and 
                   1744: return undefs.
1.113     bowersj2 1745: 
1.256     matthew  1746: Inputs: Apache request object, and file suffix
1.113     bowersj2 1747: 
1.256     matthew  1748: Returns (undef) on failure, 
                   1749:     Filehandle and filename on success.
1.113     bowersj2 1750: 
                   1751: =cut
                   1752: 
1.256     matthew  1753: ###############################################################
                   1754: ###############################################################
                   1755: sub create_text_file {
                   1756:     my ($r,$suffix) = @_;
                   1757:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1758:     my $fh;
                   1759:     my $filename = '/prtspool/'.
1.258     albertel 1760:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1761:         time.'_'.rand(1000000000).'.'.$suffix;
                   1762:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1763:     if (! defined($fh)) {
                   1764:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1765:         $r->print(&mt('Problems occurred in creating the output file. '
                   1766:                      .'This error has been logged. '
                   1767:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1796: 	return &select_form($name,$value,%domains);
                   1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.648     raeburn  1858: =item * &select_form($defdom,$name,%hash)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
                   1861: allow a user to select options from a hash option_name => displayed text.  
                   1862: See lonrights.pm for an example invocation and use.
                   1863: 
                   1864: =cut
                   1865: 
                   1866: #-------------------------------------------
                   1867: sub select_form {
                   1868:     my ($def,$name,%hash) = @_;
                   1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1870:     my @keys;
                   1871:     if (exists($hash{'select_form_order'})) {
                   1872: 	@keys=@{$hash{'select_form_order'}};
                   1873:     } else {
                   1874: 	@keys=sort(keys(%hash));
                   1875:     }
1.356     albertel 1876:     foreach my $key (@keys) {
                   1877:         $selectform.=
                   1878: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1879:             ($key eq $def ? 'selected="selected" ' : '').
                   1880:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1881:     }
                   1882:     $selectform.="</select>";
                   1883:     return $selectform;
                   1884: }
                   1885: 
1.475     www      1886: # For display filters
                   1887: 
                   1888: sub display_filter {
                   1889:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1890:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1891:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1892: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1893: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1894: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1895:            &mt('Filter [_1]',
1.477     www      1896: 	   &select_form($env{'form.displayfilter'},
                   1897: 			'displayfilter',
                   1898: 			('currentfolder' => 'Current folder/page',
                   1899: 			 'containing' => 'Containing phrase',
                   1900: 			 'none' => 'None'))).
1.714     bisitz   1901: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1902: }
                   1903: 
1.167     www      1904: sub gradeleveldescription {
                   1905:     my $gradelevel=shift;
                   1906:     my %gradelevels=(0 => 'Not specified',
                   1907: 		     1 => 'Grade 1',
                   1908: 		     2 => 'Grade 2',
                   1909: 		     3 => 'Grade 3',
                   1910: 		     4 => 'Grade 4',
                   1911: 		     5 => 'Grade 5',
                   1912: 		     6 => 'Grade 6',
                   1913: 		     7 => 'Grade 7',
                   1914: 		     8 => 'Grade 8',
                   1915: 		     9 => 'Grade 9',
                   1916: 		     10 => 'Grade 10',
                   1917: 		     11 => 'Grade 11',
                   1918: 		     12 => 'Grade 12',
                   1919: 		     13 => 'Grade 13',
                   1920: 		     14 => '100 Level',
                   1921: 		     15 => '200 Level',
                   1922: 		     16 => '300 Level',
                   1923: 		     17 => '400 Level',
                   1924: 		     18 => 'Graduate Level');
                   1925:     return &mt($gradelevels{$gradelevel});
                   1926: }
                   1927: 
1.163     www      1928: sub select_level_form {
                   1929:     my ($deflevel,$name)=@_;
                   1930:     unless ($deflevel) { $deflevel=0; }
1.167     www      1931:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1932:     for (my $i=0; $i<=18; $i++) {
                   1933:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1934:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1935:                 ">".&gradeleveldescription($i)."</option>\n";
                   1936:     }
                   1937:     $selectform.="</select>";
                   1938:     return $selectform;
1.163     www      1939: }
1.167     www      1940: 
1.35      matthew  1941: #-------------------------------------------
                   1942: 
1.45      matthew  1943: =pod
                   1944: 
1.910   ! raeburn  1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1946: 
                   1947: Returns a string containing a <select name='$name' size='1'> form to 
                   1948: allow a user to select the domain to preform an operation in.  
                   1949: See loncreateuser.pm for an example invocation and use.
                   1950: 
1.90      www      1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1952: selected");
                   1953: 
1.743     raeburn  1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1955: 
1.910   ! raeburn  1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
        !          1957: 
        !          1958: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1959: 
1.35      matthew  1960: =cut
                   1961: 
                   1962: #-------------------------------------------
1.34      matthew  1963: sub select_dom_form {
1.910   ! raeburn  1964:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1965:     if ($onchange) {
1.874     raeburn  1966:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1967:     }
1.910   ! raeburn  1968:     my @domains;
        !          1969:     if (ref($incdoms) eq 'ARRAY') {
        !          1970:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
        !          1971:     } else {
        !          1972:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
        !          1973:     }
1.90      www      1974:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1975:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1976:     foreach my $dom (@domains) {
                   1977:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1978:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1979:         if ($showdomdesc) {
                   1980:             if ($dom ne '') {
                   1981:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1982:                 if ($domdesc ne '') {
                   1983:                     $selectdomain .= ' ('.$domdesc.')';
                   1984:                 }
                   1985:             } 
                   1986:         }
                   1987:         $selectdomain .= "</option>\n";
1.34      matthew  1988:     }
                   1989:     $selectdomain.="</select>";
                   1990:     return $selectdomain;
                   1991: }
                   1992: 
1.35      matthew  1993: #-------------------------------------------
                   1994: 
1.45      matthew  1995: =pod
                   1996: 
1.648     raeburn  1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1998: 
1.586     raeburn  1999: input: 4 arguments (two required, two optional) - 
                   2000:     $domain - domain of new user
                   2001:     $name - name of form element
                   2002:     $default - Value of 'default' causes a default item to be first 
                   2003:                             option, and selected by default. 
                   2004:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2005:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2006: output: returns 2 items: 
1.586     raeburn  2007: (a) form element which contains either:
                   2008:    (i) <select name="$name">
                   2009:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2010:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2011:        </select>
                   2012:        form item if there are multiple library servers in $domain, or
                   2013:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2014:        if there is only one library server in $domain.
                   2015: 
                   2016: (b) number of library servers found.
                   2017: 
                   2018: See loncreateuser.pm for example of use.
1.35      matthew  2019: 
                   2020: =cut
                   2021: 
                   2022: #-------------------------------------------
1.586     raeburn  2023: sub home_server_form_item {
                   2024:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2025:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2026:     my $result;
                   2027:     my $numlib = keys(%servers);
                   2028:     if ($numlib > 1) {
                   2029:         $result .= '<select name="'.$name.'" />'."\n";
                   2030:         if ($default) {
1.804     bisitz   2031:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2032:                        '</option>'."\n";
                   2033:         }
                   2034:         foreach my $hostid (sort(keys(%servers))) {
                   2035:             $result.= '<option value="'.$hostid.'">'.
                   2036: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2037:         }
                   2038:         $result .= '</select>'."\n";
                   2039:     } elsif ($numlib == 1) {
                   2040:         my $hostid;
                   2041:         foreach my $item (keys(%servers)) {
                   2042:             $hostid = $item;
                   2043:         }
                   2044:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2045:                    $hostid.'" />';
                   2046:                    if (!$hide) {
                   2047:                        $result .= $hostid.' '.$servers{$hostid};
                   2048:                    }
                   2049:                    $result .= "\n";
                   2050:     } elsif ($default) {
                   2051:         $result .= '<input type="hidden" name="'.$name.
                   2052:                    '" value="default" />';
                   2053:                    if (!$hide) {
                   2054:                        $result .= &mt('default');
                   2055:                    }
                   2056:                    $result .= "\n";
1.33      matthew  2057:     }
1.586     raeburn  2058:     return ($result,$numlib);
1.33      matthew  2059: }
1.112     bowersj2 2060: 
                   2061: =pod
                   2062: 
1.534     albertel 2063: =back 
                   2064: 
1.112     bowersj2 2065: =cut
1.87      matthew  2066: 
                   2067: ###############################################################
1.112     bowersj2 2068: ##                  Decoding User Agent                      ##
1.87      matthew  2069: ###############################################################
                   2070: 
                   2071: =pod
                   2072: 
1.112     bowersj2 2073: =head1 Decoding the User Agent
                   2074: 
                   2075: =over 4
                   2076: 
                   2077: =item * &decode_user_agent()
1.87      matthew  2078: 
                   2079: Inputs: $r
                   2080: 
                   2081: Outputs:
                   2082: 
                   2083: =over 4
                   2084: 
1.112     bowersj2 2085: =item * $httpbrowser
1.87      matthew  2086: 
1.112     bowersj2 2087: =item * $clientbrowser
1.87      matthew  2088: 
1.112     bowersj2 2089: =item * $clientversion
1.87      matthew  2090: 
1.112     bowersj2 2091: =item * $clientmathml
1.87      matthew  2092: 
1.112     bowersj2 2093: =item * $clientunicode
1.87      matthew  2094: 
1.112     bowersj2 2095: =item * $clientos
1.87      matthew  2096: 
                   2097: =back
                   2098: 
1.157     matthew  2099: =back 
                   2100: 
1.87      matthew  2101: =cut
                   2102: 
                   2103: ###############################################################
                   2104: ###############################################################
                   2105: sub decode_user_agent {
1.247     albertel 2106:     my ($r)=@_;
1.87      matthew  2107:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2108:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2109:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2110:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2111:     my $clientbrowser='unknown';
                   2112:     my $clientversion='0';
                   2113:     my $clientmathml='';
                   2114:     my $clientunicode='0';
                   2115:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2116:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2117: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2118: 	    $clientbrowser=$bname;
                   2119:             $httpbrowser=~/$vreg/i;
                   2120: 	    $clientversion=$1;
                   2121:             $clientmathml=($clientversion>=$minv);
                   2122:             $clientunicode=($clientversion>=$univ);
                   2123: 	}
                   2124:     }
                   2125:     my $clientos='unknown';
                   2126:     if (($httpbrowser=~/linux/i) ||
                   2127:         ($httpbrowser=~/unix/i) ||
                   2128:         ($httpbrowser=~/ux/i) ||
                   2129:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2130:     if (($httpbrowser=~/vax/i) ||
                   2131:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2132:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2133:     if (($httpbrowser=~/mac/i) ||
                   2134:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2135:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2136:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2137:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2138:             $clientunicode,$clientos,);
                   2139: }
                   2140: 
1.32      matthew  2141: ###############################################################
                   2142: ##    Authentication changing form generation subroutines    ##
                   2143: ###############################################################
                   2144: ##
                   2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2146: ## hash, and have reasonable default values.
                   2147: ##
                   2148: ##    formname = the name given in the <form> tag.
1.35      matthew  2149: #-------------------------------------------
                   2150: 
1.45      matthew  2151: =pod
                   2152: 
1.112     bowersj2 2153: =head1 Authentication Routines
                   2154: 
                   2155: =over 4
                   2156: 
1.648     raeburn  2157: =item * &authform_xxxxxx()
1.35      matthew  2158: 
                   2159: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2160: handle some of the conveniences required for authentication forms.  
                   2161: This is not an optimal method, but it works.  
                   2162: 
                   2163: =over 4
                   2164: 
1.112     bowersj2 2165: =item * authform_header
1.35      matthew  2166: 
1.112     bowersj2 2167: =item * authform_authorwarning
1.35      matthew  2168: 
1.112     bowersj2 2169: =item * authform_nochange
1.35      matthew  2170: 
1.112     bowersj2 2171: =item * authform_kerberos
1.35      matthew  2172: 
1.112     bowersj2 2173: =item * authform_internal
1.35      matthew  2174: 
1.112     bowersj2 2175: =item * authform_filesystem
1.35      matthew  2176: 
                   2177: =back
                   2178: 
1.648     raeburn  2179: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2180: 
1.35      matthew  2181: =cut
                   2182: 
                   2183: #-------------------------------------------
1.32      matthew  2184: sub authform_header{  
                   2185:     my %in = (
                   2186:         formname => 'cu',
1.80      albertel 2187:         kerb_def_dom => '',
1.32      matthew  2188:         @_,
                   2189:     );
                   2190:     $in{'formname'} = 'document.' . $in{'formname'};
                   2191:     my $result='';
1.80      albertel 2192: 
                   2193: #---------------------------------------------- Code for upper case translation
                   2194:     my $Javascript_toUpperCase;
                   2195:     unless ($in{kerb_def_dom}) {
                   2196:         $Javascript_toUpperCase =<<"END";
                   2197:         switch (choice) {
                   2198:            case 'krb': currentform.elements[choicearg].value =
                   2199:                currentform.elements[choicearg].value.toUpperCase();
                   2200:                break;
                   2201:            default:
                   2202:         }
                   2203: END
                   2204:     } else {
                   2205:         $Javascript_toUpperCase = "";
                   2206:     }
                   2207: 
1.165     raeburn  2208:     my $radioval = "'nochange'";
1.591     raeburn  2209:     if (defined($in{'curr_authtype'})) {
                   2210:         if ($in{'curr_authtype'} ne '') {
                   2211:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2212:         }
1.174     matthew  2213:     }
1.165     raeburn  2214:     my $argfield = 'null';
1.591     raeburn  2215:     if (defined($in{'mode'})) {
1.165     raeburn  2216:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2217:             if (defined($in{'curr_autharg'})) {
                   2218:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2219:                     $argfield = "'$in{'curr_autharg'}'";
                   2220:                 }
                   2221:             }
                   2222:         }
                   2223:     }
                   2224: 
1.32      matthew  2225:     $result.=<<"END";
                   2226: var current = new Object();
1.165     raeburn  2227: current.radiovalue = $radioval;
                   2228: current.argfield = $argfield;
1.32      matthew  2229: 
                   2230: function changed_radio(choice,currentform) {
                   2231:     var choicearg = choice + 'arg';
                   2232:     // If a radio button in changed, we need to change the argfield
                   2233:     if (current.radiovalue != choice) {
                   2234:         current.radiovalue = choice;
                   2235:         if (current.argfield != null) {
                   2236:             currentform.elements[current.argfield].value = '';
                   2237:         }
                   2238:         if (choice == 'nochange') {
                   2239:             current.argfield = null;
                   2240:         } else {
                   2241:             current.argfield = choicearg;
                   2242:             switch(choice) {
                   2243:                 case 'krb': 
                   2244:                     currentform.elements[current.argfield].value = 
                   2245:                         "$in{'kerb_def_dom'}";
                   2246:                 break;
                   2247:               default:
                   2248:                 break;
                   2249:             }
                   2250:         }
                   2251:     }
                   2252:     return;
                   2253: }
1.22      www      2254: 
1.32      matthew  2255: function changed_text(choice,currentform) {
                   2256:     var choicearg = choice + 'arg';
                   2257:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2258:         $Javascript_toUpperCase
1.32      matthew  2259:         // clear old field
                   2260:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2261:             currentform.elements[current.argfield].value = '';
                   2262:         }
                   2263:         current.argfield = choicearg;
                   2264:     }
                   2265:     set_auth_radio_buttons(choice,currentform);
                   2266:     return;
1.20      www      2267: }
1.32      matthew  2268: 
                   2269: function set_auth_radio_buttons(newvalue,currentform) {
                   2270:     var i=0;
                   2271:     while (i < currentform.login.length) {
                   2272:         if (currentform.login[i].value == newvalue) { break; }
                   2273:         i++;
                   2274:     }
                   2275:     if (i == currentform.login.length) {
                   2276:         return;
                   2277:     }
                   2278:     current.radiovalue = newvalue;
                   2279:     currentform.login[i].checked = true;
                   2280:     return;
                   2281: }
                   2282: END
                   2283:     return $result;
                   2284: }
                   2285: 
                   2286: sub authform_authorwarning{
                   2287:     my $result='';
1.144     matthew  2288:     $result='<i>'.
                   2289:         &mt('As a general rule, only authors or co-authors should be '.
                   2290:             'filesystem authenticated '.
                   2291:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_nochange{  
                   2296:     my %in = (
                   2297:               formname => 'document.cu',
                   2298:               kerb_def_dom => 'MSU.EDU',
                   2299:               @_,
                   2300:           );
1.586     raeburn  2301:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2302:     my $result;
                   2303:     if (keys(%can_assign) == 0) {
                   2304:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2305:     } else {
                   2306:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2307:                   '<input type="radio" name="login" value="nochange" '.
                   2308:                   'checked="checked" onclick="'.
1.281     albertel 2309:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2310: 	    '</label>';
1.586     raeburn  2311:     }
1.32      matthew  2312:     return $result;
                   2313: }
                   2314: 
1.591     raeburn  2315: sub authform_kerberos {
1.32      matthew  2316:     my %in = (
                   2317:               formname => 'document.cu',
                   2318:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2319:               kerb_def_auth => 'krb4',
1.32      matthew  2320:               @_,
                   2321:               );
1.586     raeburn  2322:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2323:         $autharg,$jscall);
                   2324:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2325:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2326:        $check5 = ' checked="checked"';
1.80      albertel 2327:     } else {
1.772     bisitz   2328:        $check4 = ' checked="checked"';
1.80      albertel 2329:     }
1.165     raeburn  2330:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2331:     if (defined($in{'curr_authtype'})) {
                   2332:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2333:             $krbcheck = ' checked="checked"';
1.623     raeburn  2334:             if (defined($in{'mode'})) {
                   2335:                 if ($in{'mode'} eq 'modifyuser') {
                   2336:                     $krbcheck = '';
                   2337:                 }
                   2338:             }
1.591     raeburn  2339:             if (defined($in{'curr_kerb_ver'})) {
                   2340:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2341:                     $check5 = ' checked="checked"';
1.591     raeburn  2342:                     $check4 = '';
                   2343:                 } else {
1.772     bisitz   2344:                     $check4 = ' checked="checked"';
1.591     raeburn  2345:                     $check5 = '';
                   2346:                 }
1.586     raeburn  2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2349:                 $krbarg = $in{'curr_autharg'};
                   2350:             }
1.586     raeburn  2351:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2352:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2353:                     $result = 
                   2354:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2355:         $in{'curr_autharg'},$krbver);
                   2356:                 } else {
                   2357:                     $result =
                   2358:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2359:                 }
                   2360:                 return $result; 
                   2361:             }
                   2362:         }
                   2363:     } else {
                   2364:         if ($authnum == 1) {
1.784     bisitz   2365:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2366:         }
                   2367:     }
1.586     raeburn  2368:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2369:         return;
1.587     raeburn  2370:     } elsif ($authtype eq '') {
1.591     raeburn  2371:         if (defined($in{'mode'})) {
1.587     raeburn  2372:             if ($in{'mode'} eq 'modifycourse') {
                   2373:                 if ($authnum == 1) {
1.784     bisitz   2374:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2375:                 }
                   2376:             }
                   2377:         }
1.586     raeburn  2378:     }
                   2379:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2380:     if ($authtype eq '') {
                   2381:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2382:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2383:                     $krbcheck.' />';
                   2384:     }
                   2385:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2386:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2387:          $in{'curr_authtype'} eq 'krb5') ||
                   2388:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2389:          $in{'curr_authtype'} eq 'krb4')) {
                   2390:         $result .= &mt
1.144     matthew  2391:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2392:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2393:          '<label>'.$authtype,
1.281     albertel 2394:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2395:              'value="'.$krbarg.'" '.
1.144     matthew  2396:              'onchange="'.$jscall.'" />',
1.281     albertel 2397:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2398:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2399: 	 '</label>');
1.586     raeburn  2400:     } elsif ($can_assign{'krb4'}) {
                   2401:         $result .= &mt
                   2402:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2403:          '[_3] Version 4 [_4]',
                   2404:          '<label>'.$authtype,
                   2405:          '</label><input type="text" size="10" name="krbarg" '.
                   2406:              'value="'.$krbarg.'" '.
                   2407:              'onchange="'.$jscall.'" />',
                   2408:          '<label><input type="hidden" name="krbver" value="4" />',
                   2409:          '</label>');
                   2410:     } elsif ($can_assign{'krb5'}) {
                   2411:         $result .= &mt
                   2412:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2413:          '[_3] Version 5 [_4]',
                   2414:          '<label>'.$authtype,
                   2415:          '</label><input type="text" size="10" name="krbarg" '.
                   2416:              'value="'.$krbarg.'" '.
                   2417:              'onchange="'.$jscall.'" />',
                   2418:          '<label><input type="hidden" name="krbver" value="5" />',
                   2419:          '</label>');
                   2420:     }
1.32      matthew  2421:     return $result;
                   2422: }
                   2423: 
                   2424: sub authform_internal{  
1.586     raeburn  2425:     my %in = (
1.32      matthew  2426:                 formname => 'document.cu',
                   2427:                 kerb_def_dom => 'MSU.EDU',
                   2428:                 @_,
                   2429:                 );
1.586     raeburn  2430:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2431:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2432:     if (defined($in{'curr_authtype'})) {
                   2433:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2434:             if ($can_assign{'int'}) {
1.772     bisitz   2435:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2436:                 if (defined($in{'mode'})) {
                   2437:                     if ($in{'mode'} eq 'modifyuser') {
                   2438:                         $intcheck = '';
                   2439:                     }
                   2440:                 }
1.591     raeburn  2441:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2442:                     $intarg = $in{'curr_autharg'};
                   2443:                 }
                   2444:             } else {
                   2445:                 $result = &mt('Currently internally authenticated.');
                   2446:                 return $result;
1.165     raeburn  2447:             }
                   2448:         }
1.586     raeburn  2449:     } else {
                   2450:         if ($authnum == 1) {
1.784     bisitz   2451:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2452:         }
                   2453:     }
                   2454:     if (!$can_assign{'int'}) {
                   2455:         return;
1.587     raeburn  2456:     } elsif ($authtype eq '') {
1.591     raeburn  2457:         if (defined($in{'mode'})) {
1.587     raeburn  2458:             if ($in{'mode'} eq 'modifycourse') {
                   2459:                 if ($authnum == 1) {
1.784     bisitz   2460:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2461:                 }
                   2462:             }
                   2463:         }
1.165     raeburn  2464:     }
1.586     raeburn  2465:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2466:     if ($authtype eq '') {
                   2467:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2468:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2469:     }
1.605     bisitz   2470:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2471:                $intarg.'" onchange="'.$jscall.'" />';
                   2472:     $result = &mt
1.144     matthew  2473:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2474:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2475:     $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  2476:     return $result;
                   2477: }
                   2478: 
                   2479: sub authform_local{  
                   2480:     my %in = (
                   2481:               formname => 'document.cu',
                   2482:               kerb_def_dom => 'MSU.EDU',
                   2483:               @_,
                   2484:               );
1.586     raeburn  2485:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2486:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2487:     if (defined($in{'curr_authtype'})) {
                   2488:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2489:             if ($can_assign{'loc'}) {
1.772     bisitz   2490:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2491:                 if (defined($in{'mode'})) {
                   2492:                     if ($in{'mode'} eq 'modifyuser') {
                   2493:                         $loccheck = '';
                   2494:                     }
                   2495:                 }
1.591     raeburn  2496:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2497:                     $locarg = $in{'curr_autharg'};
                   2498:                 }
                   2499:             } else {
                   2500:                 $result = &mt('Currently using local (institutional) authentication.');
                   2501:                 return $result;
1.165     raeburn  2502:             }
                   2503:         }
1.586     raeburn  2504:     } else {
                   2505:         if ($authnum == 1) {
1.784     bisitz   2506:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2507:         }
                   2508:     }
                   2509:     if (!$can_assign{'loc'}) {
                   2510:         return;
1.587     raeburn  2511:     } elsif ($authtype eq '') {
1.591     raeburn  2512:         if (defined($in{'mode'})) {
1.587     raeburn  2513:             if ($in{'mode'} eq 'modifycourse') {
                   2514:                 if ($authnum == 1) {
1.784     bisitz   2515:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2516:                 }
                   2517:             }
                   2518:         }
1.165     raeburn  2519:     }
1.586     raeburn  2520:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2521:     if ($authtype eq '') {
                   2522:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2523:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2524:                     $jscall.'" />';
                   2525:     }
                   2526:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2527:                $locarg.'" onchange="'.$jscall.'" />';
                   2528:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2529:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2530:     return $result;
                   2531: }
                   2532: 
                   2533: sub authform_filesystem{  
                   2534:     my %in = (
                   2535:               formname => 'document.cu',
                   2536:               kerb_def_dom => 'MSU.EDU',
                   2537:               @_,
                   2538:               );
1.586     raeburn  2539:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2540:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2541:     if (defined($in{'curr_authtype'})) {
                   2542:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2543:             if ($can_assign{'fsys'}) {
1.772     bisitz   2544:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2545:                 if (defined($in{'mode'})) {
                   2546:                     if ($in{'mode'} eq 'modifyuser') {
                   2547:                         $fsyscheck = '';
                   2548:                     }
                   2549:                 }
1.586     raeburn  2550:             } else {
                   2551:                 $result = &mt('Currently Filesystem Authenticated.');
                   2552:                 return $result;
                   2553:             }           
                   2554:         }
                   2555:     } else {
                   2556:         if ($authnum == 1) {
1.784     bisitz   2557:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2558:         }
                   2559:     }
                   2560:     if (!$can_assign{'fsys'}) {
                   2561:         return;
1.587     raeburn  2562:     } elsif ($authtype eq '') {
1.591     raeburn  2563:         if (defined($in{'mode'})) {
1.587     raeburn  2564:             if ($in{'mode'} eq 'modifycourse') {
                   2565:                 if ($authnum == 1) {
1.784     bisitz   2566:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2567:                 }
                   2568:             }
                   2569:         }
1.586     raeburn  2570:     }
                   2571:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2572:     if ($authtype eq '') {
                   2573:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2574:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2575:                     $jscall.'" />';
                   2576:     }
                   2577:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2578:                ' onchange="'.$jscall.'" />';
                   2579:     $result = &mt
1.144     matthew  2580:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2581:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2582:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2583:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2584:                   'onchange="'.$jscall.'" />');
1.32      matthew  2585:     return $result;
                   2586: }
                   2587: 
1.586     raeburn  2588: sub get_assignable_auth {
                   2589:     my ($dom) = @_;
                   2590:     if ($dom eq '') {
                   2591:         $dom = $env{'request.role.domain'};
                   2592:     }
                   2593:     my %can_assign = (
                   2594:                           krb4 => 1,
                   2595:                           krb5 => 1,
                   2596:                           int  => 1,
                   2597:                           loc  => 1,
                   2598:                      );
                   2599:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2600:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2601:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2602:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2603:             my $context;
                   2604:             if ($env{'request.role'} =~ /^au/) {
                   2605:                 $context = 'author';
                   2606:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2607:                 $context = 'domain';
                   2608:             } elsif ($env{'request.course.id'}) {
                   2609:                 $context = 'course';
                   2610:             }
                   2611:             if ($context) {
                   2612:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2613:                    %can_assign = %{$authhash->{$context}}; 
                   2614:                 }
                   2615:             }
                   2616:         }
                   2617:     }
                   2618:     my $authnum = 0;
                   2619:     foreach my $key (keys(%can_assign)) {
                   2620:         if ($can_assign{$key}) {
                   2621:             $authnum ++;
                   2622:         }
                   2623:     }
                   2624:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2625:         $authnum --;
                   2626:     }
                   2627:     return ($authnum,%can_assign);
                   2628: }
                   2629: 
1.80      albertel 2630: ###############################################################
                   2631: ##    Get Kerberos Defaults for Domain                 ##
                   2632: ###############################################################
                   2633: ##
                   2634: ## Returns default kerberos version and an associated argument
                   2635: ## as listed in file domain.tab. If not listed, provides
                   2636: ## appropriate default domain and kerberos version.
                   2637: ##
                   2638: #-------------------------------------------
                   2639: 
                   2640: =pod
                   2641: 
1.648     raeburn  2642: =item * &get_kerberos_defaults()
1.80      albertel 2643: 
                   2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2645: version and domain. If not found, it defaults to version 4 and the 
                   2646: domain of the server.
1.80      albertel 2647: 
1.648     raeburn  2648: =over 4
                   2649: 
1.80      albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2651: 
1.648     raeburn  2652: =back
                   2653: 
                   2654: =back
                   2655: 
1.80      albertel 2656: =cut
                   2657: 
                   2658: #-------------------------------------------
                   2659: sub get_kerberos_defaults {
                   2660:     my $domain=shift;
1.641     raeburn  2661:     my ($krbdef,$krbdefdom);
                   2662:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2663:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2664:         $krbdef = $domdefaults{'auth_def'};
                   2665:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2666:     } else {
1.80      albertel 2667:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2668:         my $krbdefdom=$1;
                   2669:         $krbdefdom=~tr/a-z/A-Z/;
                   2670:         $krbdef = "krb4";
                   2671:     }
                   2672:     return ($krbdef,$krbdefdom);
                   2673: }
1.112     bowersj2 2674: 
1.32      matthew  2675: 
1.46      matthew  2676: ###############################################################
                   2677: ##                Thesaurus Functions                        ##
                   2678: ###############################################################
1.20      www      2679: 
1.46      matthew  2680: =pod
1.20      www      2681: 
1.112     bowersj2 2682: =head1 Thesaurus Functions
                   2683: 
                   2684: =over 4
                   2685: 
1.648     raeburn  2686: =item * &initialize_keywords()
1.46      matthew  2687: 
                   2688: Initializes the package variable %Keywords if it is empty.  Uses the
                   2689: package variable $thesaurus_db_file.
                   2690: 
                   2691: =cut
                   2692: 
                   2693: ###################################################
                   2694: 
                   2695: sub initialize_keywords {
                   2696:     return 1 if (scalar keys(%Keywords));
                   2697:     # If we are here, %Keywords is empty, so fill it up
                   2698:     #   Make sure the file we need exists...
                   2699:     if (! -e $thesaurus_db_file) {
                   2700:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2701:                                  " failed because it does not exist");
                   2702:         return 0;
                   2703:     }
                   2704:     #   Set up the hash as a database
                   2705:     my %thesaurus_db;
                   2706:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2707:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2708:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2709:                                  $thesaurus_db_file);
                   2710:         return 0;
                   2711:     } 
                   2712:     #  Get the average number of appearances of a word.
                   2713:     my $avecount = $thesaurus_db{'average.count'};
                   2714:     #  Put keywords (those that appear > average) into %Keywords
                   2715:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2716:         my ($count,undef) = split /:/,$data;
                   2717:         $Keywords{$word}++ if ($count > $avecount);
                   2718:     }
                   2719:     untie %thesaurus_db;
                   2720:     # Remove special values from %Keywords.
1.356     albertel 2721:     foreach my $value ('total.count','average.count') {
                   2722:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2723:   }
1.46      matthew  2724:     return 1;
                   2725: }
                   2726: 
                   2727: ###################################################
                   2728: 
                   2729: =pod
                   2730: 
1.648     raeburn  2731: =item * &keyword($word)
1.46      matthew  2732: 
                   2733: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2734: than the average number of times in the thesaurus database.  Calls 
                   2735: &initialize_keywords
                   2736: 
                   2737: =cut
                   2738: 
                   2739: ###################################################
1.20      www      2740: 
                   2741: sub keyword {
1.46      matthew  2742:     return if (!&initialize_keywords());
                   2743:     my $word=lc(shift());
                   2744:     $word=~s/\W//g;
                   2745:     return exists($Keywords{$word});
1.20      www      2746: }
1.46      matthew  2747: 
                   2748: ###############################################################
                   2749: 
                   2750: =pod 
1.20      www      2751: 
1.648     raeburn  2752: =item * &get_related_words()
1.46      matthew  2753: 
1.160     matthew  2754: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2755: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2756: will be returned.  The order of the words returned is determined by the
                   2757: database which holds them.
                   2758: 
                   2759: Uses global $thesaurus_db_file.
                   2760: 
                   2761: =cut
                   2762: 
                   2763: ###############################################################
                   2764: sub get_related_words {
                   2765:     my $keyword = shift;
                   2766:     my %thesaurus_db;
                   2767:     if (! -e $thesaurus_db_file) {
                   2768:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2769:                                  "failed because the file does not exist");
                   2770:         return ();
                   2771:     }
                   2772:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2773:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2774:         return ();
                   2775:     } 
                   2776:     my @Words=();
1.429     www      2777:     my $count=0;
1.46      matthew  2778:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2779: 	# The first element is the number of times
                   2780: 	# the word appears.  We do not need it now.
1.429     www      2781: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2782: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2783: 	my $threshold=$mostfrequentcount/10;
                   2784:         foreach my $possibleword (@RelatedWords) {
                   2785:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2786:             if ($wordcount>$threshold) {
                   2787: 		push(@Words,$word);
                   2788:                 $count++;
                   2789:                 if ($count>10) { last; }
                   2790: 	    }
1.20      www      2791:         }
                   2792:     }
1.46      matthew  2793:     untie %thesaurus_db;
                   2794:     return @Words;
1.14      harris41 2795: }
1.46      matthew  2796: 
1.112     bowersj2 2797: =pod
                   2798: 
                   2799: =back
                   2800: 
                   2801: =cut
1.61      www      2802: 
                   2803: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2804: =pod
                   2805: 
1.112     bowersj2 2806: =head1 User Name Functions
                   2807: 
                   2808: =over 4
                   2809: 
1.648     raeburn  2810: =item * &plainname($uname,$udom,$first)
1.81      albertel 2811: 
1.112     bowersj2 2812: Takes a users logon name and returns it as a string in
1.226     albertel 2813: "first middle last generation" form 
                   2814: if $first is set to 'lastname' then it returns it as
                   2815: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2816: 
                   2817: =cut
1.61      www      2818: 
1.295     www      2819: 
1.81      albertel 2820: ###############################################################
1.61      www      2821: sub plainname {
1.226     albertel 2822:     my ($uname,$udom,$first)=@_;
1.537     albertel 2823:     return if (!defined($uname) || !defined($udom));
1.295     www      2824:     my %names=&getnames($uname,$udom);
1.226     albertel 2825:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2826: 					  $names{'middlename'},
                   2827: 					  $names{'lastname'},
                   2828: 					  $names{'generation'},$first);
                   2829:     $name=~s/^\s+//;
1.62      www      2830:     $name=~s/\s+$//;
                   2831:     $name=~s/\s+/ /g;
1.353     albertel 2832:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2833:     return $name;
1.61      www      2834: }
1.66      www      2835: 
                   2836: # -------------------------------------------------------------------- Nickname
1.81      albertel 2837: =pod
                   2838: 
1.648     raeburn  2839: =item * &nickname($uname,$udom)
1.81      albertel 2840: 
                   2841: Gets a users name and returns it as a string as
                   2842: 
                   2843: "&quot;nickname&quot;"
1.66      www      2844: 
1.81      albertel 2845: if the user has a nickname or
                   2846: 
                   2847: "first middle last generation"
                   2848: 
                   2849: if the user does not
                   2850: 
                   2851: =cut
1.66      www      2852: 
                   2853: sub nickname {
                   2854:     my ($uname,$udom)=@_;
1.537     albertel 2855:     return if (!defined($uname) || !defined($udom));
1.295     www      2856:     my %names=&getnames($uname,$udom);
1.68      albertel 2857:     my $name=$names{'nickname'};
1.66      www      2858:     if ($name) {
                   2859:        $name='&quot;'.$name.'&quot;'; 
                   2860:     } else {
                   2861:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2862: 	     $names{'lastname'}.' '.$names{'generation'};
                   2863:        $name=~s/\s+$//;
                   2864:        $name=~s/\s+/ /g;
                   2865:     }
                   2866:     return $name;
                   2867: }
                   2868: 
1.295     www      2869: sub getnames {
                   2870:     my ($uname,$udom)=@_;
1.537     albertel 2871:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2872:     if ($udom eq 'public' && $uname eq 'public') {
                   2873: 	return ('lastname' => &mt('Public'));
                   2874:     }
1.295     www      2875:     my $id=$uname.':'.$udom;
                   2876:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2877:     if ($cached) {
                   2878: 	return %{$names};
                   2879:     } else {
                   2880: 	my %loadnames=&Apache::lonnet::get('environment',
                   2881:                     ['firstname','middlename','lastname','generation','nickname'],
                   2882: 					 $udom,$uname);
                   2883: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2884: 	return %loadnames;
                   2885:     }
                   2886: }
1.61      www      2887: 
1.542     raeburn  2888: # -------------------------------------------------------------------- getemails
1.648     raeburn  2889: 
1.542     raeburn  2890: =pod
                   2891: 
1.648     raeburn  2892: =item * &getemails($uname,$udom)
1.542     raeburn  2893: 
                   2894: Gets a user's email information and returns it as a hash with keys:
                   2895: notification, critnotification, permanentemail
                   2896: 
                   2897: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2899:  
1.648     raeburn  2900: 
1.542     raeburn  2901: =cut
                   2902: 
1.648     raeburn  2903: 
1.466     albertel 2904: sub getemails {
                   2905:     my ($uname,$udom)=@_;
                   2906:     if ($udom eq 'public' && $uname eq 'public') {
                   2907: 	return;
                   2908:     }
1.467     www      2909:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2910:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2911:     my $id=$uname.':'.$udom;
                   2912:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2913:     if ($cached) {
                   2914: 	return %{$names};
                   2915:     } else {
                   2916: 	my %loadnames=&Apache::lonnet::get('environment',
                   2917:                     			   ['notification','critnotification',
                   2918: 					    'permanentemail'],
                   2919: 					   $udom,$uname);
                   2920: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2921: 	return %loadnames;
                   2922:     }
                   2923: }
                   2924: 
1.551     albertel 2925: sub flush_email_cache {
                   2926:     my ($uname,$udom)=@_;
                   2927:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2928:     if (!$uname) { $uname=$env{'user.name'};   }
                   2929:     return if ($udom eq 'public' && $uname eq 'public');
                   2930:     my $id=$uname.':'.$udom;
                   2931:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2932: }
                   2933: 
1.728     raeburn  2934: # -------------------------------------------------------------------- getlangs
                   2935: 
                   2936: =pod
                   2937: 
                   2938: =item * &getlangs($uname,$udom)
                   2939: 
                   2940: Gets a user's language preference and returns it as a hash with key:
                   2941: language.
                   2942: 
                   2943: =cut
                   2944: 
                   2945: 
                   2946: sub getlangs {
                   2947:     my ($uname,$udom) = @_;
                   2948:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2949:     if (!$uname) { $uname=$env{'user.name'};   }
                   2950:     my $id=$uname.':'.$udom;
                   2951:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2952:     if ($cached) {
                   2953:         return %{$langs};
                   2954:     } else {
                   2955:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2956:                                            $udom,$uname);
                   2957:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2958:         return %loadlangs;
                   2959:     }
                   2960: }
                   2961: 
                   2962: sub flush_langs_cache {
                   2963:     my ($uname,$udom)=@_;
                   2964:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2965:     if (!$uname) { $uname=$env{'user.name'};   }
                   2966:     return if ($udom eq 'public' && $uname eq 'public');
                   2967:     my $id=$uname.':'.$udom;
                   2968:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2969: }
                   2970: 
1.61      www      2971: # ------------------------------------------------------------------ Screenname
1.81      albertel 2972: 
                   2973: =pod
                   2974: 
1.648     raeburn  2975: =item * &screenname($uname,$udom)
1.81      albertel 2976: 
                   2977: Gets a users screenname and returns it as a string
                   2978: 
                   2979: =cut
1.61      www      2980: 
                   2981: sub screenname {
                   2982:     my ($uname,$udom)=@_;
1.258     albertel 2983:     if ($uname eq $env{'user.name'} &&
                   2984: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2985:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2986:     return $names{'screenname'};
1.62      www      2987: }
                   2988: 
1.212     albertel 2989: 
1.802     bisitz   2990: # ------------------------------------------------------------- Confirm Wrapper
                   2991: =pod
                   2992: 
                   2993: =item confirmwrapper
                   2994: 
                   2995: Wrap messages about completion of operation in box
                   2996: 
                   2997: =cut
                   2998: 
                   2999: sub confirmwrapper {
                   3000:     my ($message)=@_;
                   3001:     if ($message) {
                   3002:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3003:                .$message."\n"
                   3004:                .'</div>'."\n";
                   3005:     } else {
                   3006:         return $message;
                   3007:     }
                   3008: }
                   3009: 
1.62      www      3010: # ------------------------------------------------------------- Message Wrapper
                   3011: 
                   3012: sub messagewrapper {
1.369     www      3013:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3014:     return 
1.441     albertel 3015:         '<a href="/adm/email?compose=individual&amp;'.
                   3016:         'recname='.$username.'&amp;recdom='.$domain.
                   3017: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3018:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3019: }
1.802     bisitz   3020: 
1.74      www      3021: # --------------------------------------------------------------- Notes Wrapper
                   3022: 
                   3023: sub noteswrapper {
                   3024:     my ($link,$un,$do)=@_;
                   3025:     return 
1.896     amueller 3026: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3027: }
1.802     bisitz   3028: 
1.62      www      3029: # ------------------------------------------------------------- Aboutme Wrapper
                   3030: 
                   3031: sub aboutmewrapper {
1.166     www      3032:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3033:     if (!defined($username)  && !defined($domain)) {
                   3034:         return;
                   3035:     }
1.892     amueller 3036:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3037: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3038: }
                   3039: 
                   3040: # ------------------------------------------------------------ Syllabus Wrapper
                   3041: 
                   3042: sub syllabuswrapper {
1.707     bisitz   3043:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3044:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3045: }
1.14      harris41 3046: 
1.802     bisitz   3047: # -----------------------------------------------------------------------------
                   3048: 
1.208     matthew  3049: sub track_student_link {
1.887     raeburn  3050:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3051:     my $link ="/adm/trackstudent?";
1.208     matthew  3052:     my $title = 'View recent activity';
                   3053:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3054:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3055:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3056:         $title .= ' of this student';
1.268     albertel 3057:     } 
1.208     matthew  3058:     if (defined($target) && $target !~ /^\s*$/) {
                   3059:         $target = qq{target="$target"};
                   3060:     } else {
                   3061:         $target = '';
                   3062:     }
1.268     albertel 3063:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3064:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3065:     $title = &mt($title);
                   3066:     $linktext = &mt($linktext);
1.448     albertel 3067:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3068: 	&help_open_topic('View_recent_activity');
1.208     matthew  3069: }
                   3070: 
1.781     raeburn  3071: sub slot_reservations_link {
                   3072:     my ($linktext,$sname,$sdom,$target) = @_;
                   3073:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3074:     my $title = 'View slot reservation history';
                   3075:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3076:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3077:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3078:         $title .= ' of this student';
                   3079:     }
                   3080:     if (defined($target) && $target !~ /^\s*$/) {
                   3081:         $target = qq{target="$target"};
                   3082:     } else {
                   3083:         $target = '';
                   3084:     }
                   3085:     $title = &mt($title);
                   3086:     $linktext = &mt($linktext);
                   3087:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3089: 
                   3090: }
                   3091: 
1.508     www      3092: # ===================================================== Display a student photo
                   3093: 
                   3094: 
1.509     albertel 3095: sub student_image_tag {
1.508     www      3096:     my ($domain,$user)=@_;
                   3097:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3098:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3099: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3100:     } else {
                   3101: 	return '';
                   3102:     }
                   3103: }
                   3104: 
1.112     bowersj2 3105: =pod
                   3106: 
                   3107: =back
                   3108: 
                   3109: =head1 Access .tab File Data
                   3110: 
                   3111: =over 4
                   3112: 
1.648     raeburn  3113: =item * &languageids() 
1.112     bowersj2 3114: 
                   3115: returns list of all language ids
                   3116: 
                   3117: =cut
                   3118: 
1.14      harris41 3119: sub languageids {
1.16      harris41 3120:     return sort(keys(%language));
1.14      harris41 3121: }
                   3122: 
1.112     bowersj2 3123: =pod
                   3124: 
1.648     raeburn  3125: =item * &languagedescription() 
1.112     bowersj2 3126: 
                   3127: returns description of a specified language id
                   3128: 
                   3129: =cut
                   3130: 
1.14      harris41 3131: sub languagedescription {
1.125     www      3132:     my $code=shift;
                   3133:     return  ($supported_language{$code}?'* ':'').
                   3134:             $language{$code}.
1.126     www      3135: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3136: }
                   3137: 
                   3138: sub plainlanguagedescription {
                   3139:     my $code=shift;
                   3140:     return $language{$code};
                   3141: }
                   3142: 
                   3143: sub supportedlanguagecode {
                   3144:     my $code=shift;
                   3145:     return $supported_language{$code};
1.97      www      3146: }
                   3147: 
1.112     bowersj2 3148: =pod
                   3149: 
1.648     raeburn  3150: =item * &copyrightids() 
1.112     bowersj2 3151: 
                   3152: returns list of all copyrights
                   3153: 
                   3154: =cut
                   3155: 
                   3156: sub copyrightids {
                   3157:     return sort(keys(%cprtag));
                   3158: }
                   3159: 
                   3160: =pod
                   3161: 
1.648     raeburn  3162: =item * &copyrightdescription() 
1.112     bowersj2 3163: 
                   3164: returns description of a specified copyright id
                   3165: 
                   3166: =cut
                   3167: 
                   3168: sub copyrightdescription {
1.166     www      3169:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3170: }
1.197     matthew  3171: 
                   3172: =pod
                   3173: 
1.648     raeburn  3174: =item * &source_copyrightids() 
1.192     taceyjo1 3175: 
                   3176: returns list of all source copyrights
                   3177: 
                   3178: =cut
                   3179: 
                   3180: sub source_copyrightids {
                   3181:     return sort(keys(%scprtag));
                   3182: }
                   3183: 
                   3184: =pod
                   3185: 
1.648     raeburn  3186: =item * &source_copyrightdescription() 
1.192     taceyjo1 3187: 
                   3188: returns description of a specified source copyright id
                   3189: 
                   3190: =cut
                   3191: 
                   3192: sub source_copyrightdescription {
                   3193:     return &mt($scprtag{shift(@_)});
                   3194: }
1.112     bowersj2 3195: 
                   3196: =pod
                   3197: 
1.648     raeburn  3198: =item * &filecategories() 
1.112     bowersj2 3199: 
                   3200: returns list of all file categories
                   3201: 
                   3202: =cut
                   3203: 
                   3204: sub filecategories {
                   3205:     return sort(keys(%category_extensions));
                   3206: }
                   3207: 
                   3208: =pod
                   3209: 
1.648     raeburn  3210: =item * &filecategorytypes() 
1.112     bowersj2 3211: 
                   3212: returns list of file types belonging to a given file
                   3213: category
                   3214: 
                   3215: =cut
                   3216: 
                   3217: sub filecategorytypes {
1.356     albertel 3218:     my ($cat) = @_;
                   3219:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3220: }
                   3221: 
                   3222: =pod
                   3223: 
1.648     raeburn  3224: =item * &fileembstyle() 
1.112     bowersj2 3225: 
                   3226: returns embedding style for a specified file type
                   3227: 
                   3228: =cut
                   3229: 
                   3230: sub fileembstyle {
                   3231:     return $fe{lc(shift(@_))};
1.169     www      3232: }
                   3233: 
1.351     www      3234: sub filemimetype {
                   3235:     return $fm{lc(shift(@_))};
                   3236: }
                   3237: 
1.169     www      3238: 
                   3239: sub filecategoryselect {
                   3240:     my ($name,$value)=@_;
1.189     matthew  3241:     return &select_form($value,$name,
1.169     www      3242: 			'' => &mt('Any category'),
                   3243: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3244: }
                   3245: 
                   3246: =pod
                   3247: 
1.648     raeburn  3248: =item * &filedescription() 
1.112     bowersj2 3249: 
                   3250: returns description for a specified file type
                   3251: 
                   3252: =cut
                   3253: 
                   3254: sub filedescription {
1.188     matthew  3255:     my $file_description = $fd{lc(shift())};
                   3256:     $file_description =~ s:([\[\]]):~$1:g;
                   3257:     return &mt($file_description);
1.112     bowersj2 3258: }
                   3259: 
                   3260: =pod
                   3261: 
1.648     raeburn  3262: =item * &filedescriptionex() 
1.112     bowersj2 3263: 
                   3264: returns description for a specified file type with
                   3265: extra formatting
                   3266: 
                   3267: =cut
                   3268: 
                   3269: sub filedescriptionex {
                   3270:     my $ex=shift;
1.188     matthew  3271:     my $file_description = $fd{lc($ex)};
                   3272:     $file_description =~ s:([\[\]]):~$1:g;
                   3273:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3274: }
                   3275: 
                   3276: # End of .tab access
                   3277: =pod
                   3278: 
                   3279: =back
                   3280: 
                   3281: =cut
                   3282: 
                   3283: # ------------------------------------------------------------------ File Types
                   3284: sub fileextensions {
                   3285:     return sort(keys(%fe));
                   3286: }
                   3287: 
1.97      www      3288: # ----------------------------------------------------------- Display Languages
                   3289: # returns a hash with all desired display languages
                   3290: #
                   3291: 
                   3292: sub display_languages {
                   3293:     my %languages=();
1.695     raeburn  3294:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3295: 	$languages{$lang}=1;
1.97      www      3296:     }
                   3297:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3298:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3299: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3300: 	    $languages{$lang}=1;
1.97      www      3301:         }
                   3302:     }
                   3303:     return %languages;
1.14      harris41 3304: }
                   3305: 
1.582     albertel 3306: sub languages {
                   3307:     my ($possible_langs) = @_;
1.695     raeburn  3308:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3309:     if (!ref($possible_langs)) {
                   3310: 	if( wantarray ) {
                   3311: 	    return @preferred_langs;
                   3312: 	} else {
                   3313: 	    return $preferred_langs[0];
                   3314: 	}
                   3315:     }
                   3316:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3317:     my @preferred_possibilities;
                   3318:     foreach my $preferred_lang (@preferred_langs) {
                   3319: 	if (exists($possibilities{$preferred_lang})) {
                   3320: 	    push(@preferred_possibilities, $preferred_lang);
                   3321: 	}
                   3322:     }
                   3323:     if( wantarray ) {
                   3324: 	return @preferred_possibilities;
                   3325:     }
                   3326:     return $preferred_possibilities[0];
                   3327: }
                   3328: 
1.742     raeburn  3329: sub user_lang {
                   3330:     my ($touname,$toudom,$fromcid) = @_;
                   3331:     my @userlangs;
                   3332:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3333:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3334:                     $env{'course.'.$fromcid.'.languages'}));
                   3335:     } else {
                   3336:         my %langhash = &getlangs($touname,$toudom);
                   3337:         if ($langhash{'languages'} ne '') {
                   3338:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3339:         } else {
                   3340:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3341:             if ($domdefs{'lang_def'} ne '') {
                   3342:                 @userlangs = ($domdefs{'lang_def'});
                   3343:             }
                   3344:         }
                   3345:     }
                   3346:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3347:     my $user_lh = Apache::localize->get_handle(@languages);
                   3348:     return $user_lh;
                   3349: }
                   3350: 
                   3351: 
1.112     bowersj2 3352: ###############################################################
                   3353: ##               Student Answer Attempts                     ##
                   3354: ###############################################################
                   3355: 
                   3356: =pod
                   3357: 
                   3358: =head1 Alternate Problem Views
                   3359: 
                   3360: =over 4
                   3361: 
1.648     raeburn  3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3363:     $getattempt, $regexp, $gradesub)
                   3364: 
                   3365: Return string with previous attempt on problem. Arguments:
                   3366: 
                   3367: =over 4
                   3368: 
                   3369: =item * $symb: Problem, including path
                   3370: 
                   3371: =item * $username: username of the desired student
                   3372: 
                   3373: =item * $domain: domain of the desired student
1.14      harris41 3374: 
1.112     bowersj2 3375: =item * $course: Course ID
1.14      harris41 3376: 
1.112     bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3378:     something
1.14      harris41 3379: 
1.112     bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
                   3381:     sent to $gradesub
1.14      harris41 3382: 
1.112     bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3384: 
1.112     bowersj2 3385: =back
1.14      harris41 3386: 
1.112     bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16      harris41 3388: 
1.112     bowersj2 3389: =cut
1.1       albertel 3390: 
                   3391: sub get_previous_attempt {
1.43      ng       3392:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3393:   my $prevattempts='';
1.43      ng       3394:   no strict 'refs';
1.1       albertel 3395:   if ($symb) {
1.3       albertel 3396:     my (%returnhash)=
                   3397:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3398:     if ($returnhash{'version'}) {
                   3399:       my %lasthash=();
                   3400:       my $version;
                   3401:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3402:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3403: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3404:         }
1.1       albertel 3405:       }
1.596     albertel 3406:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3407:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3408:       foreach my $key (sort(keys(%lasthash))) {
                   3409: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3410: 	if ($#parts > 0) {
1.31      albertel 3411: 	  my $data=$parts[-1];
                   3412: 	  pop(@parts);
1.596     albertel 3413: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3414: 	} else {
1.41      ng       3415: 	  if ($#parts == 0) {
                   3416: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3417: 	  } else {
                   3418: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3419: 	  }
1.31      albertel 3420: 	}
1.16      harris41 3421:       }
1.596     albertel 3422:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3423:       if ($getattempt eq '') {
                   3424: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3425: 	  $prevattempts.=&start_data_table_row().
                   3426: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3427: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3428: 		my $value = &format_previous_attempt_value($key,
                   3429: 							   $returnhash{$version.':'.$key});
                   3430: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3431: 	    }
1.596     albertel 3432: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3433: 	 }
1.1       albertel 3434:       }
1.596     albertel 3435:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3436:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3437: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3438: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3439: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3440:       }
1.596     albertel 3441:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3442:     } else {
1.596     albertel 3443:       $prevattempts=
                   3444: 	  &start_data_table().&start_data_table_row().
                   3445: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3446: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3447:     }
                   3448:   } else {
1.596     albertel 3449:     $prevattempts=
                   3450: 	  &start_data_table().&start_data_table_row().
                   3451: 	  '<td>'.&mt('No data.').'</td>'.
                   3452: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3453:   }
1.10      albertel 3454: }
                   3455: 
1.581     albertel 3456: sub format_previous_attempt_value {
                   3457:     my ($key,$value) = @_;
                   3458:     if ($key =~ /timestamp/) {
                   3459: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3460:     } elsif (ref($value) eq 'ARRAY') {
                   3461: 	$value = '('.join(', ', @{ $value }).')';
                   3462:     } else {
                   3463: 	$value = &unescape($value);
                   3464:     }
                   3465:     return $value;
                   3466: }
                   3467: 
                   3468: 
1.107     albertel 3469: sub relative_to_absolute {
                   3470:     my ($url,$output)=@_;
                   3471:     my $parser=HTML::TokeParser->new(\$output);
                   3472:     my $token;
                   3473:     my $thisdir=$url;
                   3474:     my @rlinks=();
                   3475:     while ($token=$parser->get_token) {
                   3476: 	if ($token->[0] eq 'S') {
                   3477: 	    if ($token->[1] eq 'a') {
                   3478: 		if ($token->[2]->{'href'}) {
                   3479: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3480: 		}
                   3481: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3482: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3483: 	    } elsif ($token->[1] eq 'base') {
                   3484: 		$thisdir=$token->[2]->{'href'};
                   3485: 	    }
                   3486: 	}
                   3487:     }
                   3488:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3489:     foreach my $link (@rlinks) {
1.726     raeburn  3490: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3491: 		($link=~/^\//) ||
                   3492: 		($link=~/^javascript:/i) ||
                   3493: 		($link=~/^mailto:/i) ||
                   3494: 		($link=~/^\#/)) {
                   3495: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3496: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3497: 	}
                   3498:     }
                   3499: # -------------------------------------------------- Deal with Applet codebases
                   3500:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3501:     return $output;
                   3502: }
                   3503: 
1.112     bowersj2 3504: =pod
                   3505: 
1.648     raeburn  3506: =item * &get_student_view()
1.112     bowersj2 3507: 
                   3508: show a snapshot of what student was looking at
                   3509: 
                   3510: =cut
                   3511: 
1.10      albertel 3512: sub get_student_view {
1.186     albertel 3513:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3514:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3515:   my (%form);
1.10      albertel 3516:   my @elements=('symb','courseid','domain','username');
                   3517:   foreach my $element (@elements) {
1.186     albertel 3518:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3519:   }
1.186     albertel 3520:   if (defined($moreenv)) {
                   3521:       %form=(%form,%{$moreenv});
                   3522:   }
1.236     albertel 3523:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3524:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3525:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3526:   $userview=~s/\<body[^\>]*\>//gi;
                   3527:   $userview=~s/\<\/body\>//gi;
                   3528:   $userview=~s/\<html\>//gi;
                   3529:   $userview=~s/\<\/html\>//gi;
                   3530:   $userview=~s/\<head\>//gi;
                   3531:   $userview=~s/\<\/head\>//gi;
                   3532:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3533:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3534:   if (wantarray) {
                   3535:      return ($userview,$response);
                   3536:   } else {
                   3537:      return $userview;
                   3538:   }
                   3539: }
                   3540: 
                   3541: sub get_student_view_with_retries {
                   3542:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3543: 
                   3544:     my $ok = 0;                 # True if we got a good response.
                   3545:     my $content;
                   3546:     my $response;
                   3547: 
                   3548:     # Try to get the student_view done. within the retries count:
                   3549:     
                   3550:     do {
                   3551:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3552:          $ok      = $response->is_success;
                   3553:          if (!$ok) {
                   3554:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3555:          }
                   3556:          $retries--;
                   3557:     } while (!$ok && ($retries > 0));
                   3558:     
                   3559:     if (!$ok) {
                   3560:        $content = '';          # On error return an empty content.
                   3561:     }
1.651     www      3562:     if (wantarray) {
                   3563:        return ($content, $response);
                   3564:     } else {
                   3565:        return $content;
                   3566:     }
1.11      albertel 3567: }
                   3568: 
1.112     bowersj2 3569: =pod
                   3570: 
1.648     raeburn  3571: =item * &get_student_answers() 
1.112     bowersj2 3572: 
                   3573: show a snapshot of how student was answering problem
                   3574: 
                   3575: =cut
                   3576: 
1.11      albertel 3577: sub get_student_answers {
1.100     sakharuk 3578:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3579:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3580:   my (%moreenv);
1.11      albertel 3581:   my @elements=('symb','courseid','domain','username');
                   3582:   foreach my $element (@elements) {
1.186     albertel 3583:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3584:   }
1.186     albertel 3585:   $moreenv{'grade_target'}='answer';
                   3586:   %moreenv=(%form,%moreenv);
1.497     raeburn  3587:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3588:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3589:   return $userview;
1.1       albertel 3590: }
1.116     albertel 3591: 
                   3592: =pod
                   3593: 
                   3594: =item * &submlink()
                   3595: 
1.242     albertel 3596: Inputs: $text $uname $udom $symb $target
1.116     albertel 3597: 
                   3598: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3599: 
                   3600: =cut
                   3601: 
                   3602: ###############################################
                   3603: sub submlink {
1.242     albertel 3604:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3605:     if (!($uname && $udom)) {
                   3606: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3607: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3608: 	if (!$symb) { $symb=$cursymb; }
                   3609:     }
1.254     matthew  3610:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3611:     $symb=&escape($symb);
1.242     albertel 3612:     if ($target) { $target="target=\"$target\""; }
                   3613:     return '<a href="/adm/grades?&command=submission&'.
                   3614: 	'symb='.$symb.'&student='.$uname.
                   3615: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3616: }
                   3617: ##############################################
                   3618: 
                   3619: =pod
                   3620: 
                   3621: =item * &pgrdlink()
                   3622: 
                   3623: Inputs: $text $uname $udom $symb $target
                   3624: 
                   3625: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3626: 
                   3627: =cut
                   3628: 
                   3629: ###############################################
                   3630: sub pgrdlink {
                   3631:     my $link=&submlink(@_);
                   3632:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3633:     return $link;
                   3634: }
                   3635: ##############################################
                   3636: 
                   3637: =pod
                   3638: 
                   3639: =item * &pprmlink()
                   3640: 
                   3641: Inputs: $text $uname $udom $symb $target
                   3642: 
                   3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3644: student and a specific resource
1.242     albertel 3645: 
                   3646: =cut
                   3647: 
                   3648: ###############################################
                   3649: sub pprmlink {
                   3650:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3651:     if (!($uname && $udom)) {
                   3652: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3653: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3654: 	if (!$symb) { $symb=$cursymb; }
                   3655:     }
1.254     matthew  3656:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3657:     $symb=&escape($symb);
1.242     albertel 3658:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3659:     return '<a href="/adm/parmset?command=set&amp;'.
                   3660: 	'symb='.$symb.'&amp;uname='.$uname.
                   3661: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3662: }
                   3663: ##############################################
1.37      matthew  3664: 
1.112     bowersj2 3665: =pod
                   3666: 
                   3667: =back
                   3668: 
                   3669: =cut
                   3670: 
1.37      matthew  3671: ###############################################
1.51      www      3672: 
                   3673: 
                   3674: sub timehash {
1.687     raeburn  3675:     my ($thistime) = @_;
                   3676:     my $timezone = &Apache::lonlocal::gettimezone();
                   3677:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3678:                      ->set_time_zone($timezone);
                   3679:     my $wday = $dt->day_of_week();
                   3680:     if ($wday == 7) { $wday = 0; }
                   3681:     return ( 'second' => $dt->second(),
                   3682:              'minute' => $dt->minute(),
                   3683:              'hour'   => $dt->hour(),
                   3684:              'day'     => $dt->day_of_month(),
                   3685:              'month'   => $dt->month(),
                   3686:              'year'    => $dt->year(),
                   3687:              'weekday' => $wday,
                   3688:              'dayyear' => $dt->day_of_year(),
                   3689:              'dlsav'   => $dt->is_dst() );
1.51      www      3690: }
                   3691: 
1.370     www      3692: sub utc_string {
                   3693:     my ($date)=@_;
1.371     www      3694:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3695: }
                   3696: 
1.51      www      3697: sub maketime {
                   3698:     my %th=@_;
1.687     raeburn  3699:     my ($epoch_time,$timezone,$dt);
                   3700:     $timezone = &Apache::lonlocal::gettimezone();
                   3701:     eval {
                   3702:         $dt = DateTime->new( year   => $th{'year'},
                   3703:                              month  => $th{'month'},
                   3704:                              day    => $th{'day'},
                   3705:                              hour   => $th{'hour'},
                   3706:                              minute => $th{'minute'},
                   3707:                              second => $th{'second'},
                   3708:                              time_zone => $timezone,
                   3709:                          );
                   3710:     };
                   3711:     if (!$@) {
                   3712:         $epoch_time = $dt->epoch;
                   3713:         if ($epoch_time) {
                   3714:             return $epoch_time;
                   3715:         }
                   3716:     }
1.51      www      3717:     return POSIX::mktime(
                   3718:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3719:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3720: }
                   3721: 
                   3722: #########################################
1.51      www      3723: 
                   3724: sub findallcourses {
1.482     raeburn  3725:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3726:     my %roles;
                   3727:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3728:     my %courses;
1.51      www      3729:     my $now=time;
1.482     raeburn  3730:     if (!defined($uname)) {
                   3731:         $uname = $env{'user.name'};
                   3732:     }
                   3733:     if (!defined($udom)) {
                   3734:         $udom = $env{'user.domain'};
                   3735:     }
                   3736:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3737:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3738:         if (!%roles) {
                   3739:             %roles = (
                   3740:                        cc => 1,
1.907     raeburn  3741:                        co => 1,
1.482     raeburn  3742:                        in => 1,
                   3743:                        ep => 1,
                   3744:                        ta => 1,
                   3745:                        cr => 1,
                   3746:                        st => 1,
                   3747:              );
                   3748:         }
                   3749:         foreach my $entry (keys(%roleshash)) {
                   3750:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3751:             if ($trole =~ /^cr/) { 
                   3752:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3753:             } else {
                   3754:                 next if (!exists($roles{$trole}));
                   3755:             }
                   3756:             if ($tend) {
                   3757:                 next if ($tend < $now);
                   3758:             }
                   3759:             if ($tstart) {
                   3760:                 next if ($tstart > $now);
                   3761:             }
                   3762:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3763:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3764:             if ($secpart eq '') {
                   3765:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3766:                 $sec = 'none';
                   3767:                 $realsec = '';
                   3768:             } else {
                   3769:                 $cnum = $cnumpart;
                   3770:                 ($sec,$role) = split(/_/,$secpart);
                   3771:                 $realsec = $sec;
1.490     raeburn  3772:             }
1.482     raeburn  3773:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3774:         }
                   3775:     } else {
                   3776:         foreach my $key (keys(%env)) {
1.483     albertel 3777: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3778:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3779: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3780: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3781: 	        next if (%roles && !exists($roles{$role}));
                   3782: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3783:                 my $active=1;
                   3784:                 if ($starttime) {
                   3785: 		    if ($now<$starttime) { $active=0; }
                   3786:                 }
                   3787:                 if ($endtime) {
                   3788:                     if ($now>$endtime) { $active=0; }
                   3789:                 }
                   3790:                 if ($active) {
                   3791:                     if ($sec eq '') {
                   3792:                         $sec = 'none';
                   3793:                     }
                   3794:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3795:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3796:                 }
                   3797:             }
1.51      www      3798:         }
                   3799:     }
1.474     raeburn  3800:     return %courses;
1.51      www      3801: }
1.37      matthew  3802: 
1.54      www      3803: ###############################################
1.474     raeburn  3804: 
                   3805: sub blockcheck {
1.482     raeburn  3806:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3807: 
                   3808:     if (!defined($udom)) {
                   3809:         $udom = $env{'user.domain'};
                   3810:     }
                   3811:     if (!defined($uname)) {
                   3812:         $uname = $env{'user.name'};
                   3813:     }
                   3814: 
                   3815:     # If uname and udom are for a course, check for blocks in the course.
                   3816: 
                   3817:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3818:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3819:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3820:         return ($startblock,$endblock);
                   3821:     }
1.474     raeburn  3822: 
1.502     raeburn  3823:     my $startblock = 0;
                   3824:     my $endblock = 0;
1.482     raeburn  3825:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3826: 
1.490     raeburn  3827:     # If uname is for a user, and activity is course-specific, i.e.,
                   3828:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3829: 
1.490     raeburn  3830:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3831:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3832:         foreach my $key (keys(%live_courses)) {
                   3833:             if ($key ne $env{'request.course.id'}) {
                   3834:                 delete($live_courses{$key});
                   3835:             }
                   3836:         }
                   3837:     }
                   3838: 
                   3839:     my $otheruser = 0;
                   3840:     my %own_courses;
                   3841:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3842:         # Resource belongs to user other than current user.
                   3843:         $otheruser = 1;
                   3844:         # Gather courses for current user
                   3845:         %own_courses = 
                   3846:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3847:     }
                   3848: 
                   3849:     # Gather active course roles - course coordinator, instructor, 
                   3850:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3851: 
                   3852:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3853:         my ($cdom,$cnum);
                   3854:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3855:             $cdom = $env{'course.'.$course.'.domain'};
                   3856:             $cnum = $env{'course.'.$course.'.num'};
                   3857:         } else {
1.490     raeburn  3858:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3859:         }
                   3860:         my $no_ownblock = 0;
                   3861:         my $no_userblock = 0;
1.533     raeburn  3862:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3863:             # Check if current user has 'evb' priv for this
                   3864:             if (defined($own_courses{$course})) {
                   3865:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3866:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3867:                     if ($sec ne 'none') {
                   3868:                         $checkrole .= '/'.$sec;
                   3869:                     }
                   3870:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3871:                         $no_ownblock = 1;
                   3872:                         last;
                   3873:                     }
                   3874:                 }
                   3875:             }
                   3876:             # if they have 'evb' priv and are currently not playing student
                   3877:             next if (($no_ownblock) &&
                   3878:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3879:         }
1.474     raeburn  3880:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3881:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3882:             if ($sec ne 'none') {
1.482     raeburn  3883:                 $checkrole .= '/'.$sec;
1.474     raeburn  3884:             }
1.490     raeburn  3885:             if ($otheruser) {
                   3886:                 # Resource belongs to user other than current user.
                   3887:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3888:                 my ($trole,$tdom,$tnum,$tsec);
                   3889:                 my $entry = $live_courses{$course}{$sec};
                   3890:                 if ($entry =~ /^cr/) {
                   3891:                     ($trole,$tdom,$tnum,$tsec) = 
                   3892:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3893:                 } else {
                   3894:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3895:                 }
                   3896:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3897:                 $area = '/'.$tdom.'/'.$tnum;
                   3898:                 $trest = $tnum;
                   3899:                 if ($tsec ne '') {
                   3900:                     $area .= '/'.$tsec;
                   3901:                     $trest .= '/'.$tsec;
                   3902:                 }
                   3903:                 $spec = $trole.'.'.$area;
                   3904:                 if ($trole =~ /^cr/) {
                   3905:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3906:                                                       $tdom,$spec,$trest,$area);
                   3907:                 } else {
                   3908:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3909:                                                        $tdom,$spec,$trest,$area);
                   3910:                 }
                   3911:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3912:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3913:                     if ($1) {
                   3914:                         $no_userblock = 1;
                   3915:                         last;
                   3916:                     }
                   3917:                 }
1.490     raeburn  3918:             } else {
                   3919:                 # Resource belongs to current user
                   3920:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3921:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3922:                     $no_ownblock = 1;
                   3923:                     last;
                   3924:                 }
1.474     raeburn  3925:             }
                   3926:         }
                   3927:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3928:         next if (($no_ownblock) &&
1.491     albertel 3929:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3930:         next if ($no_userblock);
1.474     raeburn  3931: 
1.866     kalberla 3932:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3933:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3934:         
                   3935:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3936:         if (($start != 0) && 
                   3937:             (($startblock == 0) || ($startblock > $start))) {
                   3938:             $startblock = $start;
                   3939:         }
                   3940:         if (($end != 0)  &&
                   3941:             (($endblock == 0) || ($endblock < $end))) {
                   3942:             $endblock = $end;
                   3943:         }
1.490     raeburn  3944:     }
                   3945:     return ($startblock,$endblock);
                   3946: }
                   3947: 
                   3948: sub get_blocks {
                   3949:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3950:     my $startblock = 0;
                   3951:     my $endblock = 0;
                   3952:     my $course = $cdom.'_'.$cnum;
                   3953:     $setters->{$course} = {};
                   3954:     $setters->{$course}{'staff'} = [];
                   3955:     $setters->{$course}{'times'} = [];
                   3956:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3957:     foreach my $record (keys(%records)) {
                   3958:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3959:         if ($start <= time && $end >= time) {
                   3960:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3961:                 &parse_block_record($records{$record});
                   3962:             if ($blocks->{$activity} eq 'on') {
                   3963:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3964:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3965:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3966:                     $startblock = $start;
1.490     raeburn  3967:                 }
1.491     albertel 3968:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3969:                     $endblock = $end;
1.474     raeburn  3970:                 }
                   3971:             }
                   3972:         }
                   3973:     }
                   3974:     return ($startblock,$endblock);
                   3975: }
                   3976: 
                   3977: sub parse_block_record {
                   3978:     my ($record) = @_;
                   3979:     my ($setuname,$setudom,$title,$blocks);
                   3980:     if (ref($record) eq 'HASH') {
                   3981:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3982:         $title = &unescape($record->{'event'});
                   3983:         $blocks = $record->{'blocks'};
                   3984:     } else {
                   3985:         my @data = split(/:/,$record,3);
                   3986:         if (scalar(@data) eq 2) {
                   3987:             $title = $data[1];
                   3988:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3989:         } else {
                   3990:             ($setuname,$setudom,$title) = @data;
                   3991:         }
                   3992:         $blocks = { 'com' => 'on' };
                   3993:     }
                   3994:     return ($setuname,$setudom,$title,$blocks);
                   3995: }
                   3996: 
1.854     kalberla 3997: sub blocking_status {
                   3998:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3999:   my %setters;
1.890     droeschl 4000: 
                   4001:   # check for active blocking
1.867     kalberla 4002:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4003: 
1.890     droeschl 4004:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4005: 
                   4006:   # caller just wants to know whether a block is active
                   4007:   if (!wantarray) { return $blocked; }
                   4008: 
                   4009:   # build a link to a popup window containing the details
                   4010:   my $querystring  = "?activity=$activity";
                   4011:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4012:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4013:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4014: 
                   4015:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4016:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4017:         var options = "width=" + w + ",height=" + h + ",";
                   4018:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4019:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4020:         var newWin = window.open(url, wdwName, options);
                   4021:         newWin.focus();
                   4022:     }
1.890     droeschl 4023: END_MYBLOCK
1.854     kalberla 4024: 
1.890     droeschl 4025:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4026:   
1.854     kalberla 4027:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4028:   my $text = mt('Communication Blocked');
                   4029: 
1.867     kalberla 4030:   $output .= <<"END_BLOCK";
                   4031: <div class='LC_comblock'>
1.869     kalberla 4032:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4033:   title='$text'>
                   4034:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4035:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4036:   title='$text'>$text</a>
1.867     kalberla 4037: </div>
                   4038: 
                   4039: END_BLOCK
1.474     raeburn  4040: 
1.854     kalberla 4041:   return ($blocked, $output);
                   4042: }
1.490     raeburn  4043: 
1.60      matthew  4044: ###############################################
                   4045: 
1.682     raeburn  4046: sub check_ip_acc {
                   4047:     my ($acc)=@_;
                   4048:     &Apache::lonxml::debug("acc is $acc");
                   4049:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4050:         return 1;
                   4051:     }
                   4052:     my $allowed=0;
                   4053:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4054: 
                   4055:     my $name;
                   4056:     foreach my $pattern (split(',',$acc)) {
                   4057:         $pattern =~ s/^\s*//;
                   4058:         $pattern =~ s/\s*$//;
                   4059:         if ($pattern =~ /\*$/) {
                   4060:             #35.8.*
                   4061:             $pattern=~s/\*//;
                   4062:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4063:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4064:             #35.8.3.[34-56]
                   4065:             my $low=$2;
                   4066:             my $high=$3;
                   4067:             $pattern=$1;
                   4068:             if ($ip =~ /^\Q$pattern\E/) {
                   4069:                 my $last=(split(/\./,$ip))[3];
                   4070:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4071:             }
                   4072:         } elsif ($pattern =~ /^\*/) {
                   4073:             #*.msu.edu
                   4074:             $pattern=~s/\*//;
                   4075:             if (!defined($name)) {
                   4076:                 use Socket;
                   4077:                 my $netaddr=inet_aton($ip);
                   4078:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4079:             }
                   4080:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4081:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4082:             #127.0.0.1
                   4083:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4084:         } else {
                   4085:             #some.name.com
                   4086:             if (!defined($name)) {
                   4087:                 use Socket;
                   4088:                 my $netaddr=inet_aton($ip);
                   4089:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4090:             }
                   4091:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4092:         }
                   4093:         if ($allowed) { last; }
                   4094:     }
                   4095:     return $allowed;
                   4096: }
                   4097: 
                   4098: ###############################################
                   4099: 
1.60      matthew  4100: =pod
                   4101: 
1.112     bowersj2 4102: =head1 Domain Template Functions
                   4103: 
                   4104: =over 4
                   4105: 
                   4106: =item * &determinedomain()
1.60      matthew  4107: 
                   4108: Inputs: $domain (usually will be undef)
                   4109: 
1.63      www      4110: Returns: Determines which domain should be used for designs
1.60      matthew  4111: 
                   4112: =cut
1.54      www      4113: 
1.60      matthew  4114: ###############################################
1.63      www      4115: sub determinedomain {
                   4116:     my $domain=shift;
1.531     albertel 4117:     if (! $domain) {
1.60      matthew  4118:         # Determine domain if we have not been given one
1.893     raeburn  4119:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4120:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4121:         if ($env{'request.role.domain'}) { 
                   4122:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4123:         }
                   4124:     }
1.63      www      4125:     return $domain;
                   4126: }
                   4127: ###############################################
1.517     raeburn  4128: 
1.518     albertel 4129: sub devalidate_domconfig_cache {
                   4130:     my ($udom)=@_;
                   4131:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4132: }
                   4133: 
                   4134: # ---------------------- Get domain configuration for a domain
                   4135: sub get_domainconf {
                   4136:     my ($udom) = @_;
                   4137:     my $cachetime=1800;
                   4138:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4139:     if (defined($cached)) { return %{$result}; }
                   4140: 
                   4141:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4142: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4143:     my (%designhash,%legacy);
1.518     albertel 4144:     if (keys(%domconfig) > 0) {
                   4145:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4146:             if (keys(%{$domconfig{'login'}})) {
                   4147:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4148:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4149:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4150:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4151:                                 $domconfig{'login'}{$key}{$img};
                   4152:                         }
                   4153:                     } else {
                   4154:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4155:                     }
1.632     raeburn  4156:                 }
                   4157:             } else {
                   4158:                 $legacy{'login'} = 1;
1.518     albertel 4159:             }
1.632     raeburn  4160:         } else {
                   4161:             $legacy{'login'} = 1;
1.518     albertel 4162:         }
                   4163:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4164:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4165:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4166:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4167:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4168:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4169:                         }
1.518     albertel 4170:                     }
                   4171:                 }
1.632     raeburn  4172:             } else {
                   4173:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4174:             }
1.632     raeburn  4175:         } else {
                   4176:             $legacy{'rolecolors'} = 1;
1.518     albertel 4177:         }
1.632     raeburn  4178:         if (keys(%legacy) > 0) {
                   4179:             my %legacyhash = &get_legacy_domconf($udom);
                   4180:             foreach my $item (keys(%legacyhash)) {
                   4181:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4182:                     if ($legacy{'login'}) { 
                   4183:                         $designhash{$item} = $legacyhash{$item};
                   4184:                     }
                   4185:                 } else {
                   4186:                     if ($legacy{'rolecolors'}) {
                   4187:                         $designhash{$item} = $legacyhash{$item};
                   4188:                     }
1.518     albertel 4189:                 }
                   4190:             }
                   4191:         }
1.632     raeburn  4192:     } else {
                   4193:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4194:     }
                   4195:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4196: 				  $cachetime);
                   4197:     return %designhash;
                   4198: }
                   4199: 
1.632     raeburn  4200: sub get_legacy_domconf {
                   4201:     my ($udom) = @_;
                   4202:     my %legacyhash;
                   4203:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4204:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4205:     if (-e $designfile) {
                   4206:         if ( open (my $fh,"<$designfile") ) {
                   4207:             while (my $line = <$fh>) {
                   4208:                 next if ($line =~ /^\#/);
                   4209:                 chomp($line);
                   4210:                 my ($key,$val)=(split(/\=/,$line));
                   4211:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4212:             }
                   4213:             close($fh);
                   4214:         }
                   4215:     }
                   4216:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4217:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4218:     }
                   4219:     return %legacyhash;
                   4220: }
                   4221: 
1.63      www      4222: =pod
                   4223: 
1.112     bowersj2 4224: =item * &domainlogo()
1.63      www      4225: 
                   4226: Inputs: $domain (usually will be undef)
                   4227: 
                   4228: Returns: A link to a domain logo, if the domain logo exists.
                   4229: If the domain logo does not exist, a description of the domain.
                   4230: 
                   4231: =cut
1.112     bowersj2 4232: 
1.63      www      4233: ###############################################
                   4234: sub domainlogo {
1.517     raeburn  4235:     my $domain = &determinedomain(shift);
1.518     albertel 4236:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4237:     # See if there is a logo
                   4238:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4239:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4240:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4241: 	    if ($imgsrc =~ m{^/res/}) {
                   4242: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4243: 		&Apache::lonnet::repcopy($local_name);
                   4244: 	    }
                   4245: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4246:         } 
                   4247:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4248:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4249:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4250:     } else {
1.60      matthew  4251:         return '';
1.59      www      4252:     }
                   4253: }
1.63      www      4254: ##############################################
                   4255: 
                   4256: =pod
                   4257: 
1.112     bowersj2 4258: =item * &designparm()
1.63      www      4259: 
                   4260: Inputs: $which parameter; $domain (usually will be undef)
                   4261: 
                   4262: Returns: value of designparamter $which
                   4263: 
                   4264: =cut
1.112     bowersj2 4265: 
1.397     albertel 4266: 
1.400     albertel 4267: ##############################################
1.397     albertel 4268: sub designparm {
                   4269:     my ($which,$domain)=@_;
                   4270:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4271:         return $env{'environment.color.'.$which};
1.96      www      4272:     }
1.63      www      4273:     $domain=&determinedomain($domain);
1.518     albertel 4274:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4275:     my $output;
1.517     raeburn  4276:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4277:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4278:     } else {
1.520     raeburn  4279:         $output = $defaultdesign{$which};
                   4280:     }
                   4281:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4282:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4283:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4284:             if ($output =~ m{^/res/}) {
                   4285:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4286:                 &Apache::lonnet::repcopy($local_name);
                   4287:             }
1.520     raeburn  4288:             $output = &lonhttpdurl($output);
                   4289:         }
1.63      www      4290:     }
1.520     raeburn  4291:     return $output;
1.63      www      4292: }
1.59      www      4293: 
1.822     bisitz   4294: ##############################################
                   4295: =pod
                   4296: 
1.832     bisitz   4297: =item * &authorspace()
                   4298: 
                   4299: Inputs: ./.
                   4300: 
                   4301: Returns: Path to the Construction Space of the current user's
                   4302:          accessed author space
                   4303:          The author space will be that of the current user
                   4304:          when accessing the own author space
                   4305:          and that of the co-author/assistent co-author
                   4306:          when accessing the co-author's/assistent co-author's
                   4307:          space
                   4308: 
                   4309: =cut
                   4310: 
                   4311: sub authorspace {
                   4312:     my $caname = '';
                   4313:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4314:         (undef,$caname) =
                   4315:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4316:     } else {
                   4317:         $caname = $env{'user.name'};
                   4318:     }
                   4319:     return '/priv/'.$caname.'/';
                   4320: }
                   4321: 
                   4322: ##############################################
                   4323: =pod
                   4324: 
1.822     bisitz   4325: =item * &head_subbox()
                   4326: 
                   4327: Inputs: $content (contains HTML code with page functions, etc.)
                   4328: 
                   4329: Returns: HTML div with $content
                   4330:          To be included in page header
                   4331: 
                   4332: =cut
                   4333: 
                   4334: sub head_subbox {
                   4335:     my ($content)=@_;
                   4336:     my $output =
1.844     bisitz   4337:         '<div id="LC_head_subbox">'
1.822     bisitz   4338:        .$content
                   4339:        .'</div>'
                   4340: }
                   4341: 
                   4342: ##############################################
                   4343: =pod
                   4344: 
                   4345: =item * &CSTR_pageheader()
                   4346: 
                   4347: Inputs: ./.
                   4348: 
                   4349: Returns: HTML div with CSTR path and recent box
                   4350:          To be included on Construction Space pages
                   4351: 
                   4352: =cut
                   4353: 
                   4354: sub CSTR_pageheader {
                   4355:     # this is for resources; directories have customtitle, and crumbs
                   4356:             # and select recent are created in lonpubdir.pm  
                   4357:     my ($uname,$thisdisfn)=
                   4358:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4359:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4360:     $formaction=~s/\/+/\//g;
                   4361: 
                   4362:     my $parentpath = '';
                   4363:     my $lastitem = '';
                   4364:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4365:         $parentpath = $1;
                   4366:         $lastitem = $2;
                   4367:     } else {
                   4368:         $lastitem = $thisdisfn;
                   4369:     }
                   4370:     return
                   4371:          '<div>'
                   4372:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4373:         .'<b>'.&mt('Construction Space:').'</b> '
                   4374:         .'<form name="dirs" method="post" action="'.$formaction
                   4375:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4376:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4377:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4378:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4379:         .'</form>'
                   4380:         .&Apache::lonmenu::constspaceform()
                   4381:         .'</div>';
                   4382: }
                   4383: 
1.60      matthew  4384: ###############################################
                   4385: ###############################################
                   4386: 
                   4387: =pod
                   4388: 
1.112     bowersj2 4389: =back
                   4390: 
1.549     albertel 4391: =head1 HTML Helpers
1.112     bowersj2 4392: 
                   4393: =over 4
                   4394: 
                   4395: =item * &bodytag()
1.60      matthew  4396: 
                   4397: Returns a uniform header for LON-CAPA web pages.
                   4398: 
                   4399: Inputs: 
                   4400: 
1.112     bowersj2 4401: =over 4
                   4402: 
                   4403: =item * $title, A title to be displayed on the page.
                   4404: 
                   4405: =item * $function, the current role (can be undef).
                   4406: 
                   4407: =item * $addentries, extra parameters for the <body> tag.
                   4408: 
                   4409: =item * $bodyonly, if defined, only return the <body> tag.
                   4410: 
                   4411: =item * $domain, if defined, force a given domain.
                   4412: 
                   4413: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4414:             text interface only)
1.60      matthew  4415: 
1.814     bisitz   4416: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4417:                      navigational links
1.317     albertel 4418: 
1.338     albertel 4419: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4420: 
1.361     albertel 4421: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4422:          'Switch To Inline Menu' link
                   4423: 
1.460     albertel 4424: =item * $args, optional argument valid values are
                   4425:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4426:             inherit_jsmath -> when creating popup window in a page,
                   4427:                               should it have jsmath forced on by the
                   4428:                               current page
1.460     albertel 4429: 
1.112     bowersj2 4430: =back
                   4431: 
1.60      matthew  4432: Returns: A uniform header for LON-CAPA web pages.  
                   4433: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4434: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4435: other decorations will be returned.
                   4436: 
                   4437: =cut
                   4438: 
1.54      www      4439: sub bodytag {
1.831     bisitz   4440:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4441:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4442: 
1.460     albertel 4443:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4444: 
1.183     matthew  4445:     $function = &get_users_function() if (!$function);
1.339     albertel 4446:     my $img =    &designparm($function.'.img',$domain);
                   4447:     my $font =   &designparm($function.'.font',$domain);
                   4448:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4449: 
1.803     bisitz   4450:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4451: 		   'bgcolor' => $pgbg,
1.339     albertel 4452: 		   'text'    => $font,
                   4453:                    'alink'   => &designparm($function.'.alink',$domain),
                   4454: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4455: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4456:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4457: 
1.63      www      4458:  # role and realm
1.378     raeburn  4459:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4460:     if ($role  eq 'ca') {
1.479     albertel 4461:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4462:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4463:     } 
1.55      www      4464: # realm
1.258     albertel 4465:     if ($env{'request.course.id'}) {
1.378     raeburn  4466:         if ($env{'request.role'} !~ /^cr/) {
                   4467:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4468:         }
1.898     raeburn  4469:         if ($env{'request.course.sec'}) {
                   4470:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4471:         }   
1.359     albertel 4472: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4473:     } else {
                   4474:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4475:     }
1.433     albertel 4476: 
1.359     albertel 4477:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4478: # Set messages
1.60      matthew  4479:     my $messages=&domainlogo($domain);
1.330     albertel 4480: 
1.438     albertel 4481:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4482: 
1.101     www      4483: # construct main body tag
1.359     albertel 4484:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4485: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4486: 
1.530     albertel 4487:     if ($bodyonly) {
1.60      matthew  4488:         return $bodytag;
1.798     tempelho 4489:     } 
1.359     albertel 4490: 
1.410     albertel 4491:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4492:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4493: 	undef($role);
1.434     albertel 4494:     } else {
                   4495: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4496:     }
1.359     albertel 4497:     
1.762     bisitz   4498:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4499:     #
                   4500:     # Extra info if you are the DC
                   4501:     my $dc_info = '';
                   4502:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4503:                         $env{'course.'.$env{'request.course.id'}.
                   4504:                                  '.domain'}.'/'})) {
                   4505:         my $cid = $env{'request.course.id'};
                   4506:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4507:         $dc_info =~ s/\s+$//;
1.359     albertel 4508:         $dc_info = '('.$dc_info.')';
                   4509:     }
                   4510: 
1.898     raeburn  4511:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4512:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4513: 
1.837     bisitz   4514:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4515:         # No Remote
1.903     droeschl 4516:         if ($no_nav_bar) { return $bodytag; } 
                   4517: 
                   4518:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4519: 
                   4520:         #    if ($env{'request.state'} eq 'construct') {
                   4521:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4522:         #    }
                   4523: 
                   4524:         $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4525:             <em>$realm</em> $dc_info</div>| unless $env{'form.inhibitmenu'};
1.359     albertel 4526: 
1.903     droeschl 4527:         if (   $env{'form.inhibitmenu'} eq 'yes' 
                   4528:             || $ENV{'REQUEST_URI'} eq '/adm/logout'
                   4529:             || $env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.359     albertel 4530: 
1.903     droeschl 4531:             return $bodytag;
                   4532:         }
1.894     droeschl 4533: 
1.903     droeschl 4534:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4535:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4536: 
1.903     droeschl 4537:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4538: 
1.903     droeschl 4539:         #don't show menus for public users
                   4540:         if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
                   4541:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4542:             $bodytag .= Apache::lonmenu::serverform();
                   4543:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
                   4544:             $bodytag .= Apache::lonmenu::innerregister($forcereg) if $forcereg;
                   4545:         }else{
                   4546:             # this is to seperate menu from content when there's no secondary
                   4547:             # menu. Especially needed for public accessible ressources.
                   4548:             $bodytag .= '<hr style="clear:both" />';
                   4549:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4550:         }
1.903     droeschl 4551: 
                   4552:         #SD testing
                   4553:         #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235     raeburn  4554:         return $bodytag;
1.94      www      4555:     }
1.95      www      4556: 
1.93      www      4557: #
1.95      www      4558: # Top frame rendering, Remote is up
1.93      www      4559: #
1.359     albertel 4560: 
1.517     raeburn  4561:     my $imgsrc = $img;
                   4562:     if ($img =~ /^\/adm/) {
1.575     albertel 4563:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4564:     }
                   4565:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4566: 
1.305     www      4567:     # Explicit link to get inline menu
1.361     albertel 4568:     my $menu= ($no_inline_link?''
1.883     droeschl 4569: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.853     droeschl 4570:     $bodytag .= qq|<div id="LC_nav_bar">$name $role
                   4571:             <em>$realm</em> $dc_info </div>
1.897     wenzelju 4572:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4573:                 <li>$menu</li>
                   4574:             </ol>| unless $env{'form.inhibitmenu'};
1.245     matthew  4575:     #
1.94      www      4576:     return(<<ENDBODY);
1.60      matthew  4577: $bodytag
1.359     albertel 4578: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4579: <tr><td>$upperleft</td>
                   4580:     <td>$messages&nbsp;</td>
1.54      www      4581: </tr>
1.359     albertel 4582: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4583: </tr>
1.356     albertel 4584: </table>
1.54      www      4585: ENDBODY
1.182     matthew  4586: }
                   4587: 
1.330     albertel 4588: sub make_attr_string {
                   4589:     my ($register,$attr_ref) = @_;
                   4590: 
                   4591:     if ($attr_ref && !ref($attr_ref)) {
                   4592: 	die("addentries Must be a hash ref ".
                   4593: 	    join(':',caller(1))." ".
                   4594: 	    join(':',caller(0))." ");
                   4595:     }
                   4596: 
                   4597:     if ($register) {
1.339     albertel 4598: 	my ($on_load,$on_unload);
                   4599: 	foreach my $key (keys(%{$attr_ref})) {
                   4600: 	    if      (lc($key) eq 'onload') {
                   4601: 		$on_load.=$attr_ref->{$key}.';';
                   4602: 		delete($attr_ref->{$key});
                   4603: 
                   4604: 	    } elsif (lc($key) eq 'onunload') {
                   4605: 		$on_unload.=$attr_ref->{$key}.';';
                   4606: 		delete($attr_ref->{$key});
                   4607: 	    }
                   4608: 	}
                   4609: 	$attr_ref->{'onload'}  =
                   4610: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4611: 	$attr_ref->{'onunload'}=
                   4612: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4613:     }
                   4614: 
                   4615: # Accessibility font enhance
                   4616:     if ($env{'browser.fontenhance'} eq 'on') {
                   4617: 	my $style;
                   4618: 	foreach my $key (keys(%{$attr_ref})) {
                   4619: 	    if (lc($key) eq 'style') {
                   4620: 		$style.=$attr_ref->{$key}.';';
                   4621: 		delete($attr_ref->{$key});
                   4622: 	    }
                   4623: 	}
                   4624: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4625:     }
1.339     albertel 4626: 
1.330     albertel 4627:     my $attr_string;
                   4628:     foreach my $attr (keys(%$attr_ref)) {
                   4629: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4630:     }
                   4631:     return $attr_string;
                   4632: }
                   4633: 
                   4634: 
1.182     matthew  4635: ###############################################
1.251     albertel 4636: ###############################################
                   4637: 
                   4638: =pod
                   4639: 
                   4640: =item * &endbodytag()
                   4641: 
                   4642: Returns a uniform footer for LON-CAPA web pages.
                   4643: 
1.635     raeburn  4644: Inputs: 1 - optional reference to an args hash
                   4645: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4646: a 'Continue' link is not displayed if the page contains an
                   4647: internal redirect in the <head></head> section,
                   4648: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4649: 
                   4650: =cut
                   4651: 
                   4652: sub endbodytag {
1.635     raeburn  4653:     my ($args) = @_;
1.251     albertel 4654:     my $endbodytag='</body>';
1.269     albertel 4655:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4656:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4657:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4658: 	    $endbodytag=
                   4659: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4660: 	        &mt('Continue').'</a>'.
                   4661: 	        $endbodytag;
                   4662:         }
1.315     albertel 4663:     }
1.251     albertel 4664:     return $endbodytag;
                   4665: }
                   4666: 
1.352     albertel 4667: =pod
                   4668: 
                   4669: =item * &standard_css()
                   4670: 
                   4671: Returns a style sheet
                   4672: 
                   4673: Inputs: (all optional)
                   4674:             domain         -> force to color decorate a page for a specific
                   4675:                                domain
                   4676:             function       -> force usage of a specific rolish color scheme
                   4677:             bgcolor        -> override the default page bgcolor
                   4678: 
                   4679: =cut
                   4680: 
1.343     albertel 4681: sub standard_css {
1.345     albertel 4682:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4683:     $function  = &get_users_function() if (!$function);
                   4684:     my $img    = &designparm($function.'.img',   $domain);
                   4685:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4686:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4687:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4688: #second colour for later usage
1.345     albertel 4689:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4690:     my $pgbg_or_bgcolor =
                   4691: 	         $bgcolor ||
1.352     albertel 4692: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4693:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4694:     my $alink  = &designparm($function.'.alink', $domain);
                   4695:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4696:     my $link   = &designparm($function.'.link',  $domain);
                   4697: 
1.704     muellerd 4698:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4699:     my $bgcol = &designparm('login.bgcol',$domain);
                   4700:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4701: 
1.602     albertel 4702:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4703:     my $mono                 = 'monospace';
1.850     bisitz   4704:     my $data_table_head      = $sidebg;
                   4705:     my $data_table_light     = '#FAFAFA';
                   4706:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4707:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4708:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4709:     my $mail_new             = '#FFBB77';
                   4710:     my $mail_new_hover       = '#DD9955';
                   4711:     my $mail_read            = '#BBBB77';
                   4712:     my $mail_read_hover      = '#999944';
                   4713:     my $mail_replied         = '#AAAA88';
                   4714:     my $mail_replied_hover   = '#888855';
                   4715:     my $mail_other           = '#99BBBB';
                   4716:     my $mail_other_hover     = '#669999';
1.391     albertel 4717:     my $table_header         = '#DDDDDD';
1.489     raeburn  4718:     my $feedback_link_bg     = '#BBBBBB';
1.701     harmsja  4719:     my $lg_border_color	     = '#C8C8C8';
1.392     albertel 4720: 
1.608     albertel 4721:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.803     bisitz   4722: 		  $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4723: 	                                                 : '0 3px 0 4px';
1.448     albertel 4724: 
1.523     albertel 4725: 
1.343     albertel 4726:     return <<END;
1.795     www      4727: body {
                   4728:    font-family: $sans;
                   4729:    line-height:130%;
                   4730:    font-size:0.83em;
                   4731:    color:$font;
                   4732: }
                   4733: 
                   4734: a:link, a:visited { 
                   4735:   font-size:100%; 
                   4736: }
                   4737: 
                   4738: a:focus { 
                   4739:   color: red;
                   4740:   background: yellow 
                   4741: }
1.698     harmsja  4742: 
1.795     www      4743: form, .inline { 
                   4744:    display: inline; 
                   4745: }
1.721     harmsja  4746: 
1.795     www      4747: .LC_right {
                   4748:    text-align:right;
                   4749: }
                   4750: 
                   4751: .LC_middle {
                   4752:    vertical-align:middle;
                   4753: }
1.721     harmsja  4754: 
                   4755: /* just for tests */
1.754     droeschl 4756: .LC_400Box {width:400px; }
1.721     harmsja  4757: /* end */
                   4758: 
1.778     bisitz   4759: .LC_filename {
                   4760:   font-family: $mono;
                   4761:   white-space:pre;
                   4762: }
                   4763: 
                   4764: .LC_fileicon {
                   4765:   border: none;
                   4766:   height: 1.3em;
                   4767:   vertical-align: text-bottom;
                   4768:   margin-right: 0.3em;
                   4769:   text-decoration:none;
                   4770: }
                   4771: 
1.350     albertel 4772: .LC_error {
                   4773:   color: red;
                   4774:   font-size: larger;
                   4775: }
1.795     www      4776: 
1.457     albertel 4777: .LC_warning,
                   4778: .LC_diff_removed {
1.733     bisitz   4779:   color: red;
1.394     albertel 4780: }
1.532     albertel 4781: 
                   4782: .LC_info,
1.457     albertel 4783: .LC_success,
                   4784: .LC_diff_added {
1.350     albertel 4785:   color: green;
                   4786: }
1.795     www      4787: 
1.802     bisitz   4788: div.LC_confirm_box {
                   4789:   background-color: #FAFAFA;
                   4790:   border: 1px solid $lg_border_color;
                   4791:   margin-right: 0;
                   4792:   padding: 5px;
                   4793: }
                   4794: 
                   4795: div.LC_confirm_box .LC_error img,
                   4796: div.LC_confirm_box .LC_success img {
                   4797:   vertical-align: middle;
                   4798: }
                   4799: 
1.440     albertel 4800: .LC_icon {
1.771     droeschl 4801:   border: none;
1.790     droeschl 4802:   vertical-align: middle;
1.771     droeschl 4803: }
                   4804: 
1.543     albertel 4805: .LC_docs_spacer {
                   4806:   width: 25px;
                   4807:   height: 1px;
1.771     droeschl 4808:   border: none;
1.543     albertel 4809: }
1.346     albertel 4810: 
1.532     albertel 4811: .LC_internal_info {
1.735     bisitz   4812:   color: #999999;
1.532     albertel 4813: }
                   4814: 
1.794     www      4815: .LC_discussion {
                   4816:    background: $tabbg;
                   4817:    border: 1px solid black;
                   4818:    margin: 2px;
                   4819: }
                   4820: 
                   4821: .LC_disc_action_links_bar {
                   4822:    background: $tabbg;
1.803     bisitz   4823:    border: none;
1.795     www      4824:    margin: 4px;
1.794     www      4825: }
                   4826: 
                   4827: .LC_disc_action_left {
                   4828:    text-align: left;
                   4829: }
                   4830: 
                   4831: .LC_disc_action_right {
                   4832:    text-align: right;
                   4833: }
                   4834: 
                   4835: .LC_disc_new_item {
                   4836:    background: white;
                   4837:    border: 2px solid red;
                   4838:    margin: 2px;
                   4839: }
                   4840: 
                   4841: .LC_disc_old_item {
                   4842:    background: white;
                   4843:    border: 1px solid black;
                   4844:    margin: 2px;
                   4845: }
                   4846: 
1.458     albertel 4847: table.LC_pastsubmission {
                   4848:   border: 1px solid black;
                   4849:   margin: 2px;
                   4850: }
                   4851: 
1.795     www      4852: table#LC_top_nav,
                   4853: table#LC_menubuttons,
                   4854: table#LC_nav_location {
1.345     albertel 4855:   width: 100%;
                   4856:   background: $pgbg;
1.392     albertel 4857:   border: 2px;
1.402     albertel 4858:   border-collapse: separate;
1.803     bisitz   4859:   padding: 0;
1.345     albertel 4860: }
1.392     albertel 4861: 
1.801     tempelho 4862: table#LC_title_bar a {
                   4863:   color: $fontmenu;
                   4864: }
1.836     bisitz   4865: 
1.807     droeschl 4866: table#LC_title_bar {
1.819     tempelho 4867:   clear: both;
1.836     bisitz   4868:   display: none;
1.807     droeschl 4869: }
                   4870: 
1.795     www      4871: table#LC_title_bar,
                   4872: table.LC_breadcrumbs,
1.393     albertel 4873: table#LC_title_bar.LC_with_remote {
1.359     albertel 4874:   width: 100%;
1.392     albertel 4875:   border-color: $pgbg;
                   4876:   border-style: solid;
                   4877:   border-width: $border;
1.379     albertel 4878:   background: $pgbg;
1.801     tempelho 4879:   color: $fontmenu;
1.392     albertel 4880:   border-collapse: collapse;
1.803     bisitz   4881:   padding: 0;
1.819     tempelho 4882:   margin: 0;
1.359     albertel 4883: }
1.795     www      4884: 
1.359     albertel 4885: table#LC_title_bar td {
                   4886:   background: $tabbg;
                   4887: }
1.795     www      4888: 
1.706     harmsja  4889: table#LC_menubuttons img{
1.803     bisitz   4890:   border: none;
1.346     albertel 4891: }
1.795     www      4892: 
1.345     albertel 4893: table#LC_top_nav td {
                   4894:   background: $tabbg;
1.803     bisitz   4895:   border: none;
1.407     albertel 4896:   font-size: small;
1.706     harmsja  4897:   vertical-align:top;
                   4898:   padding:2px 5px 2px 5px;
1.345     albertel 4899: }
1.795     www      4900: 
                   4901: table#LC_top_nav td a,
                   4902: div#LC_top_nav a {
1.345     albertel 4903:   color: $font;
                   4904: }
1.795     www      4905: 
1.364     albertel 4906: table#LC_top_nav td.LC_top_nav_logo {
                   4907:   background: $tabbg;
1.432     albertel 4908:   text-align: left;
1.408     albertel 4909:   white-space: nowrap;
1.432     albertel 4910:   width: 31px;
1.408     albertel 4911: }
1.795     www      4912: 
1.408     albertel 4913: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4914:   border: none;
1.408     albertel 4915:   vertical-align: bottom;
1.364     albertel 4916: }
1.795     www      4917: 
1.777     tempelho 4918: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4919: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4920:   width: 2.0em;
                   4921: }
1.795     www      4922: 
1.442     albertel 4923: table#LC_top_nav td.LC_top_nav_login {
                   4924:   width: 4.0em;
                   4925:   text-align: center;
                   4926: }
1.795     www      4927: 
1.842     droeschl 4928: .LC_breadcrumbs_component {
                   4929:     float: right;
                   4930:     margin: 0 1em;
1.357     albertel 4931: }
1.842     droeschl 4932: .LC_breadcrumbs_component img {
                   4933:     vertical-align: middle;
1.777     tempelho 4934: }
1.795     www      4935: 
1.383     albertel 4936: td.LC_table_cell_checkbox {
                   4937:   text-align: center;
                   4938: }
1.795     www      4939: 
1.779     bisitz   4940: table#LC_mainmenu td.LC_mainmenu_column {
                   4941:     vertical-align: top;
1.777     tempelho 4942: }
1.522     albertel 4943: 
1.795     www      4944: .LC_fontsize_small {
1.705     tempelho 4945:  font-size: 70%;
                   4946: }
                   4947: 
1.844     bisitz   4948: #LC_breadcrumbs {
1.819     tempelho 4949:  clear:both;
                   4950:  background: $sidebg;
1.822     bisitz   4951:  border-bottom: 1px solid $lg_border_color;
1.904     droeschl 4952:  line-height: 2.5em; 
                   4953:  /* SD working here
                   4954:  height: 2.5em;
                   4955:  overflow: hidden; */
1.822     bisitz   4956:  margin: 0;
1.819     tempelho 4957:  padding: 0;
                   4958: }
1.862     bisitz   4959: 
1.839     droeschl 4960: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   4961: #LC_remote #LC_breadcrumbs {
1.839     droeschl 4962:     display:none;
                   4963: }
1.819     tempelho 4964: 
1.844     bisitz   4965: #LC_head_subbox {
1.822     bisitz   4966:  clear:both;
                   4967:  background: #F8F8F8; /* $sidebg; */
                   4968:  border-bottom: 1px solid $lg_border_color;
                   4969:  margin: 0 0 10px 0;
                   4970:  padding: 5px;
                   4971: }
                   4972: 
1.795     www      4973: .LC_fontsize_medium {
1.705     tempelho 4974:  font-size: 85%;
                   4975: }
                   4976: 
1.795     www      4977: .LC_fontsize_large {
1.705     tempelho 4978:  font-size: 120%;
                   4979: }
                   4980: 
1.346     albertel 4981: .LC_menubuttons_inline_text {
                   4982:   color: $font;
1.698     harmsja  4983:   font-size: 90%;
1.701     harmsja  4984:   padding-left:3px;
1.346     albertel 4985: }
                   4986: 
1.526     www      4987: .LC_menubuttons_link {
                   4988:   text-decoration: none;
                   4989: }
1.795     www      4990: 
1.522     albertel 4991: .LC_menubuttons_category {
1.521     www      4992:   color: $font;
1.526     www      4993:   background: $pgbg;
1.521     www      4994:   font-size: larger;
                   4995:   font-weight: bold;
                   4996: }
                   4997: 
1.346     albertel 4998: td.LC_menubuttons_text {
1.779     bisitz   4999:  	color: $font;
1.346     albertel 5000: }
1.706     harmsja  5001: 
1.346     albertel 5002: .LC_current_location {
                   5003:   background: $tabbg;
                   5004: }
1.795     www      5005: 
1.346     albertel 5006: .LC_new_mail {
1.634     www      5007:   background: $tabbg;
1.346     albertel 5008:   font-weight: bold;
                   5009: }
1.347     albertel 5010: 
1.795     www      5011: table.LC_data_table,
                   5012: table.LC_mail_list {
1.347     albertel 5013:   border: 1px solid #000000;
1.402     albertel 5014:   border-collapse: separate;
1.426     albertel 5015:   border-spacing: 1px;
1.610     albertel 5016:   background: $pgbg;
1.347     albertel 5017: }
1.795     www      5018: 
1.422     albertel 5019: .LC_data_table_dense {
                   5020:   font-size: small;
                   5021: }
1.795     www      5022: 
1.507     raeburn  5023: table.LC_nested_outer {
                   5024:   border: 1px solid #000000;
1.589     raeburn  5025:   border-collapse: collapse;
1.803     bisitz   5026:   border-spacing: 0;
1.507     raeburn  5027:   width: 100%;
                   5028: }
1.795     www      5029: 
1.879     raeburn  5030: table.LC_innerpickbox,
1.507     raeburn  5031: table.LC_nested {
1.803     bisitz   5032:   border: none;
1.589     raeburn  5033:   border-collapse: collapse;
1.803     bisitz   5034:   border-spacing: 0;
1.507     raeburn  5035:   width: 100%;
                   5036: }
1.795     www      5037: 
                   5038: table.LC_data_table tr th, 
                   5039: table.LC_calendar tr th, 
                   5040: table.LC_mail_list tr th,
1.879     raeburn  5041: table.LC_prior_tries tr th,
                   5042: table.LC_innerpickbox tr th {
1.349     albertel 5043:   font-weight: bold;
                   5044:   background-color: $data_table_head;
1.801     tempelho 5045:   color:$fontmenu;
1.701     harmsja  5046:   font-size:90%;
1.347     albertel 5047: }
1.795     www      5048: 
1.879     raeburn  5049: table.LC_innerpickbox tr th,
                   5050: table.LC_innerpickbox tr td {
                   5051:   vertical-align: top;
                   5052: }
                   5053: 
1.711     raeburn  5054: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5055:   background-color: #CCCCCC;
1.711     raeburn  5056:   font-weight: bold;
                   5057:   text-align: left;
                   5058: }
1.795     www      5059: 
1.779     bisitz   5060: table.LC_data_table tr.LC_odd_row > td,
1.809     bisitz   5061: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5062:   background-color: $data_table_light;
1.425     albertel 5063:   padding: 2px;
1.900     bisitz   5064:   vertical-align: top;
1.347     albertel 5065: }
1.795     www      5066: 
1.610     albertel 5067: table.LC_data_table tr.LC_even_row > td,
1.809     bisitz   5068: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5069:   background-color: $data_table_dark;
1.709     bisitz   5070:   padding: 2px;
1.900     bisitz   5071:   vertical-align: top;
1.347     albertel 5072: }
1.795     www      5073: 
1.425     albertel 5074: table.LC_data_table tr.LC_data_table_highlight td {
                   5075:   background-color: $data_table_darker;
                   5076: }
1.795     www      5077: 
1.639     raeburn  5078: table.LC_data_table tr td.LC_leftcol_header {
                   5079:   background-color: $data_table_head;
                   5080:   font-weight: bold;
                   5081: }
1.795     www      5082: 
1.451     albertel 5083: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5084: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5085:   background-color: #FFFFFF;
1.421     albertel 5086:   font-weight: bold;
                   5087:   font-style: italic;
                   5088:   text-align: center;
                   5089:   padding: 8px;
1.347     albertel 5090: }
1.795     www      5091: 
1.890     droeschl 5092: table.LC_caption {
                   5093: }
                   5094: 
1.507     raeburn  5095: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5096:   padding: 4ex
                   5097: }
1.795     www      5098: 
1.507     raeburn  5099: table.LC_nested_outer tr th {
                   5100:   font-weight: bold;
1.801     tempelho 5101:   color:$fontmenu;
1.507     raeburn  5102:   background-color: $data_table_head;
1.701     harmsja  5103:   font-size: small;
1.507     raeburn  5104:   border-bottom: 1px solid #000000;
                   5105: }
1.795     www      5106: 
1.507     raeburn  5107: table.LC_nested_outer tr td.LC_subheader {
                   5108:   background-color: $data_table_head;
                   5109:   font-weight: bold;
                   5110:   font-size: small;
                   5111:   border-bottom: 1px solid #000000;
                   5112:   text-align: right;
1.451     albertel 5113: }
1.795     www      5114: 
1.507     raeburn  5115: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5116:   background-color: #CCCCCC;
1.451     albertel 5117:   font-weight: bold;
                   5118:   font-size: small;
1.507     raeburn  5119:   text-align: center;
                   5120: }
1.795     www      5121: 
1.589     raeburn  5122: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5123: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5124:   text-align: left;
1.451     albertel 5125: }
1.795     www      5126: 
1.507     raeburn  5127: table.LC_nested td {
1.735     bisitz   5128:   background-color: #FFFFFF;
1.451     albertel 5129:   font-size: small;
1.507     raeburn  5130: }
1.795     www      5131: 
1.507     raeburn  5132: table.LC_nested_outer tr th.LC_right_item,
                   5133: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5134: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5135: table.LC_nested tr td.LC_right_item {
1.451     albertel 5136:   text-align: right;
                   5137: }
                   5138: 
1.507     raeburn  5139: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5140:   background-color: #EEEEEE;
1.451     albertel 5141: }
                   5142: 
1.473     raeburn  5143: table.LC_createuser {
                   5144: }
                   5145: 
                   5146: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5147:   font-size: small;
1.473     raeburn  5148: }
                   5149: 
                   5150: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5151:   background-color: #CCCCCC;
1.473     raeburn  5152:   font-weight: bold;
                   5153:   text-align: center;
                   5154: }
                   5155: 
1.349     albertel 5156: table.LC_calendar {
                   5157:   border: 1px solid #000000;
                   5158:   border-collapse: collapse;
                   5159: }
1.795     www      5160: 
1.349     albertel 5161: table.LC_calendar_pickdate {
                   5162:   font-size: xx-small;
                   5163: }
1.795     www      5164: 
1.349     albertel 5165: table.LC_calendar tr td {
                   5166:   border: 1px solid #000000;
                   5167:   vertical-align: top;
                   5168: }
1.795     www      5169: 
1.349     albertel 5170: table.LC_calendar tr td.LC_calendar_day_empty {
                   5171:   background-color: $data_table_dark;
                   5172: }
1.795     www      5173: 
1.779     bisitz   5174: table.LC_calendar tr td.LC_calendar_day_current {
                   5175:   background-color: $data_table_highlight;
1.777     tempelho 5176: }
1.795     www      5177: 
1.349     albertel 5178: table.LC_mail_list tr.LC_mail_new {
                   5179:   background-color: $mail_new;
                   5180: }
1.795     www      5181: 
1.349     albertel 5182: table.LC_mail_list tr.LC_mail_new:hover {
                   5183:   background-color: $mail_new_hover;
                   5184: }
1.795     www      5185: 
                   5186: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5187: }
1.795     www      5188: 
                   5189: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5190: }
1.795     www      5191: 
1.349     albertel 5192: table.LC_mail_list tr.LC_mail_read {
                   5193:   background-color: $mail_read;
                   5194: }
1.795     www      5195: 
1.349     albertel 5196: table.LC_mail_list tr.LC_mail_read:hover {
                   5197:   background-color: $mail_read_hover;
                   5198: }
1.795     www      5199: 
1.349     albertel 5200: table.LC_mail_list tr.LC_mail_replied {
                   5201:   background-color: $mail_replied;
                   5202: }
1.795     www      5203: 
1.349     albertel 5204: table.LC_mail_list tr.LC_mail_replied:hover {
                   5205:   background-color: $mail_replied_hover;
                   5206: }
1.795     www      5207: 
1.349     albertel 5208: table.LC_mail_list tr.LC_mail_other {
                   5209:   background-color: $mail_other;
                   5210: }
1.795     www      5211: 
1.349     albertel 5212: table.LC_mail_list tr.LC_mail_other:hover {
                   5213:   background-color: $mail_other_hover;
                   5214: }
1.494     raeburn  5215: 
1.777     tempelho 5216: table.LC_data_table tr > td.LC_browser_file,
                   5217: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5218:   background: #AAEE77;
1.389     albertel 5219: }
1.795     www      5220: 
1.777     tempelho 5221: table.LC_data_table tr > td.LC_browser_file_locked,
                   5222: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5223:   background: #FFAA99;
1.387     albertel 5224: }
1.795     www      5225: 
1.777     tempelho 5226: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5227:   background: #888888;
1.779     bisitz   5228: }
1.795     www      5229: 
1.777     tempelho 5230: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5231: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5232:   background: #F8F866;
1.777     tempelho 5233: }
1.795     www      5234: 
1.696     bisitz   5235: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5236:   background: #E0E8FF;
1.387     albertel 5237: }
1.696     bisitz   5238: 
1.707     bisitz   5239: table.LC_data_table tr > td.LC_roles_is {
                   5240: /*  background: #77FF77; */
                   5241: }
1.795     www      5242: 
1.707     bisitz   5243: table.LC_data_table tr > td.LC_roles_future {
                   5244:   background: #FFFF77;
                   5245: }
1.795     www      5246: 
1.707     bisitz   5247: table.LC_data_table tr > td.LC_roles_will {
                   5248:   background: #FFAA77;
                   5249: }
1.795     www      5250: 
1.707     bisitz   5251: table.LC_data_table tr > td.LC_roles_expired {
                   5252:   background: #FF7777;
                   5253: }
1.795     www      5254: 
1.707     bisitz   5255: table.LC_data_table tr > td.LC_roles_will_not {
                   5256:   background: #AAFF77;
                   5257: }
1.795     www      5258: 
1.707     bisitz   5259: table.LC_data_table tr > td.LC_roles_selected {
                   5260:   background: #11CC55;
                   5261: }
                   5262: 
1.388     albertel 5263: span.LC_current_location {
1.701     harmsja  5264:   font-size:larger;
1.388     albertel 5265:   background: $pgbg;
                   5266: }
1.387     albertel 5267: 
1.395     albertel 5268: span.LC_parm_menu_item {
                   5269:   font-size: larger;
                   5270: }
1.795     www      5271: 
1.395     albertel 5272: span.LC_parm_scope_all {
                   5273:   color: red;
                   5274: }
1.795     www      5275: 
1.395     albertel 5276: span.LC_parm_scope_folder {
                   5277:   color: green;
                   5278: }
1.795     www      5279: 
1.395     albertel 5280: span.LC_parm_scope_resource {
                   5281:   color: orange;
                   5282: }
1.795     www      5283: 
1.395     albertel 5284: span.LC_parm_part {
                   5285:   color: blue;
                   5286: }
1.795     www      5287: 
1.395     albertel 5288: span.LC_parm_folder, span.LC_parm_symb {
                   5289:   font-size: x-small;
                   5290:   font-family: $mono;
                   5291:   color: #AAAAAA;
                   5292: }
                   5293: 
1.795     www      5294: td.LC_parm_overview_level_menu,
                   5295: td.LC_parm_overview_map_menu,
                   5296: td.LC_parm_overview_parm_selectors,
                   5297: td.LC_parm_overview_restrictions  {
1.396     albertel 5298:   border: 1px solid black;
                   5299:   border-collapse: collapse;
                   5300: }
1.795     www      5301: 
1.396     albertel 5302: table.LC_parm_overview_restrictions td {
                   5303:   border-width: 1px 4px 1px 4px;
                   5304:   border-style: solid;
                   5305:   border-color: $pgbg;
                   5306:   text-align: center;
                   5307: }
1.795     www      5308: 
1.396     albertel 5309: table.LC_parm_overview_restrictions th {
                   5310:   background: $tabbg;
                   5311:   border-width: 1px 4px 1px 4px;
                   5312:   border-style: solid;
                   5313:   border-color: $pgbg;
                   5314: }
1.795     www      5315: 
1.398     albertel 5316: table#LC_helpmenu {
1.803     bisitz   5317:   border: none;
1.398     albertel 5318:   height: 55px;
1.803     bisitz   5319:   border-spacing: 0;
1.398     albertel 5320: }
                   5321: 
                   5322: table#LC_helpmenu fieldset legend {
                   5323:   font-size: larger;
                   5324: }
1.795     www      5325: 
1.397     albertel 5326: table#LC_helpmenu_links {
                   5327:   width: 100%;
                   5328:   border: 1px solid black;
                   5329:   background: $pgbg;
1.803     bisitz   5330:   padding: 0;
1.397     albertel 5331:   border-spacing: 1px;
                   5332: }
1.795     www      5333: 
1.397     albertel 5334: table#LC_helpmenu_links tr td {
                   5335:   padding: 1px;
                   5336:   background: $tabbg;
1.399     albertel 5337:   text-align: center;
                   5338:   font-weight: bold;
1.397     albertel 5339: }
1.396     albertel 5340: 
1.795     www      5341: table#LC_helpmenu_links a:link,
                   5342: table#LC_helpmenu_links a:visited,
1.397     albertel 5343: table#LC_helpmenu_links a:active {
                   5344:   text-decoration: none;
                   5345:   color: $font;
                   5346: }
1.795     www      5347: 
1.397     albertel 5348: table#LC_helpmenu_links a:hover {
                   5349:   text-decoration: underline;
                   5350:   color: $vlink;
                   5351: }
1.396     albertel 5352: 
1.417     albertel 5353: .LC_chrt_popup_exists {
                   5354:   border: 1px solid #339933;
                   5355:   margin: -1px;
                   5356: }
1.795     www      5357: 
1.417     albertel 5358: .LC_chrt_popup_up {
                   5359:   border: 1px solid yellow;
                   5360:   margin: -1px;
                   5361: }
1.795     www      5362: 
1.417     albertel 5363: .LC_chrt_popup {
                   5364:   border: 1px solid #8888FF;
                   5365:   background: #CCCCFF;
                   5366: }
1.795     www      5367: 
1.421     albertel 5368: table.LC_pick_box {
                   5369:   border-collapse: separate;
                   5370:   background: white;
                   5371:   border: 1px solid black;
                   5372:   border-spacing: 1px;
                   5373: }
1.795     www      5374: 
1.421     albertel 5375: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5376:   background: $sidebg;
1.421     albertel 5377:   font-weight: bold;
1.900     bisitz   5378:   text-align: left;
1.740     bisitz   5379:   vertical-align: top;
1.421     albertel 5380:   width: 184px;
                   5381:   padding: 8px;
                   5382: }
1.795     www      5383: 
1.579     raeburn  5384: table.LC_pick_box td.LC_pick_box_value {
                   5385:   text-align: left;
                   5386:   padding: 8px;
                   5387: }
1.795     www      5388: 
1.579     raeburn  5389: table.LC_pick_box td.LC_pick_box_select {
                   5390:   text-align: left;
                   5391:   padding: 8px;
                   5392: }
1.795     www      5393: 
1.424     albertel 5394: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5395:   padding: 0;
1.421     albertel 5396:   height: 1px;
                   5397:   background: black;
                   5398: }
1.795     www      5399: 
1.421     albertel 5400: table.LC_pick_box td.LC_pick_box_submit {
                   5401:   text-align: right;
                   5402: }
1.795     www      5403: 
1.579     raeburn  5404: table.LC_pick_box td.LC_evenrow_value {
                   5405:   text-align: left;
                   5406:   padding: 8px;
                   5407:   background-color: $data_table_light;
                   5408: }
1.795     www      5409: 
1.579     raeburn  5410: table.LC_pick_box td.LC_oddrow_value {
                   5411:   text-align: left;
                   5412:   padding: 8px;
                   5413:   background-color: $data_table_light;
                   5414: }
1.795     www      5415: 
1.579     raeburn  5416: span.LC_helpform_receipt_cat {
                   5417:   font-weight: bold;
                   5418: }
1.795     www      5419: 
1.424     albertel 5420: table.LC_group_priv_box {
                   5421:   background: white;
                   5422:   border: 1px solid black;
                   5423:   border-spacing: 1px;
                   5424: }
1.795     www      5425: 
1.424     albertel 5426: table.LC_group_priv_box td.LC_pick_box_title {
                   5427:   background: $tabbg;
                   5428:   font-weight: bold;
                   5429:   text-align: right;
                   5430:   width: 184px;
                   5431: }
1.795     www      5432: 
1.424     albertel 5433: table.LC_group_priv_box td.LC_groups_fixed {
                   5434:   background: $data_table_light;
                   5435:   text-align: center;
                   5436: }
1.795     www      5437: 
1.424     albertel 5438: table.LC_group_priv_box td.LC_groups_optional {
                   5439:   background: $data_table_dark;
                   5440:   text-align: center;
                   5441: }
1.795     www      5442: 
1.424     albertel 5443: table.LC_group_priv_box td.LC_groups_functionality {
                   5444:   background: $data_table_darker;
                   5445:   text-align: center;
                   5446:   font-weight: bold;
                   5447: }
1.795     www      5448: 
1.424     albertel 5449: table.LC_group_priv td {
                   5450:   text-align: left;
1.803     bisitz   5451:   padding: 0;
1.424     albertel 5452: }
                   5453: 
1.421     albertel 5454: table.LC_notify_front_page {
                   5455:   background: white;
                   5456:   border: 1px solid black;
                   5457:   padding: 8px;
                   5458: }
1.795     www      5459: 
1.421     albertel 5460: table.LC_notify_front_page td {
                   5461:   padding: 8px;
                   5462: }
1.795     www      5463: 
1.424     albertel 5464: .LC_navbuttons {
                   5465:   margin: 2ex 0ex 2ex 0ex;
                   5466: }
1.795     www      5467: 
1.423     albertel 5468: .LC_topic_bar {
                   5469:   font-weight: bold;
                   5470:   width: 100%;
                   5471:   background: $tabbg;
                   5472:   vertical-align: middle;
                   5473:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5474:   padding: 3px;
1.423     albertel 5475: }
1.795     www      5476: 
1.423     albertel 5477: .LC_topic_bar span {
                   5478:   vertical-align: middle;
                   5479: }
1.795     www      5480: 
1.423     albertel 5481: .LC_topic_bar img {
                   5482:   vertical-align: bottom;
                   5483: }
1.795     www      5484: 
1.423     albertel 5485: table.LC_course_group_status {
                   5486:   margin: 20px;
                   5487: }
1.795     www      5488: 
1.423     albertel 5489: table.LC_status_selector td {
                   5490:   vertical-align: top;
                   5491:   text-align: center;
1.424     albertel 5492:   padding: 4px;
                   5493: }
1.795     www      5494: 
1.599     albertel 5495: div.LC_feedback_link {
1.616     albertel 5496:   clear: both;
1.829     kalberla 5497:   background: $sidebg;
1.779     bisitz   5498:   width: 100%;
1.829     kalberla 5499:   padding-bottom: 10px;
                   5500:   border: 1px $tabbg solid;
1.833     kalberla 5501:   height: 22px;
                   5502:   line-height: 22px;
                   5503:   padding-top: 5px;
                   5504: }
                   5505: 
                   5506: div.LC_feedback_link img {
                   5507:   height: 22px;
1.867     kalberla 5508:   vertical-align:middle;
1.829     kalberla 5509: }
                   5510: 
                   5511: div.LC_feedback_link a{
                   5512:   text-decoration: none;
1.489     raeburn  5513: }
1.795     www      5514: 
1.867     kalberla 5515: div.LC_comblock {
                   5516:   display:inline; 
                   5517:   color:$font;
                   5518:   font-size:90%;
                   5519: }
                   5520: 
                   5521: div.LC_feedback_link div.LC_comblock {
                   5522:   padding-left:5px;
                   5523: }
                   5524: 
                   5525: div.LC_feedback_link div.LC_comblock a {
                   5526:   color:$font;
                   5527: }
                   5528: 
1.489     raeburn  5529: span.LC_feedback_link {
1.858     bisitz   5530:   /* background: $feedback_link_bg; */
1.599     albertel 5531:   font-size: larger;
                   5532: }
1.795     www      5533: 
1.599     albertel 5534: span.LC_message_link {
1.858     bisitz   5535:   /* background: $feedback_link_bg; */
1.599     albertel 5536:   font-size: larger;
                   5537:   position: absolute;
                   5538:   right: 1em;
1.489     raeburn  5539: }
1.421     albertel 5540: 
1.515     albertel 5541: table.LC_prior_tries {
1.524     albertel 5542:   border: 1px solid #000000;
                   5543:   border-collapse: separate;
                   5544:   border-spacing: 1px;
1.515     albertel 5545: }
1.523     albertel 5546: 
1.515     albertel 5547: table.LC_prior_tries td {
1.524     albertel 5548:   padding: 2px;
1.515     albertel 5549: }
1.523     albertel 5550: 
                   5551: .LC_answer_correct {
1.795     www      5552:   background: lightgreen;
                   5553:   color: darkgreen;
                   5554:   padding: 6px;
1.523     albertel 5555: }
1.795     www      5556: 
1.523     albertel 5557: .LC_answer_charged_try {
1.797     www      5558:   background: #FFAAAA;
1.795     www      5559:   color: darkred;
                   5560:   padding: 6px;
1.523     albertel 5561: }
1.795     www      5562: 
1.779     bisitz   5563: .LC_answer_not_charged_try,
1.523     albertel 5564: .LC_answer_no_grade,
                   5565: .LC_answer_late {
1.795     www      5566:   background: lightyellow;
1.523     albertel 5567:   color: black;
1.795     www      5568:   padding: 6px;
1.523     albertel 5569: }
1.795     www      5570: 
1.523     albertel 5571: .LC_answer_previous {
1.795     www      5572:   background: lightblue;
                   5573:   color: darkblue;
                   5574:   padding: 6px;
1.523     albertel 5575: }
1.795     www      5576: 
1.779     bisitz   5577: .LC_answer_no_message {
1.777     tempelho 5578:   background: #FFFFFF;
                   5579:   color: black;
1.795     www      5580:   padding: 6px;
1.779     bisitz   5581: }
1.795     www      5582: 
1.779     bisitz   5583: .LC_answer_unknown {
                   5584:   background: orange;
                   5585:   color: black;
1.795     www      5586:   padding: 6px;
1.777     tempelho 5587: }
1.795     www      5588: 
1.529     albertel 5589: span.LC_prior_numerical,
                   5590: span.LC_prior_string,
                   5591: span.LC_prior_custom,
                   5592: span.LC_prior_reaction,
                   5593: span.LC_prior_math {
1.523     albertel 5594:   font-family: monospace;
                   5595:   white-space: pre;
                   5596: }
                   5597: 
1.525     albertel 5598: span.LC_prior_string {
                   5599:   font-family: monospace;
                   5600:   white-space: pre;
                   5601: }
                   5602: 
1.523     albertel 5603: table.LC_prior_option {
                   5604:   width: 100%;
                   5605:   border-collapse: collapse;
                   5606: }
1.795     www      5607: 
                   5608: table.LC_prior_rank, 
                   5609: table.LC_prior_match {
1.528     albertel 5610:   border-collapse: collapse;
                   5611: }
1.795     www      5612: 
1.528     albertel 5613: table.LC_prior_option tr td,
                   5614: table.LC_prior_rank tr td,
                   5615: table.LC_prior_match tr td {
1.524     albertel 5616:   border: 1px solid #000000;
1.515     albertel 5617: }
                   5618: 
1.855     bisitz   5619: .LC_nobreak {
1.544     albertel 5620:   white-space: nowrap;
1.519     raeburn  5621: }
                   5622: 
1.576     raeburn  5623: span.LC_cusr_emph {
                   5624:   font-style: italic;
                   5625: }
                   5626: 
1.633     raeburn  5627: span.LC_cusr_subheading {
                   5628:   font-weight: normal;
                   5629:   font-size: 85%;
                   5630: }
                   5631: 
1.545     albertel 5632: table.LC_docs_documents {
                   5633:   background: #BBBBBB;
1.803     bisitz   5634:   border-width: 0;
1.545     albertel 5635:   border-collapse: collapse;
                   5636: }
1.795     www      5637: 
1.777     tempelho 5638: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5639:   border: 2px solid black;
                   5640:   padding: 4px;
1.777     tempelho 5641: }
1.795     www      5642: 
1.861     bisitz   5643: div.LC_docs_entry_move {
1.859     bisitz   5644:   border: 1px solid #BBBBBB;
1.545     albertel 5645:   background: #DDDDDD;
1.861     bisitz   5646:   width: 22px;
1.859     bisitz   5647:   padding: 1px;
                   5648:   margin: 0;
1.545     albertel 5649: }
                   5650: 
1.861     bisitz   5651: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5652: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5653:   background: #DDDDDD;
                   5654:   font-size: x-small;
                   5655: }
1.795     www      5656: 
1.861     bisitz   5657: .LC_docs_entry_parameter {
                   5658:   white-space: nowrap;
                   5659: }
                   5660: 
1.544     albertel 5661: .LC_docs_copy {
1.545     albertel 5662:   color: #000099;
1.544     albertel 5663: }
1.795     www      5664: 
1.544     albertel 5665: .LC_docs_cut {
1.545     albertel 5666:   color: #550044;
1.544     albertel 5667: }
1.795     www      5668: 
1.544     albertel 5669: .LC_docs_rename {
1.545     albertel 5670:   color: #009900;
1.544     albertel 5671: }
1.795     www      5672: 
1.544     albertel 5673: .LC_docs_remove {
1.545     albertel 5674:   color: #990000;
                   5675: }
                   5676: 
1.547     albertel 5677: .LC_docs_reinit_warn,
                   5678: .LC_docs_ext_edit {
                   5679:   font-size: x-small;
                   5680: }
                   5681: 
1.545     albertel 5682: table.LC_docs_adddocs td,
                   5683: table.LC_docs_adddocs th {
                   5684:   border: 1px solid #BBBBBB;
                   5685:   padding: 4px;
                   5686:   background: #DDDDDD;
1.543     albertel 5687: }
                   5688: 
1.584     albertel 5689: table.LC_sty_begin {
                   5690:   background: #BBFFBB;
                   5691: }
1.795     www      5692: 
1.584     albertel 5693: table.LC_sty_end {
                   5694:   background: #FFBBBB;
                   5695: }
                   5696: 
1.589     raeburn  5697: table.LC_double_column {
1.803     bisitz   5698:   border-width: 0;
1.589     raeburn  5699:   border-collapse: collapse;
                   5700:   width: 100%;
                   5701:   padding: 2px;
                   5702: }
                   5703: 
                   5704: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5705:   top: 2px;
1.589     raeburn  5706:   left: 2px;
                   5707:   width: 47%;
                   5708:   vertical-align: top;
                   5709: }
                   5710: 
                   5711: table.LC_double_column tr td.LC_right_col {
                   5712:   top: 2px;
1.779     bisitz   5713:   right: 2px;
1.589     raeburn  5714:   width: 47%;
                   5715:   vertical-align: top;
                   5716: }
                   5717: 
1.591     raeburn  5718: div.LC_left_float {
                   5719:   float: left;
                   5720:   padding-right: 5%;
1.597     albertel 5721:   padding-bottom: 4px;
1.591     raeburn  5722: }
                   5723: 
                   5724: div.LC_clear_float_header {
1.597     albertel 5725:   padding-bottom: 2px;
1.591     raeburn  5726: }
                   5727: 
                   5728: div.LC_clear_float_footer {
1.597     albertel 5729:   padding-top: 10px;
1.591     raeburn  5730:   clear: both;
                   5731: }
                   5732: 
1.597     albertel 5733: div.LC_grade_show_user {
                   5734:   margin-top: 20px;
                   5735:   border: 1px solid black;
                   5736: }
1.795     www      5737: 
1.597     albertel 5738: div.LC_grade_user_name {
                   5739:   background: #DDDDEE;
                   5740:   border-bottom: 1px solid black;
1.705     tempelho 5741:   font-weight: bold;
                   5742:   font-size: large;
1.597     albertel 5743: }
1.795     www      5744: 
1.597     albertel 5745: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5746:   background: #DDEEDD;
                   5747: }
                   5748: 
                   5749: div.LC_grade_show_problem,
                   5750: div.LC_grade_submissions,
                   5751: div.LC_grade_message_center,
                   5752: div.LC_grade_info_links,
                   5753: div.LC_grade_assign {
                   5754:   margin: 5px;
                   5755:   width: 99%;
                   5756:   background: #FFFFFF;
                   5757: }
1.795     www      5758: 
1.597     albertel 5759: div.LC_grade_show_problem_header,
                   5760: div.LC_grade_submissions_header,
                   5761: div.LC_grade_message_center_header,
                   5762: div.LC_grade_assign_header {
1.705     tempelho 5763:   font-weight: bold;
                   5764:   font-size: large;
1.597     albertel 5765: }
1.795     www      5766: 
1.597     albertel 5767: div.LC_grade_show_problem_problem,
                   5768: div.LC_grade_submissions_body,
                   5769: div.LC_grade_message_center_body,
                   5770: div.LC_grade_assign_body {
                   5771:   border: 1px solid black;
                   5772:   width: 99%;
                   5773:   background: #FFFFFF;
                   5774: }
1.795     www      5775: 
1.598     albertel 5776: span.LC_grade_check_note {
1.705     tempelho 5777:   font-weight: normal;
                   5778:   font-size: medium;
1.598     albertel 5779:   display: inline;
                   5780:   position: absolute;
                   5781:   right: 1em;
                   5782: }
1.597     albertel 5783: 
1.613     albertel 5784: table.LC_scantron_action {
                   5785:   width: 100%;
                   5786: }
1.795     www      5787: 
1.613     albertel 5788: table.LC_scantron_action tr th {
1.698     harmsja  5789:   font-weight:bold;
                   5790:   font-style:normal;
1.613     albertel 5791: }
1.795     www      5792: 
1.779     bisitz   5793: .LC_edit_problem_header,
1.614     albertel 5794: div.LC_edit_problem_footer {
1.705     tempelho 5795:   font-weight: normal;
                   5796:   font-size:  medium;
1.602     albertel 5797:   margin: 2px;
1.600     albertel 5798: }
1.795     www      5799: 
1.600     albertel 5800: div.LC_edit_problem_header,
1.602     albertel 5801: div.LC_edit_problem_header div,
1.614     albertel 5802: div.LC_edit_problem_footer,
                   5803: div.LC_edit_problem_footer div,
1.602     albertel 5804: div.LC_edit_problem_editxml_header,
                   5805: div.LC_edit_problem_editxml_header div {
1.600     albertel 5806:   margin-top: 5px;
                   5807: }
1.795     www      5808: 
1.600     albertel 5809: div.LC_edit_problem_header_title {
1.705     tempelho 5810:   font-weight: bold;
                   5811:   font-size: larger;
1.602     albertel 5812:   background: $tabbg;
                   5813:   padding: 3px;
                   5814: }
1.795     www      5815: 
1.602     albertel 5816: table.LC_edit_problem_header_title {
1.705     tempelho 5817:   font-size: larger;
                   5818:   font-weight:  bold;
1.602     albertel 5819:   width: 100%;
                   5820:   border-color: $pgbg;
                   5821:   border-style: solid;
                   5822:   border-width: $border;
1.600     albertel 5823:   background: $tabbg;
1.602     albertel 5824:   border-collapse: collapse;
1.803     bisitz   5825:   padding: 0;
1.602     albertel 5826: }
                   5827: 
                   5828: div.LC_edit_problem_discards {
                   5829:   float: left;
                   5830:   padding-bottom: 5px;
                   5831: }
1.795     www      5832: 
1.602     albertel 5833: div.LC_edit_problem_saves {
                   5834:   float: right;
                   5835:   padding-bottom: 5px;
1.600     albertel 5836: }
1.795     www      5837: 
1.679     riegler  5838: img.stift{
1.803     bisitz   5839:   border-width: 0;
                   5840:   vertical-align: middle;
1.677     riegler  5841: }
1.680     riegler  5842: 
1.681     riegler  5843: table#LC_mainmenu{
                   5844:  margin-top:10px;
                   5845:  width:80%;
                   5846: }
                   5847: 
1.680     riegler  5848: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
                   5849:   vertical-align: top;
                   5850:   width: 45%;
                   5851: }
1.795     www      5852: 
1.779     bisitz   5853: .LC_mainmenu_fieldset_category {
                   5854:   color: $font;
                   5855:   background: $pgbg;
                   5856:   font-size: small;
                   5857:   font-weight: bold;
1.777     tempelho 5858: }
1.795     www      5859: 
1.716     raeburn  5860: div.LC_createcourse {
                   5861:     margin: 10px 10px 10px 10px;
                   5862: }
                   5863: 
1.693     droeschl 5864: /* ---- Remove when done ----
                   5865: # The following styles is part of the redesign of LON-CAPA and are
                   5866: # subject to change during this project.
                   5867: # Don't rely on their current functionality as they might be 
                   5868: # changed or removed.
                   5869: # --------------------------*/
                   5870: 
1.698     harmsja  5871: a:hover,
1.897     wenzelju 5872: ol.LC_primary_menu a:hover,
1.721     harmsja  5873: ol#LC_MenuBreadcrumbs a:hover,
                   5874: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5875: ul#LC_secondary_menu a:hover,
1.721     harmsja  5876: .LC_FormSectionClearButton input:hover
1.795     www      5877: ul.LC_TabContent   li:hover a {
1.698     harmsja  5878: 	color:#BF2317;
1.904     droeschl 5879:     text-decoration:none;
1.693     droeschl 5880: }
                   5881: 
1.779     bisitz   5882: h1 {
1.813     bisitz   5883: 	padding: 0;
1.693     droeschl 5884: 	line-height:130%;
                   5885: }
1.698     harmsja  5886: 
1.795     www      5887: h2,h3,h4,h5,h6 {
1.803     bisitz   5888: 	margin: 5px 0 5px 0;
                   5889: 	padding: 0;
1.721     harmsja  5890: 	line-height:130%;
1.693     droeschl 5891: }
1.795     www      5892: 
                   5893: .LC_hcell {
1.698     harmsja  5894:         padding:3px 15px 3px 15px;
1.803     bisitz   5895:         margin: 0;
1.703     harmsja  5896: 	background-color:$tabbg;
1.801     tempelho 5897: 	color:$fontmenu;
1.779     bisitz   5898: 	border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5899: }
1.795     www      5900: 
1.840     bisitz   5901: .LC_Box > .LC_hcell {
1.847     tempelho 5902:     margin: 0 -10px 10px -10px;
1.835     bisitz   5903: }
                   5904: 
1.721     harmsja  5905: .LC_noBorder {
1.803     bisitz   5906:         border: 0;
1.698     harmsja  5907: }
1.693     droeschl 5908: 
1.761     tempelho 5909: .LC_Right {
                   5910:         float: right;
1.803     bisitz   5911:         margin: 0;
                   5912:         padding: 0;
1.761     tempelho 5913: }
                   5914: 
1.721     harmsja  5915: .LC_FormSectionClearButton input {
1.779     bisitz   5916:         background-color:transparent;
1.803     bisitz   5917:         border: none;
1.698     harmsja  5918:         cursor:pointer;
                   5919:         text-decoration:underline;
1.693     droeschl 5920: }
1.763     bisitz   5921: 
                   5922: .LC_help_open_topic {
                   5923:         color: #FFFFFF;
                   5924:         background-color: #EEEEFF;
                   5925:         margin: 1px;
                   5926:         padding: 4px;
                   5927:         border: 1px solid #000033;
                   5928:         white-space: nowrap;
1.783     amueller 5929: /*		vertical-align: middle; */
1.759     neumanie 5930: }
1.693     droeschl 5931: 
1.698     harmsja  5932: dl,ul,div,fieldset {
1.803     bisitz   5933: 	margin: 10px 10px 10px 0;
1.806     bisitz   5934: /*	overflow: hidden; */
1.693     droeschl 5935: }
1.795     www      5936: 
1.838     bisitz   5937: fieldset > legend {
                   5938:     font-weight: bold;
                   5939:     padding: 0 5px 0 5px;
                   5940: }
                   5941: 
1.813     bisitz   5942: #LC_nav_bar {
1.807     droeschl 5943:     float: left;
1.852     droeschl 5944:     margin: 0.2em 0 0 0;
1.807     droeschl 5945: }
                   5946: 
1.813     bisitz   5947: #LC_nav_bar em{
1.807     droeschl 5948:     font-weight: bold;
                   5949:     font-style: normal;
                   5950: }
                   5951: 
1.897     wenzelju 5952: ol.LC_primary_menu {
1.807     droeschl 5953:     float: right;
1.852     droeschl 5954:     margin: 0.2em 0 0 0;
1.807     droeschl 5955: }
                   5956: 
1.852     droeschl 5957: ol#LC_PathBreadcrumbs {
1.803     bisitz   5958: 	margin: 0;
1.693     droeschl 5959: }
                   5960: 
1.897     wenzelju 5961: ol.LC_primary_menu li {
1.693     droeschl 5962: 	display: inline;
1.803     bisitz   5963: 	padding: 5px 5px 0 10px;
1.693     droeschl 5964: 	vertical-align: top;
                   5965: }
                   5966: 
1.897     wenzelju 5967: ol.LC_primary_menu li img {
1.693     droeschl 5968: 	vertical-align: bottom;
                   5969: }
                   5970: 
1.897     wenzelju 5971: ol.LC_primary_menu a {
1.693     droeschl 5972: 	font-size: 90%;
                   5973: 	color: RGB(80, 80, 80);
                   5974: 	text-decoration: none;
                   5975: }
1.795     www      5976: 
1.897     wenzelju 5977: ul#LC_secondary_menu {
1.807     droeschl 5978:     clear: both;
1.808     droeschl 5979:     color: $fontmenu;
                   5980:     background: $tabbg;
                   5981:     list-style: none;
                   5982:     padding: 0;
                   5983:     margin: 0;
                   5984:     width: 100%;
                   5985: }
                   5986: 
1.897     wenzelju 5987: ul#LC_secondary_menu li {
1.808     droeschl 5988:     font-weight: bold;
                   5989:     line-height: 1.8em;
                   5990:     padding: 0 0.8em; 
                   5991:     border-right: 1px solid black;
                   5992:     display: inline;
                   5993:     vertical-align: middle;
1.807     droeschl 5994: }
                   5995: 
1.847     tempelho 5996: ul.LC_TabContent {
1.721     harmsja  5997: 	display:block;
1.847     tempelho 5998: 	background: $sidebg;
1.858     bisitz   5999: 	border-bottom: solid 1px $lg_border_color;
1.721     harmsja  6000: 	list-style:none;
1.870     tempelho 6001: 	margin: 0 -10px;
1.803     bisitz   6002: 	padding: 0;
1.693     droeschl 6003: }
                   6004: 
1.795     www      6005: ul.LC_TabContent li,
                   6006: ul.LC_TabContentBigger li {
1.741     harmsja  6007: 	float:left;
                   6008: }
1.795     www      6009: 
1.897     wenzelju 6010: ul#LC_secondary_menu li a {
1.808     droeschl 6011:     color: $fontmenu;
1.693     droeschl 6012: 	text-decoration: none;
                   6013: }
1.795     www      6014: 
1.721     harmsja  6015: ul.LC_TabContent {
1.847     tempelho 6016: 	min-height:1.5em;
1.721     harmsja  6017: }
1.795     www      6018: 
                   6019: ul.LC_TabContent li {
1.741     harmsja  6020: 	vertical-align:middle;
1.803     bisitz   6021: 	padding: 0 10px 0 10px;
1.745     ehlerst  6022: 	background-color:$tabbg;
                   6023: 	border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6024: }
1.795     www      6025: 
1.847     tempelho 6026: ul.LC_TabContent .right {
                   6027: 	float:right;
                   6028: }
                   6029: 
1.795     www      6030: ul.LC_TabContent li a, ul.LC_TabContent li {
1.721     harmsja  6031: 	color:rgb(47,47,47);
                   6032: 	text-decoration:none;
                   6033: 	font-size:95%;
                   6034: 	font-weight:bold;
1.761     tempelho 6035: 	padding-right: 16px;
1.721     harmsja  6036: }
1.795     www      6037: 
                   6038: ul.LC_TabContent li:hover, ul.LC_TabContent li.active {
1.761     tempelho 6039:         background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.841     tempelho 6040: 	border-bottom:solid 2px #FFFFFF;
1.761     tempelho 6041: 	padding-right: 16px;
1.744     ehlerst  6042: }
1.795     www      6043: 
1.870     tempelho 6044: #maincoursedoc {
                   6045: 	clear:both;
                   6046: }
                   6047: 
                   6048: ul.LC_TabContentBigger {
                   6049:         display:block;
                   6050:         list-style:none;
                   6051:         padding: 0;
                   6052: }
                   6053: 
1.795     www      6054: ul.LC_TabContentBigger li {
1.870     tempelho 6055:         vertical-align:bottom;
                   6056:         height: 30px;
                   6057:         font-size:110%;
                   6058:         font-weight:bold;
                   6059:         color: #737373;
1.841     tempelho 6060: }
                   6061: 
1.870     tempelho 6062: 
                   6063: ul.LC_TabContentBigger li a {
                   6064:         background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6065: 	height: 30px;
                   6066: 	line-height: 30px;
                   6067: 	text-align: center;
                   6068: 	display: block;
                   6069: 	text-decoration: none;
1.741     harmsja  6070: }
1.795     www      6071: 
1.870     tempelho 6072: ul.LC_TabContentBigger li:hover a, 
                   6073: ul.LC_TabContentBigger li.active a {
                   6074: 	background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
1.857     tempelho 6075: 	color:$font;
1.870     tempelho 6076: 	text-decoration: underline;
1.744     ehlerst  6077: }
1.795     www      6078: 
1.870     tempelho 6079: 
                   6080: ul.LC_TabContentBigger li b {
                   6081: 	background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6082: 	display: block;
                   6083: 	float: left;
                   6084: 	padding: 0 30px;
                   6085: }
                   6086: 
                   6087: ul.LC_TabContentBigger li:hover b,
                   6088: ul.LC_TabContentBigger li.active b {
                   6089:         background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6090:         color:$font;
                   6091: 	border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6092: }
1.693     droeschl 6093: 
1.870     tempelho 6094: 
1.862     bisitz   6095: ul.LC_CourseBreadcrumbs {
                   6096:   background: $sidebg;
                   6097:   line-height: 32px;
                   6098:   padding-left: 10px;
                   6099:   margin: 0 0 10px 0;
                   6100:   list-style-position: inside;
                   6101: 
                   6102: }
                   6103: 
1.795     www      6104: ol#LC_MenuBreadcrumbs, 
1.862     bisitz   6105: ol#LC_PathBreadcrumbs {
1.693     droeschl 6106: 	padding-left: 10px;
1.819     tempelho 6107: 	margin: 0;
1.693     droeschl 6108: 	list-style-position: inside;
1.904     droeschl 6109:     /* SD working here
                   6110:     white-space: nowrap; */
1.693     droeschl 6111: }
                   6112: 
1.795     www      6113: ol#LC_MenuBreadcrumbs li, 
                   6114: ol#LC_PathBreadcrumbs li, 
1.862     bisitz   6115: ul.LC_CourseBreadcrumbs li {
1.842     droeschl 6116:     display: inline;
                   6117:     white-space: nowrap;
1.904     droeschl 6118:     /* SD working here
                   6119:     white-space: normal; */
1.693     droeschl 6120: }
                   6121: 
1.823     bisitz   6122: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6123: ul.LC_CourseBreadcrumbs li a {
1.693     droeschl 6124: 	text-decoration: none;
                   6125: 	font-size:90%;
                   6126: }
1.795     www      6127: 
                   6128: ol#LC_PathBreadcrumbs li a {
1.698     harmsja  6129: 	text-decoration:none;
                   6130: 	font-size:100%;
                   6131: 	font-weight:bold;
1.693     droeschl 6132: }
1.795     www      6133: 
1.840     bisitz   6134: .LC_Box {
1.835     bisitz   6135:     border: solid 1px $lg_border_color;
                   6136:     padding: 0 10px 10px 10px;
1.746     neumanie 6137: }
1.795     www      6138: 
                   6139: .LC_AboutMe_Image {
1.747     neumanie 6140: 	float:left;
                   6141: 	margin-right:10px;
                   6142: }
1.795     www      6143: 
                   6144: .LC_Clear_AboutMe_Image {
1.747     neumanie 6145: 	clear:left;
                   6146: }
1.795     www      6147: 
1.721     harmsja  6148: dl.LC_ListStyleClean dt {
1.693     droeschl 6149: 	padding-right: 5px;
                   6150: 	display: table-header-group;
                   6151: }
                   6152: 
1.721     harmsja  6153: dl.LC_ListStyleClean dd {
1.693     droeschl 6154: 	display: table-row;
                   6155: }
                   6156: 
1.721     harmsja  6157: .LC_ListStyleClean,
                   6158: .LC_ListStyleSimple,
                   6159: .LC_ListStyleNormal,
1.777     tempelho 6160: .LC_ListStyle_Border,
1.795     www      6161: .LC_ListStyleSpecial {
1.693     droeschl 6162: 	/*display:block;	*/
                   6163: 	list-style-position: inside;
                   6164: 	list-style-type: none;
                   6165: 	overflow: hidden;
1.803     bisitz   6166: 	padding: 0;
1.693     droeschl 6167: }
                   6168: 
1.721     harmsja  6169: .LC_ListStyleSimple li,
                   6170: .LC_ListStyleSimple dd,
                   6171: .LC_ListStyleNormal li,
                   6172: .LC_ListStyleNormal dd,
                   6173: .LC_ListStyleSpecial li,
1.795     www      6174: .LC_ListStyleSpecial dd {
1.803     bisitz   6175: 	margin: 0;
1.693     droeschl 6176: 	padding: 5px 5px 5px 10px;
                   6177: 	clear: both;
                   6178: }
                   6179: 
1.721     harmsja  6180: .LC_ListStyleClean li,
                   6181: .LC_ListStyleClean dd {
1.803     bisitz   6182: 	padding-top: 0;
                   6183: 	padding-bottom: 0;
1.693     droeschl 6184: }
                   6185: 
1.721     harmsja  6186: .LC_ListStyleSimple dd,
1.795     www      6187: .LC_ListStyleSimple li {
1.698     harmsja  6188: 	border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6189: }
                   6190: 
1.721     harmsja  6191: .LC_ListStyleSpecial li,
                   6192: .LC_ListStyleSpecial dd {
1.693     droeschl 6193: 	list-style-type: none;
                   6194: 	background-color: RGB(220, 220, 220);
                   6195: 	margin-bottom: 4px;
                   6196: }
                   6197: 
1.721     harmsja  6198: table.LC_SimpleTable {
1.698     harmsja  6199: 	margin:5px;
                   6200: 	border:solid 1px $lg_border_color;
1.795     www      6201: }
1.693     droeschl 6202: 
1.721     harmsja  6203: table.LC_SimpleTable tr {
1.803     bisitz   6204: 	padding: 0;
1.698     harmsja  6205: 	border:solid 1px $lg_border_color;
1.693     droeschl 6206: }
1.795     www      6207: 
                   6208: table.LC_SimpleTable thead {
1.698     harmsja  6209: 	 background:rgb(220,220,220);
1.693     droeschl 6210: }
                   6211: 
1.721     harmsja  6212: div.LC_columnSection {
1.693     droeschl 6213: 	display: block;
                   6214: 	clear: both;
                   6215: 	overflow: hidden;
1.803     bisitz   6216: 	margin: 0;
1.693     droeschl 6217: }
                   6218: 
1.721     harmsja  6219: div.LC_columnSection>* {
1.693     droeschl 6220: 	float: left;
1.803     bisitz   6221: 	margin: 10px 20px 10px 0;
1.747     neumanie 6222: 	overflow:hidden;
1.693     droeschl 6223: }
1.721     harmsja  6224: 
1.694     tempelho 6225: .LC_loginpage_container {
                   6226: 	text-align:left;
                   6227: 	margin : 0 auto;
1.785     tempelho 6228: 	width:90%;
1.694     tempelho 6229: 	padding: 10px;
                   6230: 	height: auto;
1.712     muellerd 6231: 	background-color:#FFFFFF;
1.694     tempelho 6232: 	border:1px solid #CCCCCC;
                   6233: }
                   6234: 
                   6235: 
                   6236: .LC_loginpage_loginContainer {
                   6237: 	float:left;
1.712     muellerd 6238: 	width: 182px;
1.785     tempelho 6239: 	padding: 2px;
1.712     muellerd 6240: 	border:1px solid #CCCCCC;
                   6241: 	background-color:$loginbg;
1.694     tempelho 6242: }
                   6243: 
1.795     www      6244: .LC_loginpage_loginContainer h2 {
1.803     bisitz   6245: 	margin-top: 0;
1.712     muellerd 6246: 	display:block;
                   6247: 	background:$bgcol;
                   6248: 	color:$textcol;
                   6249: 	padding-left:5px;
                   6250: }
1.785     tempelho 6251: 
1.694     tempelho 6252: .LC_loginpage_loginInfo {
                   6253: 	float:left;
1.785     tempelho 6254: 	width:182px;
1.694     tempelho 6255: 	border:1px solid #CCCCCC;
1.785     tempelho 6256: 	padding:2px;
1.712     muellerd 6257: }
                   6258: 
1.694     tempelho 6259: .LC_loginpage_space {
1.754     droeschl 6260: 	clear: both;
                   6261: 	margin-bottom: 20px;
1.694     tempelho 6262: 	border-bottom: 1px solid #CCCCCC;
                   6263: }
                   6264: 
1.785     tempelho 6265: .LC_loginpage_floatLeft {
                   6266: 	float: left;
                   6267: 	width: 200px;
                   6268: 	margin: 0;
                   6269: }
                   6270: 
1.795     www      6271: table em {
1.754     droeschl 6272: 	font-weight: bold;
                   6273: 	font-style: normal;
1.748     schulted 6274: }
1.795     www      6275: 
1.779     bisitz   6276: table.LC_tableBrowseRes,
1.795     www      6277: table.LC_tableOfContent {
1.769     schulted 6278:         border:none;
1.858     bisitz   6279: 	border-spacing: 1px;
1.754     droeschl 6280: 	padding: 3px;
                   6281: 	background-color: #FFFFFF;
                   6282: 	font-size: 90%;
1.753     droeschl 6283: }
1.789     droeschl 6284: 
                   6285: table.LC_tableOfContent{
                   6286:     border-collapse: collapse;
                   6287: }
                   6288: 
1.771     droeschl 6289: table.LC_tableBrowseRes a,
1.768     schulted 6290: table.LC_tableOfContent a {
1.771     droeschl 6291:         background-color: transparent;
1.753     droeschl 6292: 	text-decoration: none;
                   6293: }
                   6294: 
1.771     droeschl 6295: table.LC_tableBrowseRes tr.LC_trOdd,
1.768     schulted 6296: table.LC_tableOfContent tr.LC_trOdd{
1.754     droeschl 6297: 	background-color: #EEEEEE;
1.753     droeschl 6298: }
                   6299: 
1.795     www      6300: table.LC_tableOfContent img {
1.753     droeschl 6301: 	border: none;
                   6302: 	height: 1.3em;
                   6303: 	vertical-align: text-bottom;
                   6304: 	margin-right: 0.3em;
                   6305: }
1.757     schulted 6306: 
1.795     www      6307: a#LC_content_toolbar_firsthomework {
1.774     ehlerst  6308: 	background-image:url(/res/adm/pages/open-first-problem.gif);
                   6309: }
                   6310: 
1.795     www      6311: a#LC_content_toolbar_launchnav {
1.774     ehlerst  6312: 	background-image:url(/res/adm/pages/start-navigation.gif);
                   6313: }
                   6314: 
1.795     www      6315: a#LC_content_toolbar_closenav {
1.774     ehlerst  6316: 	background-image:url(/res/adm/pages/close-navigation.gif);
                   6317: }
                   6318: 
1.795     www      6319: a#LC_content_toolbar_everything {
1.774     ehlerst  6320: 	background-image:url(/res/adm/pages/show-all.gif);
                   6321: }
                   6322: 
1.795     www      6323: a#LC_content_toolbar_uncompleted {
1.774     ehlerst  6324: 	background-image:url(/res/adm/pages/show-incomplete-problems.gif);
                   6325: }
                   6326: 
1.795     www      6327: #LC_content_toolbar_clearbubbles {
1.774     ehlerst  6328: 	background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
                   6329: }
                   6330: 
1.795     www      6331: a#LC_content_toolbar_changefolder {
1.757     schulted 6332: 	background : url(/res/adm/pages/close-all-folders.gif) top center ;
                   6333: }
                   6334: 
1.795     www      6335: a#LC_content_toolbar_changefolder_toggled {
1.757     schulted 6336: 	background-image:url(/res/adm/pages/open-all-folders.gif);
                   6337: }
                   6338: 
1.795     www      6339: ul#LC_toolbar li a:hover {
1.757     schulted 6340: 	background-position: bottom center;
                   6341: }
                   6342: 
1.795     www      6343: ul#LC_toolbar {
1.803     bisitz   6344: 	padding: 0;
1.757     schulted 6345: 	margin: 2px;
                   6346: 	list-style:none;
                   6347: 	position:relative;
                   6348: 	background-color:white;
                   6349: }
                   6350: 
1.795     www      6351: ul#LC_toolbar li {
1.757     schulted 6352: 	border:1px solid white;
1.803     bisitz   6353: 	padding: 0;
1.757     schulted 6354: 	margin: 0;
1.795     www      6355:         float: left;
1.767     droeschl 6356: 	display:inline;
1.757     schulted 6357: 	vertical-align:middle;
1.795     www      6358: } 
1.757     schulted 6359: 
1.783     amueller 6360: 
1.795     www      6361: a.LC_toolbarItem {
1.767     droeschl 6362: 	display:block;
1.803     bisitz   6363: 	padding: 0;
                   6364: 	margin: 0;
1.757     schulted 6365: 	height: 32px;
                   6366: 	width: 32px;
1.779     bisitz   6367: 	color:white;
1.803     bisitz   6368: 	border: none;
1.757     schulted 6369: 	background-repeat:no-repeat;
                   6370: 	background-color:transparent;
                   6371: }
                   6372: 
1.843     bisitz   6373: ul.LC_funclist li {
1.782     bisitz   6374:   float: left;
                   6375:   white-space: nowrap;
                   6376:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6377:   margin: 0 15px 15px 10px;
1.782     bisitz   6378: }
                   6379: 
1.757     schulted 6380: 
1.343     albertel 6381: END
                   6382: }
                   6383: 
1.306     albertel 6384: =pod
                   6385: 
                   6386: =item * &headtag()
                   6387: 
                   6388: Returns a uniform footer for LON-CAPA web pages.
                   6389: 
1.307     albertel 6390: Inputs: $title - optional title for the head
                   6391:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6392:         $args - optional arguments
1.319     albertel 6393:             force_register - if is true call registerurl so the remote is 
                   6394:                              informed
1.415     albertel 6395:             redirect       -> array ref of
                   6396:                                    1- seconds before redirect occurs
                   6397:                                    2- url to redirect to
                   6398:                                    3- whether the side effect should occur
1.315     albertel 6399:                            (side effect of setting 
                   6400:                                $env{'internal.head.redirect'} to the url 
                   6401:                                redirected too)
1.352     albertel 6402:             domain         -> force to color decorate a page for a specific
                   6403:                                domain
                   6404:             function       -> force usage of a specific rolish color scheme
                   6405:             bgcolor        -> override the default page bgcolor
1.460     albertel 6406:             no_auto_mt_title
                   6407:                            -> prevent &mt()ing the title arg
1.464     albertel 6408: 
1.306     albertel 6409: =cut
                   6410: 
                   6411: sub headtag {
1.313     albertel 6412:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6413:     
1.363     albertel 6414:     my $function = $args->{'function'} || &get_users_function();
                   6415:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6416:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6417:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6418: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6419: 		   #time(),
1.418     albertel 6420: 		   $env{'environment.color.timestamp'},
1.363     albertel 6421: 		   $function,$domain,$bgcolor);
                   6422: 
1.369     www      6423:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6424: 
1.308     albertel 6425:     my $result =
                   6426: 	'<head>'.
1.461     albertel 6427: 	&font_settings();
1.319     albertel 6428: 
1.461     albertel 6429:     if (!$args->{'frameset'}) {
                   6430: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6431:     }
1.319     albertel 6432:     if ($args->{'force_register'}) {
                   6433: 	$result .= &Apache::lonmenu::registerurl(1);
                   6434:     }
1.436     albertel 6435:     if (!$args->{'no_nav_bar'} 
                   6436: 	&& !$args->{'only_body'}
                   6437: 	&& !$args->{'frameset'}) {
                   6438: 	$result .= &help_menu_js();
                   6439:     }
1.319     albertel 6440: 
1.314     albertel 6441:     if (ref($args->{'redirect'})) {
1.414     albertel 6442: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6443: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6444: 	if (!$inhibit_continue) {
                   6445: 	    $env{'internal.head.redirect'} = $url;
                   6446: 	}
1.313     albertel 6447: 	$result.=<<ADDMETA
                   6448: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6449: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6450: ADDMETA
                   6451:     }
1.306     albertel 6452:     if (!defined($title)) {
                   6453: 	$title = 'The LearningOnline Network with CAPA';
                   6454:     }
1.460     albertel 6455:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6456:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6457: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6458: 	.$head_extra;
1.306     albertel 6459:     return $result;
                   6460: }
                   6461: 
                   6462: =pod
                   6463: 
1.340     albertel 6464: =item * &font_settings()
                   6465: 
                   6466: Returns neccessary <meta> to set the proper encoding
                   6467: 
                   6468: Inputs: none
                   6469: 
                   6470: =cut
                   6471: 
                   6472: sub font_settings {
                   6473:     my $headerstring='';
1.647     www      6474:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6475: 	$headerstring.=
                   6476: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6477:     }
                   6478:     return $headerstring;
                   6479: }
                   6480: 
1.341     albertel 6481: =pod
                   6482: 
                   6483: =item * &xml_begin()
                   6484: 
                   6485: Returns the needed doctype and <html>
                   6486: 
                   6487: Inputs: none
                   6488: 
                   6489: =cut
                   6490: 
                   6491: sub xml_begin {
                   6492:     my $output='';
                   6493: 
1.592     albertel 6494:     if ($env{'internal.start_page'}==1) {
                   6495: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6496:     }
1.342     albertel 6497: 
1.341     albertel 6498:     if ($env{'browser.mathml'}) {
                   6499: 	$output='<?xml version="1.0"?>'
                   6500:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6501: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6502:             
                   6503: #	    .'<!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">] >'
                   6504: 	    .'<!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">'
                   6505:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6506: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6507:     } else {
1.849     bisitz   6508: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6509:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6510:     }
                   6511:     return $output;
                   6512: }
1.340     albertel 6513: 
                   6514: =pod
                   6515: 
1.306     albertel 6516: =item * &endheadtag()
                   6517: 
                   6518: Returns a uniform </head> for LON-CAPA web pages.
                   6519: 
                   6520: Inputs: none
                   6521: 
                   6522: =cut
                   6523: 
                   6524: sub endheadtag {
                   6525:     return '</head>';
                   6526: }
                   6527: 
                   6528: =pod
                   6529: 
                   6530: =item * &head()
                   6531: 
                   6532: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6533: 
1.648     raeburn  6534: Inputs:
                   6535: 
                   6536: =over 4
                   6537: 
                   6538: $title - optional title for the page
                   6539: 
                   6540: $head_extra - optional extra HTML to put inside the <head>
                   6541: 
                   6542: =back
1.405     albertel 6543: 
1.306     albertel 6544: =cut
                   6545: 
                   6546: sub head {
1.325     albertel 6547:     my ($title,$head_extra,$args) = @_;
                   6548:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6549: }
                   6550: 
                   6551: =pod
                   6552: 
                   6553: =item * &start_page()
                   6554: 
                   6555: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6556: 
1.648     raeburn  6557: Inputs:
                   6558: 
                   6559: =over 4
                   6560: 
                   6561: $title - optional title for the page
                   6562: 
                   6563: $head_extra - optional extra HTML to incude inside the <head>
                   6564: 
                   6565: $args - additional optional args supported are:
                   6566: 
                   6567: =over 8
                   6568: 
                   6569:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6570:                                     arg on
1.814     bisitz   6571:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6572:              add_entries    -> additional attributes to add to the  <body>
                   6573:              domain         -> force to color decorate a page for a 
1.317     albertel 6574:                                     specific domain
1.648     raeburn  6575:              function       -> force usage of a specific rolish color
1.317     albertel 6576:                                     scheme
1.648     raeburn  6577:              redirect       -> see &headtag()
                   6578:              bgcolor        -> override the default page bg color
                   6579:              js_ready       -> return a string ready for being used in 
1.317     albertel 6580:                                     a javascript writeln
1.648     raeburn  6581:              html_encode    -> return a string ready for being used in 
1.320     albertel 6582:                                     a html attribute
1.648     raeburn  6583:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6584:                                     $forcereg arg
1.648     raeburn  6585:              frameset       -> if true will start with a <frameset>
1.330     albertel 6586:                                     rather than <body>
1.648     raeburn  6587:              skip_phases    -> hash ref of 
1.338     albertel 6588:                                     head -> skip the <html><head> generation
                   6589:                                     body -> skip all <body> generation
1.648     raeburn  6590:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6591:                                     'Switch To Inline Menu' link
1.648     raeburn  6592:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6593:              inherit_jsmath -> when creating popup window in a page,
                   6594:                                     should it have jsmath forced on by the
                   6595:                                     current page
1.867     kalberla 6596:              bread_crumbs ->             Array containing breadcrumbs
                   6597:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6598: 
1.648     raeburn  6599: =back
1.460     albertel 6600: 
1.648     raeburn  6601: =back
1.562     albertel 6602: 
1.306     albertel 6603: =cut
                   6604: 
                   6605: sub start_page {
1.309     albertel 6606:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6607:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6608:     my %head_args;
1.352     albertel 6609:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6610: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6611: 		     'no_auto_mt_title') {
1.319     albertel 6612: 	if (defined($args->{$arg})) {
1.324     raeburn  6613: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6614: 	}
1.313     albertel 6615:     }
1.319     albertel 6616: 
1.315     albertel 6617:     $env{'internal.start_page'}++;
1.338     albertel 6618:     my $result;
                   6619:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6620: 	$result.=
1.341     albertel 6621: 	    &xml_begin().
1.338     albertel 6622: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6623:     }
                   6624:     
                   6625:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6626: 	if ($args->{'frameset'}) {
                   6627: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6628: 						$args->{'add_entries'});
                   6629: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6630:         } else {
                   6631:             $result .=
                   6632:                 &bodytag($title, 
                   6633:                          $args->{'function'},       $args->{'add_entries'},
                   6634:                          $args->{'only_body'},      $args->{'domain'},
                   6635:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6636:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6637:                          $args);
                   6638:         }
1.330     albertel 6639:     }
1.338     albertel 6640: 
1.315     albertel 6641:     if ($args->{'js_ready'}) {
1.713     kaisler  6642: 		$result = &js_ready($result);
1.315     albertel 6643:     }
1.320     albertel 6644:     if ($args->{'html_encode'}) {
1.713     kaisler  6645: 		$result = &html_encode($result);
                   6646:     }
                   6647: 
1.813     bisitz   6648:     # Preparation for new and consistent functionlist at top of screen
                   6649:     # if ($args->{'functionlist'}) {
                   6650:     #            $result .= &build_functionlist();
                   6651:     #}
                   6652: 
                   6653:     # Don't add anything more if only_body wanted
                   6654:     return $result if $args->{'only_body'};
                   6655: 
                   6656:     #Breadcrumbs
1.758     kaisler  6657:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6658: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6659: 		#if any br links exists, add them to the breadcrumbs
                   6660: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6661: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6662: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6663: 			}
                   6664: 		}
                   6665: 
                   6666: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6667: 		if(exists($args->{'bread_crumbs_component'})){
                   6668: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6669: 		}else{
                   6670: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6671: 		}
1.320     albertel 6672:     }
1.315     albertel 6673:     return $result;
1.306     albertel 6674: }
                   6675: 
1.330     albertel 6676: 
1.306     albertel 6677: =pod
                   6678: 
                   6679: =item * &head()
                   6680: 
                   6681: Returns a complete </body></html> section for LON-CAPA web pages.
                   6682: 
1.315     albertel 6683: Inputs:         $args - additional optional args supported are:
                   6684:                  js_ready     -> return a string ready for being used in 
                   6685:                                  a javascript writeln
1.320     albertel 6686:                  html_encode  -> return a string ready for being used in 
                   6687:                                  a html attribute
1.330     albertel 6688:                  frameset     -> if true will start with a <frameset>
                   6689:                                  rather than <body>
1.493     albertel 6690:                  dicsussion   -> if true will get discussion from
                   6691:                                   lonxml::xmlend
                   6692:                                  (you can pass the target and parser arguments
                   6693:                                   through optional 'target' and 'parser' args
                   6694:                                   to this routine)
1.306     albertel 6695: 
                   6696: =cut
                   6697: 
                   6698: sub end_page {
1.315     albertel 6699:     my ($args) = @_;
                   6700:     $env{'internal.end_page'}++;
1.330     albertel 6701:     my $result;
1.335     albertel 6702:     if ($args->{'discussion'}) {
                   6703: 	my ($target,$parser);
                   6704: 	if (ref($args->{'discussion'})) {
                   6705: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6706: 				$args->{'discussion'}{'parser'});
                   6707: 	}
                   6708: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6709:     }
                   6710: 
1.330     albertel 6711:     if ($args->{'frameset'}) {
                   6712: 	$result .= '</frameset>';
                   6713:     } else {
1.635     raeburn  6714: 	$result .= &endbodytag($args);
1.330     albertel 6715:     }
                   6716:     $result .= "\n</html>";
                   6717: 
1.315     albertel 6718:     if ($args->{'js_ready'}) {
1.317     albertel 6719: 	$result = &js_ready($result);
1.315     albertel 6720:     }
1.335     albertel 6721: 
1.320     albertel 6722:     if ($args->{'html_encode'}) {
                   6723: 	$result = &html_encode($result);
                   6724:     }
1.335     albertel 6725: 
1.315     albertel 6726:     return $result;
                   6727: }
                   6728: 
1.320     albertel 6729: sub html_encode {
                   6730:     my ($result) = @_;
                   6731: 
1.322     albertel 6732:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6733:     
                   6734:     return $result;
                   6735: }
1.317     albertel 6736: sub js_ready {
                   6737:     my ($result) = @_;
                   6738: 
1.323     albertel 6739:     $result =~ s/[\n\r]/ /xmsg;
                   6740:     $result =~ s/\\/\\\\/xmsg;
                   6741:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6742:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6743:     
                   6744:     return $result;
                   6745: }
                   6746: 
1.315     albertel 6747: sub validate_page {
                   6748:     if (  exists($env{'internal.start_page'})
1.316     albertel 6749: 	  &&     $env{'internal.start_page'} > 1) {
                   6750: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6751: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6752: 				 $ENV{'request.filename'});
1.315     albertel 6753:     }
                   6754:     if (  exists($env{'internal.end_page'})
1.316     albertel 6755: 	  &&     $env{'internal.end_page'} > 1) {
                   6756: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6757: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6758: 				 $env{'request.filename'});
1.315     albertel 6759:     }
                   6760:     if (     exists($env{'internal.start_page'})
                   6761: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6762: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6763: 				 $env{'request.filename'});
1.315     albertel 6764:     }
                   6765:     if (   ! exists($env{'internal.start_page'})
                   6766: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6767: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6768: 				 $env{'request.filename'});
1.315     albertel 6769:     }
1.306     albertel 6770: }
1.315     albertel 6771: 
1.318     albertel 6772: sub simple_error_page {
                   6773:     my ($r,$title,$msg) = @_;
                   6774:     my $page =
                   6775: 	&Apache::loncommon::start_page($title).
                   6776: 	&mt($msg).
                   6777: 	&Apache::loncommon::end_page();
                   6778:     if (ref($r)) {
                   6779: 	$r->print($page);
1.327     albertel 6780: 	return;
1.318     albertel 6781:     }
                   6782:     return $page;
                   6783: }
1.347     albertel 6784: 
                   6785: {
1.610     albertel 6786:     my @row_count;
1.347     albertel 6787:     sub start_data_table {
1.422     albertel 6788: 	my ($add_class) = @_;
                   6789: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6790: 	unshift(@row_count,0);
1.422     albertel 6791: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6792:     }
                   6793: 
                   6794:     sub end_data_table {
1.610     albertel 6795: 	shift(@row_count);
1.389     albertel 6796: 	return '</table>'."\n";;
1.347     albertel 6797:     }
                   6798: 
                   6799:     sub start_data_table_row {
1.422     albertel 6800: 	my ($add_class) = @_;
1.610     albertel 6801: 	$row_count[0]++;
                   6802: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6803: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 6804: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6805:     }
1.471     banghart 6806:     
                   6807:     sub continue_data_table_row {
                   6808: 	my ($add_class) = @_;
1.610     albertel 6809: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6810: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 6811: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6812:     }
1.347     albertel 6813: 
                   6814:     sub end_data_table_row {
1.389     albertel 6815: 	return '</tr>'."\n";;
1.347     albertel 6816:     }
1.367     www      6817: 
1.421     albertel 6818:     sub start_data_table_empty_row {
1.707     bisitz   6819: #	$row_count[0]++;
1.421     albertel 6820: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6821:     }
                   6822: 
                   6823:     sub end_data_table_empty_row {
                   6824: 	return '</tr>'."\n";;
                   6825:     }
                   6826: 
1.367     www      6827:     sub start_data_table_header_row {
1.389     albertel 6828: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6829:     }
                   6830: 
                   6831:     sub end_data_table_header_row {
1.389     albertel 6832: 	return '</tr>'."\n";;
1.367     www      6833:     }
1.890     droeschl 6834: 
                   6835:     sub data_table_caption {
                   6836:         my $caption = shift;
                   6837:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6838:     }
1.347     albertel 6839: }
                   6840: 
1.548     albertel 6841: =pod
                   6842: 
                   6843: =item * &inhibit_menu_check($arg)
                   6844: 
                   6845: Checks for a inhibitmenu state and generates output to preserve it
                   6846: 
                   6847: Inputs:         $arg - can be any of
                   6848:                      - undef - in which case the return value is a string 
                   6849:                                to add  into arguments list of a uri
                   6850:                      - 'input' - in which case the return value is a HTML
                   6851:                                  <form> <input> field of type hidden to
                   6852:                                  preserve the value
                   6853:                      - a url - in which case the return value is the url with
                   6854:                                the neccesary cgi args added to preserve the
                   6855:                                inhibitmenu state
                   6856:                      - a ref to a url - no return value, but the string is
                   6857:                                         updated to include the neccessary cgi
                   6858:                                         args to preserve the inhibitmenu state
                   6859: 
                   6860: =cut
                   6861: 
                   6862: sub inhibit_menu_check {
                   6863:     my ($arg) = @_;
                   6864:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6865:     if ($arg eq 'input') {
                   6866: 	if ($env{'form.inhibitmenu'}) {
                   6867: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6868: 	} else {
                   6869: 	    return
                   6870: 	}
                   6871:     }
                   6872:     if ($env{'form.inhibitmenu'}) {
                   6873: 	if (ref($arg)) {
                   6874: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6875: 	} elsif ($arg eq '') {
                   6876: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6877: 	} else {
                   6878: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6879: 	}
                   6880:     }
                   6881:     if (!ref($arg)) {
                   6882: 	return $arg;
                   6883:     }
                   6884: }
                   6885: 
1.251     albertel 6886: ###############################################
1.182     matthew  6887: 
                   6888: =pod
                   6889: 
1.549     albertel 6890: =back
                   6891: 
                   6892: =head1 User Information Routines
                   6893: 
                   6894: =over 4
                   6895: 
1.405     albertel 6896: =item * &get_users_function()
1.182     matthew  6897: 
                   6898: Used by &bodytag to determine the current users primary role.
                   6899: Returns either 'student','coordinator','admin', or 'author'.
                   6900: 
                   6901: =cut
                   6902: 
                   6903: ###############################################
                   6904: sub get_users_function {
1.815     tempelho 6905:     my $function = 'norole';
1.818     tempelho 6906:     if ($env{'request.role'}=~/^(st)/) {
                   6907:         $function='student';
                   6908:     }
1.907     raeburn  6909:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  6910:         $function='coordinator';
                   6911:     }
1.258     albertel 6912:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6913:         $function='admin';
                   6914:     }
1.826     bisitz   6915:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6916:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6917:         $function='author';
                   6918:     }
                   6919:     return $function;
1.54      www      6920: }
1.99      www      6921: 
                   6922: ###############################################
                   6923: 
1.233     raeburn  6924: =pod
                   6925: 
1.821     raeburn  6926: =item * &show_course()
                   6927: 
                   6928: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6929: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6930: 
                   6931: Inputs:
                   6932: None
                   6933: 
                   6934: Outputs:
                   6935: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6936: 
                   6937: =cut
                   6938: 
                   6939: ###############################################
                   6940: sub show_course {
                   6941:     my $course = !$env{'user.adv'};
                   6942:     if (!$env{'user.adv'}) {
                   6943:         foreach my $env (keys(%env)) {
                   6944:             next if ($env !~ m/^user\.priv\./);
                   6945:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   6946:                 $course = 0;
                   6947:                 last;
                   6948:             }
                   6949:         }
                   6950:     }
                   6951:     return $course;
                   6952: }
                   6953: 
                   6954: ###############################################
                   6955: 
                   6956: =pod
                   6957: 
1.542     raeburn  6958: =item * &check_user_status()
1.274     raeburn  6959: 
                   6960: Determines current status of supplied role for a
                   6961: specific user. Roles can be active, previous or future.
                   6962: 
                   6963: Inputs: 
                   6964: user's domain, user's username, course's domain,
1.375     raeburn  6965: course's number, optional section ID.
1.274     raeburn  6966: 
                   6967: Outputs:
                   6968: role status: active, previous or future. 
                   6969: 
                   6970: =cut
                   6971: 
                   6972: sub check_user_status {
1.412     raeburn  6973:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  6974:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   6975:     my @uroles = keys %userinfo;
                   6976:     my $srchstr;
                   6977:     my $active_chk = 'none';
1.412     raeburn  6978:     my $now = time;
1.274     raeburn  6979:     if (@uroles > 0) {
1.908     raeburn  6980:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  6981:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   6982:         } else {
1.412     raeburn  6983:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   6984:         }
                   6985:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  6986:             my $role_end = 0;
                   6987:             my $role_start = 0;
                   6988:             $active_chk = 'active';
1.412     raeburn  6989:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   6990:                 $role_end = $1;
                   6991:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   6992:                     $role_start = $1;
1.274     raeburn  6993:                 }
                   6994:             }
                   6995:             if ($role_start > 0) {
1.412     raeburn  6996:                 if ($now < $role_start) {
1.274     raeburn  6997:                     $active_chk = 'future';
                   6998:                 }
                   6999:             }
                   7000:             if ($role_end > 0) {
1.412     raeburn  7001:                 if ($now > $role_end) {
1.274     raeburn  7002:                     $active_chk = 'previous';
                   7003:                 }
                   7004:             }
                   7005:         }
                   7006:     }
                   7007:     return $active_chk;
                   7008: }
                   7009: 
                   7010: ###############################################
                   7011: 
                   7012: =pod
                   7013: 
1.405     albertel 7014: =item * &get_sections()
1.233     raeburn  7015: 
                   7016: Determines all the sections for a course including
                   7017: sections with students and sections containing other roles.
1.419     raeburn  7018: Incoming parameters: 
                   7019: 
                   7020: 1. domain
                   7021: 2. course number 
                   7022: 3. reference to array containing roles for which sections should 
                   7023: be gathered (optional).
                   7024: 4. reference to array containing status types for which sections 
                   7025: should be gathered (optional).
                   7026: 
                   7027: If the third argument is undefined, sections are gathered for any role. 
                   7028: If the fourth argument is undefined, sections are gathered for any status.
                   7029: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7030:  
1.374     raeburn  7031: Returns section hash (keys are section IDs, values are
                   7032: number of users in each section), subject to the
1.419     raeburn  7033: optional roles filter, optional status filter 
1.233     raeburn  7034: 
                   7035: =cut
                   7036: 
                   7037: ###############################################
                   7038: sub get_sections {
1.419     raeburn  7039:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7040:     if (!defined($cdom) || !defined($cnum)) {
                   7041:         my $cid =  $env{'request.course.id'};
                   7042: 
                   7043: 	return if (!defined($cid));
                   7044: 
                   7045:         $cdom = $env{'course.'.$cid.'.domain'};
                   7046:         $cnum = $env{'course.'.$cid.'.num'};
                   7047:     }
                   7048: 
                   7049:     my %sectioncount;
1.419     raeburn  7050:     my $now = time;
1.240     albertel 7051: 
1.366     albertel 7052:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7053: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7054: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7055: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7056:         my $start_index = &Apache::loncoursedata::CL_START();
                   7057:         my $end_index = &Apache::loncoursedata::CL_END();
                   7058:         my $status;
1.366     albertel 7059: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7060: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7061: 				                     $data->[$status_index],
                   7062:                                                      $data->[$start_index],
                   7063:                                                      $data->[$end_index]);
                   7064:             if ($stu_status eq 'Active') {
                   7065:                 $status = 'active';
                   7066:             } elsif ($end < $now) {
                   7067:                 $status = 'previous';
                   7068:             } elsif ($start > $now) {
                   7069:                 $status = 'future';
                   7070:             } 
                   7071: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7072:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7073:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7074: 		    $sectioncount{$section}++;
                   7075:                 }
1.240     albertel 7076: 	    }
                   7077: 	}
                   7078:     }
                   7079:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7080:     foreach my $user (sort(keys(%courseroles))) {
                   7081: 	if ($user !~ /^(\w{2})/) { next; }
                   7082: 	my ($role) = ($user =~ /^(\w{2})/);
                   7083: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7084: 	my ($section,$status);
1.240     albertel 7085: 	if ($role eq 'cr' &&
                   7086: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7087: 	    $section=$1;
                   7088: 	}
                   7089: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7090: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7091:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7092:         if ($end == -1 && $start == -1) {
                   7093:             next; #deleted role
                   7094:         }
                   7095:         if (!defined($possible_status)) { 
                   7096:             $sectioncount{$section}++;
                   7097:         } else {
                   7098:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7099:                 $status = 'active';
                   7100:             } elsif ($end < $now) {
                   7101:                 $status = 'future';
                   7102:             } elsif ($start > $now) {
                   7103:                 $status = 'previous';
                   7104:             }
                   7105:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7106:                 $sectioncount{$section}++;
                   7107:             }
                   7108:         }
1.233     raeburn  7109:     }
1.366     albertel 7110:     return %sectioncount;
1.233     raeburn  7111: }
                   7112: 
1.274     raeburn  7113: ###############################################
1.294     raeburn  7114: 
                   7115: =pod
1.405     albertel 7116: 
                   7117: =item * &get_course_users()
                   7118: 
1.275     raeburn  7119: Retrieves usernames:domains for users in the specified course
                   7120: with specific role(s), and access status. 
                   7121: 
                   7122: Incoming parameters:
1.277     albertel 7123: 1. course domain
                   7124: 2. course number
                   7125: 3. access status: users must have - either active, 
1.275     raeburn  7126: previous, future, or all.
1.277     albertel 7127: 4. reference to array of permissible roles
1.288     raeburn  7128: 5. reference to array of section restrictions (optional)
                   7129: 6. reference to results object (hash of hashes).
                   7130: 7. reference to optional userdata hash
1.609     raeburn  7131: 8. reference to optional statushash
1.630     raeburn  7132: 9. flag if privileged users (except those set to unhide in
                   7133:    course settings) should be excluded    
1.609     raeburn  7134: Keys of top level results hash are roles.
1.275     raeburn  7135: Keys of inner hashes are username:domain, with 
                   7136: values set to access type.
1.288     raeburn  7137: Optional userdata hash returns an array with arguments in the 
                   7138: same order as loncoursedata::get_classlist() for student data.
                   7139: 
1.609     raeburn  7140: Optional statushash returns
                   7141: 
1.288     raeburn  7142: Entries for end, start, section and status are blank because
                   7143: of the possibility of multiple values for non-student roles.
                   7144: 
1.275     raeburn  7145: =cut
1.405     albertel 7146: 
1.275     raeburn  7147: ###############################################
1.405     albertel 7148: 
1.275     raeburn  7149: sub get_course_users {
1.630     raeburn  7150:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7151:     my %idx = ();
1.419     raeburn  7152:     my %seclists;
1.288     raeburn  7153: 
                   7154:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7155:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7156:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7157:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7158:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7159:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7160:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7161:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7162: 
1.290     albertel 7163:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7164:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7165:         my $now = time;
1.277     albertel 7166:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7167:             my $match = 0;
1.412     raeburn  7168:             my $secmatch = 0;
1.419     raeburn  7169:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7170:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7171:             if ($section eq '') {
                   7172:                 $section = 'none';
                   7173:             }
1.291     albertel 7174:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7175:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7176:                     $secmatch = 1;
                   7177:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7178:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7179:                         $secmatch = 1;
                   7180:                     }
                   7181:                 } else {  
1.419     raeburn  7182: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7183: 		        $secmatch = 1;
                   7184:                     }
1.290     albertel 7185: 		}
1.412     raeburn  7186:                 if (!$secmatch) {
                   7187:                     next;
                   7188:                 }
1.419     raeburn  7189:             }
1.275     raeburn  7190:             if (defined($$types{'active'})) {
1.288     raeburn  7191:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7192:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7193:                     $match = 1;
1.275     raeburn  7194:                 }
                   7195:             }
                   7196:             if (defined($$types{'previous'})) {
1.609     raeburn  7197:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7198:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7199:                     $match = 1;
1.275     raeburn  7200:                 }
                   7201:             }
                   7202:             if (defined($$types{'future'})) {
1.609     raeburn  7203:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7204:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7205:                     $match = 1;
1.275     raeburn  7206:                 }
                   7207:             }
1.609     raeburn  7208:             if ($match) {
                   7209:                 push(@{$seclists{$student}},$section);
                   7210:                 if (ref($userdata) eq 'HASH') {
                   7211:                     $$userdata{$student} = $$classlist{$student};
                   7212:                 }
                   7213:                 if (ref($statushash) eq 'HASH') {
                   7214:                     $statushash->{$student}{'st'}{$section} = $status;
                   7215:                 }
1.288     raeburn  7216:             }
1.275     raeburn  7217:         }
                   7218:     }
1.412     raeburn  7219:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7220:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7221:         my $now = time;
1.609     raeburn  7222:         my %displaystatus = ( previous => 'Expired',
                   7223:                               active   => 'Active',
                   7224:                               future   => 'Future',
                   7225:                             );
1.630     raeburn  7226:         my %nothide;
                   7227:         if ($hidepriv) {
                   7228:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7229:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7230:                 if ($user !~ /:/) {
                   7231:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7232:                 } else {
                   7233:                     $nothide{$user} = 1;
                   7234:                 }
                   7235:             }
                   7236:         }
1.439     raeburn  7237:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7238:             my $match = 0;
1.412     raeburn  7239:             my $secmatch = 0;
1.439     raeburn  7240:             my $status;
1.412     raeburn  7241:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7242:             $user =~ s/:$//;
1.439     raeburn  7243:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7244:             if ($end == -1 || $start == -1) {
                   7245:                 next;
                   7246:             }
                   7247:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7248:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7249:                 my ($uname,$udom) = split(/:/,$user);
                   7250:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7251:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7252:                         $secmatch = 1;
                   7253:                     } elsif ($usec eq '') {
1.420     albertel 7254:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7255:                             $secmatch = 1;
                   7256:                         }
                   7257:                     } else {
                   7258:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7259:                             $secmatch = 1;
                   7260:                         }
                   7261:                     }
                   7262:                     if (!$secmatch) {
                   7263:                         next;
                   7264:                     }
1.288     raeburn  7265:                 }
1.419     raeburn  7266:                 if ($usec eq '') {
                   7267:                     $usec = 'none';
                   7268:                 }
1.275     raeburn  7269:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7270:                     if ($hidepriv) {
                   7271:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7272:                             (!$nothide{$uname.':'.$udom})) {
                   7273:                             next;
                   7274:                         }
                   7275:                     }
1.503     raeburn  7276:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7277:                         $status = 'previous';
                   7278:                     } elsif ($start > $now) {
                   7279:                         $status = 'future';
                   7280:                     } else {
                   7281:                         $status = 'active';
                   7282:                     }
1.277     albertel 7283:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7284:                         if ($status eq $type) {
1.420     albertel 7285:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7286:                                 push(@{$$users{$role}{$user}},$type);
                   7287:                             }
1.288     raeburn  7288:                             $match = 1;
                   7289:                         }
                   7290:                     }
1.419     raeburn  7291:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7292:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7293: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7294:                         }
1.420     albertel 7295:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7296:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7297:                         }
1.609     raeburn  7298:                         if (ref($statushash) eq 'HASH') {
                   7299:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7300:                         }
1.275     raeburn  7301:                     }
                   7302:                 }
                   7303:             }
                   7304:         }
1.290     albertel 7305:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7306:             if ((defined($cdom)) && (defined($cnum))) {
                   7307:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7308:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7309:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7310:                     next if ($owner eq '');
                   7311:                     my ($ownername,$ownerdom);
                   7312:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7313:                         $ownername = $1;
                   7314:                         $ownerdom = $2;
                   7315:                     } else {
                   7316:                         $ownername = $owner;
                   7317:                         $ownerdom = $cdom;
                   7318:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7319:                     }
                   7320:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7321:                     if (defined($userdata) && 
1.609     raeburn  7322: 			!exists($$userdata{$owner})) {
                   7323: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7324:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7325:                             push(@{$seclists{$owner}},'none');
                   7326:                         }
                   7327:                         if (ref($statushash) eq 'HASH') {
                   7328:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7329:                         }
1.290     albertel 7330: 		    }
1.279     raeburn  7331:                 }
                   7332:             }
                   7333:         }
1.419     raeburn  7334:         foreach my $user (keys(%seclists)) {
                   7335:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7336:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7337:         }
1.275     raeburn  7338:     }
                   7339:     return;
                   7340: }
                   7341: 
1.288     raeburn  7342: sub get_user_info {
                   7343:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7344:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7345: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7346:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7347:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7348:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7349:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7350:     return;
                   7351: }
1.275     raeburn  7352: 
1.472     raeburn  7353: ###############################################
                   7354: 
                   7355: =pod
                   7356: 
                   7357: =item * &get_user_quota()
                   7358: 
                   7359: Retrieves quota assigned for storage of portfolio files for a user  
                   7360: 
                   7361: Incoming parameters:
                   7362: 1. user's username
                   7363: 2. user's domain
                   7364: 
                   7365: Returns:
1.536     raeburn  7366: 1. Disk quota (in Mb) assigned to student.
                   7367: 2. (Optional) Type of setting: custom or default
                   7368:    (individually assigned or default for user's 
                   7369:    institutional status).
                   7370: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7371:    or student - types as defined in localenroll::inst_usertypes 
                   7372:    for user's domain, which determines default quota for user.
                   7373: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7374: 
                   7375: If a value has been stored in the user's environment, 
1.536     raeburn  7376: it will return that, otherwise it returns the maximal default
                   7377: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7378: 
                   7379: =cut
                   7380: 
                   7381: ###############################################
                   7382: 
                   7383: 
                   7384: sub get_user_quota {
                   7385:     my ($uname,$udom) = @_;
1.536     raeburn  7386:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7387:     if (!defined($udom)) {
                   7388:         $udom = $env{'user.domain'};
                   7389:     }
                   7390:     if (!defined($uname)) {
                   7391:         $uname = $env{'user.name'};
                   7392:     }
                   7393:     if (($udom eq '' || $uname eq '') ||
                   7394:         ($udom eq 'public') && ($uname eq 'public')) {
                   7395:         $quota = 0;
1.536     raeburn  7396:         $quotatype = 'default';
                   7397:         $defquota = 0; 
1.472     raeburn  7398:     } else {
1.536     raeburn  7399:         my $inststatus;
1.472     raeburn  7400:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7401:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7402:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7403:         } else {
1.536     raeburn  7404:             my %userenv = 
                   7405:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7406:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7407:             my ($tmp) = keys(%userenv);
                   7408:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7409:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7410:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7411:             } else {
                   7412:                 undef(%userenv);
                   7413:             }
                   7414:         }
1.536     raeburn  7415:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7416:         if ($quota eq '') {
1.536     raeburn  7417:             $quota = $defquota;
                   7418:             $quotatype = 'default';
                   7419:         } else {
                   7420:             $quotatype = 'custom';
1.472     raeburn  7421:         }
                   7422:     }
1.536     raeburn  7423:     if (wantarray) {
                   7424:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7425:     } else {
                   7426:         return $quota;
                   7427:     }
1.472     raeburn  7428: }
                   7429: 
                   7430: ###############################################
                   7431: 
                   7432: =pod
                   7433: 
                   7434: =item * &default_quota()
                   7435: 
1.536     raeburn  7436: Retrieves default quota assigned for storage of user portfolio files,
                   7437: given an (optional) user's institutional status.
1.472     raeburn  7438: 
                   7439: Incoming parameters:
                   7440: 1. domain
1.536     raeburn  7441: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7442:    status types (e.g., faculty, staff, student etc.)
                   7443:    which apply to the user for whom the default is being retrieved.
                   7444:    If the institutional status string in undefined, the domain
                   7445:    default quota will be returned. 
1.472     raeburn  7446: 
                   7447: Returns:
                   7448: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7449: 2. (Optional) institutional type which determined the value of the
                   7450:    default quota.
1.472     raeburn  7451: 
                   7452: If a value has been stored in the domain's configuration db,
                   7453: it will return that, otherwise it returns 20 (for backwards 
                   7454: compatibility with domains which have not set up a configuration
                   7455: db file; the original statically defined portfolio quota was 20 Mb). 
                   7456: 
1.536     raeburn  7457: If the user's status includes multiple types (e.g., staff and student),
                   7458: the largest default quota which applies to the user determines the
                   7459: default quota returned.
                   7460: 
1.780     raeburn  7461: =back
                   7462: 
1.472     raeburn  7463: =cut
                   7464: 
                   7465: ###############################################
                   7466: 
                   7467: 
                   7468: sub default_quota {
1.536     raeburn  7469:     my ($udom,$inststatus) = @_;
                   7470:     my ($defquota,$settingstatus);
                   7471:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7472:                                             ['quotas'],$udom);
                   7473:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7474:         if ($inststatus ne '') {
1.765     raeburn  7475:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7476:             foreach my $item (@statuses) {
1.711     raeburn  7477:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7478:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7479:                         if ($defquota eq '') {
                   7480:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7481:                             $settingstatus = $item;
                   7482:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7483:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7484:                             $settingstatus = $item;
                   7485:                         }
                   7486:                     }
                   7487:                 } else {
                   7488:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7489:                         if ($defquota eq '') {
                   7490:                             $defquota = $quotahash{'quotas'}{$item};
                   7491:                             $settingstatus = $item;
                   7492:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7493:                             $defquota = $quotahash{'quotas'}{$item};
                   7494:                             $settingstatus = $item;
                   7495:                         }
1.536     raeburn  7496:                     }
                   7497:                 }
                   7498:             }
                   7499:         }
                   7500:         if ($defquota eq '') {
1.711     raeburn  7501:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7502:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7503:             } else {
                   7504:                 $defquota = $quotahash{'quotas'}{'default'};
                   7505:             }
1.536     raeburn  7506:             $settingstatus = 'default';
                   7507:         }
                   7508:     } else {
                   7509:         $settingstatus = 'default';
                   7510:         $defquota = 20;
                   7511:     }
                   7512:     if (wantarray) {
                   7513:         return ($defquota,$settingstatus);
1.472     raeburn  7514:     } else {
1.536     raeburn  7515:         return $defquota;
1.472     raeburn  7516:     }
                   7517: }
                   7518: 
1.384     raeburn  7519: sub get_secgrprole_info {
                   7520:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7521:     my %sections_count = &get_sections($cdom,$cnum);
                   7522:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7523:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7524:     my @groups = sort(keys(%curr_groups));
                   7525:     my $allroles = [];
                   7526:     my $rolehash;
                   7527:     my $accesshash = {
                   7528:                      active => 'Currently has access',
                   7529:                      future => 'Will have future access',
                   7530:                      previous => 'Previously had access',
                   7531:                   };
                   7532:     if ($needroles) {
                   7533:         $rolehash = {'all' => 'all'};
1.385     albertel 7534:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7535: 	if (&Apache::lonnet::error(%user_roles)) {
                   7536: 	    undef(%user_roles);
                   7537: 	}
                   7538:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7539:             my ($role)=split(/\:/,$item,2);
                   7540:             if ($role eq 'cr') { next; }
                   7541:             if ($role =~ /^cr/) {
                   7542:                 $$rolehash{$role} = (split('/',$role))[3];
                   7543:             } else {
                   7544:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7545:             }
                   7546:         }
                   7547:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7548:             push(@{$allroles},$key);
                   7549:         }
                   7550:         push (@{$allroles},'st');
                   7551:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7552:     }
                   7553:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7554: }
                   7555: 
1.555     raeburn  7556: sub user_picker {
1.627     raeburn  7557:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7558:     my $currdom = $dom;
                   7559:     my %curr_selected = (
                   7560:                         srchin => 'dom',
1.580     raeburn  7561:                         srchby => 'lastname',
1.555     raeburn  7562:                       );
                   7563:     my $srchterm;
1.625     raeburn  7564:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7565:         if ($srch->{'srchby'} ne '') {
                   7566:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7567:         }
                   7568:         if ($srch->{'srchin'} ne '') {
                   7569:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7570:         }
                   7571:         if ($srch->{'srchtype'} ne '') {
                   7572:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7573:         }
                   7574:         if ($srch->{'srchdomain'} ne '') {
                   7575:             $currdom = $srch->{'srchdomain'};
                   7576:         }
                   7577:         $srchterm = $srch->{'srchterm'};
                   7578:     }
                   7579:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7580:                     'usr'       => 'Search criteria',
1.563     raeburn  7581:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7582:                     'uname'     => 'username',
                   7583:                     'lastname'  => 'last name',
1.555     raeburn  7584:                     'lastfirst' => 'last name, first name',
1.558     albertel 7585:                     'crs'       => 'in this course',
1.576     raeburn  7586:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7587:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7588:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7589:                     'exact'     => 'is',
                   7590:                     'contains'  => 'contains',
1.569     raeburn  7591:                     'begins'    => 'begins with',
1.571     raeburn  7592:                     'youm'      => "You must include some text to search for.",
                   7593:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7594:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7595:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7596:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7597:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7598:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7599:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7600:                                        );
1.563     raeburn  7601:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7602:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7603: 
                   7604:     my @srchins = ('crs','dom','alc','instd');
                   7605: 
                   7606:     foreach my $option (@srchins) {
                   7607:         # FIXME 'alc' option unavailable until 
                   7608:         #       loncreateuser::print_user_query_page()
                   7609:         #       has been completed.
                   7610:         next if ($option eq 'alc');
1.880     raeburn  7611:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7612:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7613:         if ($curr_selected{'srchin'} eq $option) {
                   7614:             $srchinsel .= ' 
                   7615:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7616:         } else {
                   7617:             $srchinsel .= '
                   7618:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7619:         }
1.555     raeburn  7620:     }
1.563     raeburn  7621:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7622: 
                   7623:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7624:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7625:         if ($curr_selected{'srchby'} eq $option) {
                   7626:             $srchbysel .= '
                   7627:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7628:         } else {
                   7629:             $srchbysel .= '
                   7630:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7631:          }
                   7632:     }
                   7633:     $srchbysel .= "\n  </select>\n";
                   7634: 
                   7635:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7636:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7637:         if ($curr_selected{'srchtype'} eq $option) {
                   7638:             $srchtypesel .= '
                   7639:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7640:         } else {
                   7641:             $srchtypesel .= '
                   7642:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7643:         }
                   7644:     }
                   7645:     $srchtypesel .= "\n  </select>\n";
                   7646: 
1.558     albertel 7647:     my ($newuserscript,$new_user_create);
1.556     raeburn  7648: 
                   7649:     if ($forcenewuser) {
1.576     raeburn  7650:         if (ref($srch) eq 'HASH') {
                   7651:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7652:                 if ($cancreate) {
                   7653:                     $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>';
                   7654:                 } else {
1.799     bisitz   7655:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7656:                     my %usertypetext = (
                   7657:                         official   => 'institutional',
                   7658:                         unofficial => 'non-institutional',
                   7659:                     );
1.799     bisitz   7660:                     $new_user_create = '<p class="LC_warning">'
                   7661:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7662:                                       .' '
                   7663:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7664:                                           ,'<a href="'.$helplink.'">','</a>')
                   7665:                                       .'</p><br />';
1.627     raeburn  7666:                 }
1.576     raeburn  7667:             }
                   7668:         }
                   7669: 
1.556     raeburn  7670:         $newuserscript = <<"ENDSCRIPT";
                   7671: 
1.570     raeburn  7672: function setSearch(createnew,callingForm) {
1.556     raeburn  7673:     if (createnew == 1) {
1.570     raeburn  7674:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7675:             if (callingForm.srchby.options[i].value == 'uname') {
                   7676:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7677:             }
                   7678:         }
1.570     raeburn  7679:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7680:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7681: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7682:             }
                   7683:         }
1.570     raeburn  7684:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7685:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7686:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7687:             }
                   7688:         }
1.570     raeburn  7689:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7690:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7691:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7692:             }
                   7693:         }
                   7694:     }
                   7695: }
                   7696: ENDSCRIPT
1.558     albertel 7697: 
1.556     raeburn  7698:     }
                   7699: 
1.555     raeburn  7700:     my $output = <<"END_BLOCK";
1.556     raeburn  7701: <script type="text/javascript">
1.824     bisitz   7702: // <![CDATA[
1.570     raeburn  7703: function validateEntry(callingForm) {
1.558     albertel 7704: 
1.556     raeburn  7705:     var checkok = 1;
1.558     albertel 7706:     var srchin;
1.570     raeburn  7707:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7708: 	if ( callingForm.srchin[i].checked ) {
                   7709: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7710: 	}
                   7711:     }
                   7712: 
1.570     raeburn  7713:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7714:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7715:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7716:     var srchterm =  callingForm.srchterm.value;
                   7717:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7718:     var msg = "";
                   7719: 
                   7720:     if (srchterm == "") {
                   7721:         checkok = 0;
1.571     raeburn  7722:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7723:     }
                   7724: 
1.569     raeburn  7725:     if (srchtype== 'begins') {
                   7726:         if (srchterm.length < 2) {
                   7727:             checkok = 0;
1.571     raeburn  7728:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7729:         }
                   7730:     }
                   7731: 
1.556     raeburn  7732:     if (srchtype== 'contains') {
                   7733:         if (srchterm.length < 3) {
                   7734:             checkok = 0;
1.571     raeburn  7735:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7736:         }
                   7737:     }
                   7738:     if (srchin == 'instd') {
                   7739:         if (srchdomain == '') {
                   7740:             checkok = 0;
1.571     raeburn  7741:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7742:         }
                   7743:     }
                   7744:     if (srchin == 'dom') {
                   7745:         if (srchdomain == '') {
                   7746:             checkok = 0;
1.571     raeburn  7747:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7748:         }
                   7749:     }
                   7750:     if (srchby == 'lastfirst') {
                   7751:         if (srchterm.indexOf(",") == -1) {
                   7752:             checkok = 0;
1.571     raeburn  7753:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7754:         }
                   7755:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7756:             checkok = 0;
1.571     raeburn  7757:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7758:         }
                   7759:     }
                   7760:     if (checkok == 0) {
1.571     raeburn  7761:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7762:         return;
                   7763:     }
                   7764:     if (checkok == 1) {
1.570     raeburn  7765:         callingForm.submit();
1.556     raeburn  7766:     }
                   7767: }
                   7768: 
                   7769: $newuserscript
                   7770: 
1.824     bisitz   7771: // ]]>
1.556     raeburn  7772: </script>
1.558     albertel 7773: 
                   7774: $new_user_create
                   7775: 
1.555     raeburn  7776: END_BLOCK
1.558     albertel 7777: 
1.876     raeburn  7778:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7779:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7780:                $domform.
                   7781:                &Apache::lonhtmlcommon::row_closure().
                   7782:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7783:                $srchbysel.
                   7784:                $srchtypesel. 
                   7785:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7786:                $srchinsel.
                   7787:                &Apache::lonhtmlcommon::row_closure(1). 
                   7788:                &Apache::lonhtmlcommon::end_pick_box().
                   7789:                '<br />';
1.555     raeburn  7790:     return $output;
                   7791: }
                   7792: 
1.612     raeburn  7793: sub user_rule_check {
1.615     raeburn  7794:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7795:     my $response;
                   7796:     if (ref($usershash) eq 'HASH') {
                   7797:         foreach my $user (keys(%{$usershash})) {
                   7798:             my ($uname,$udom) = split(/:/,$user);
                   7799:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7800:             my ($id,$newuser);
1.612     raeburn  7801:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7802:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7803:                 $id = $usershash->{$user}->{'id'};
                   7804:             }
                   7805:             my $inst_response;
                   7806:             if (ref($checks) eq 'HASH') {
                   7807:                 if (defined($checks->{'username'})) {
1.615     raeburn  7808:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7809:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7810:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7811:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7812:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7813:                 }
1.615     raeburn  7814:             } else {
                   7815:                 ($inst_response,%{$inst_results->{$user}}) =
                   7816:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7817:                 return;
1.612     raeburn  7818:             }
1.615     raeburn  7819:             if (!$got_rules->{$udom}) {
1.612     raeburn  7820:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7821:                                                   ['usercreation'],$udom);
                   7822:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7823:                     foreach my $item ('username','id') {
1.612     raeburn  7824:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7825:                             $$curr_rules{$udom}{$item} = 
                   7826:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7827:                         }
                   7828:                     }
                   7829:                 }
1.615     raeburn  7830:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7831:             }
1.612     raeburn  7832:             foreach my $item (keys(%{$checks})) {
                   7833:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7834:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7835:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7836:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7837:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7838:                                 if ($rule_check{$rule}) {
                   7839:                                     $$rulematch{$user}{$item} = $rule;
                   7840:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7841:                                         if (ref($inst_results) eq 'HASH') {
                   7842:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7843:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7844:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7845:                                                 }
1.612     raeburn  7846:                                             }
                   7847:                                         }
1.615     raeburn  7848:                                     }
                   7849:                                     last;
1.585     raeburn  7850:                                 }
                   7851:                             }
                   7852:                         }
                   7853:                     }
                   7854:                 }
                   7855:             }
                   7856:         }
                   7857:     }
1.612     raeburn  7858:     return;
                   7859: }
                   7860: 
                   7861: sub user_rule_formats {
                   7862:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7863:     my %text = ( 
                   7864:                  'username' => 'Usernames',
                   7865:                  'id'       => 'IDs',
                   7866:                );
                   7867:     my $output;
                   7868:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7869:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7870:         if (@{$ruleorder} > 0) {
                   7871:             $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>';
                   7872:             foreach my $rule (@{$ruleorder}) {
                   7873:                 if (ref($curr_rules) eq 'ARRAY') {
                   7874:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7875:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7876:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7877:                                         $rules->{$rule}{'desc'}.'</li>';
                   7878:                         }
                   7879:                     }
                   7880:                 }
                   7881:             }
                   7882:             $output .= '</ul>';
                   7883:         }
                   7884:     }
                   7885:     return $output;
                   7886: }
                   7887: 
                   7888: sub instrule_disallow_msg {
1.615     raeburn  7889:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7890:     my $response;
                   7891:     my %text = (
                   7892:                   item   => 'username',
                   7893:                   items  => 'usernames',
                   7894:                   match  => 'matches',
                   7895:                   do     => 'does',
                   7896:                   action => 'a username',
                   7897:                   one    => 'one',
                   7898:                );
                   7899:     if ($count > 1) {
                   7900:         $text{'item'} = 'usernames';
                   7901:         $text{'match'} ='match';
                   7902:         $text{'do'} = 'do';
                   7903:         $text{'action'} = 'usernames',
                   7904:         $text{'one'} = 'ones';
                   7905:     }
                   7906:     if ($checkitem eq 'id') {
                   7907:         $text{'items'} = 'IDs';
                   7908:         $text{'item'} = 'ID';
                   7909:         $text{'action'} = 'an ID';
1.615     raeburn  7910:         if ($count > 1) {
                   7911:             $text{'item'} = 'IDs';
                   7912:             $text{'action'} = 'IDs';
                   7913:         }
1.612     raeburn  7914:     }
1.674     bisitz   7915:     $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  7916:     if ($mode eq 'upload') {
                   7917:         if ($checkitem eq 'username') {
                   7918:             $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'}.");
                   7919:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7920:             $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  7921:         }
1.669     raeburn  7922:     } elsif ($mode eq 'selfcreate') {
                   7923:         if ($checkitem eq 'id') {
                   7924:             $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.");
                   7925:         }
1.615     raeburn  7926:     } else {
                   7927:         if ($checkitem eq 'username') {
                   7928:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7929:         } elsif ($checkitem eq 'id') {
                   7930:             $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.");
                   7931:         }
1.612     raeburn  7932:     }
                   7933:     return $response;
1.585     raeburn  7934: }
                   7935: 
1.624     raeburn  7936: sub personal_data_fieldtitles {
                   7937:     my %fieldtitles = &Apache::lonlocal::texthash (
                   7938:                         id => 'Student/Employee ID',
                   7939:                         permanentemail => 'E-mail address',
                   7940:                         lastname => 'Last Name',
                   7941:                         firstname => 'First Name',
                   7942:                         middlename => 'Middle Name',
                   7943:                         generation => 'Generation',
                   7944:                         gen => 'Generation',
1.765     raeburn  7945:                         inststatus => 'Affiliation',
1.624     raeburn  7946:                    );
                   7947:     return %fieldtitles;
                   7948: }
                   7949: 
1.642     raeburn  7950: sub sorted_inst_types {
                   7951:     my ($dom) = @_;
                   7952:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   7953:     my $othertitle = &mt('All users');
                   7954:     if ($env{'request.course.id'}) {
1.668     raeburn  7955:         $othertitle  = &mt('Any users');
1.642     raeburn  7956:     }
                   7957:     my @types;
                   7958:     if (ref($order) eq 'ARRAY') {
                   7959:         @types = @{$order};
                   7960:     }
                   7961:     if (@types == 0) {
                   7962:         if (ref($usertypes) eq 'HASH') {
                   7963:             @types = sort(keys(%{$usertypes}));
                   7964:         }
                   7965:     }
                   7966:     if (keys(%{$usertypes}) > 0) {
                   7967:         $othertitle = &mt('Other users');
                   7968:     }
                   7969:     return ($othertitle,$usertypes,\@types);
                   7970: }
                   7971: 
1.645     raeburn  7972: sub get_institutional_codes {
                   7973:     my ($settings,$allcourses,$LC_code) = @_;
                   7974: # Get complete list of course sections to update
                   7975:     my @currsections = ();
                   7976:     my @currxlists = ();
                   7977:     my $coursecode = $$settings{'internal.coursecode'};
                   7978: 
                   7979:     if ($$settings{'internal.sectionnums'} ne '') {
                   7980:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   7981:     }
                   7982: 
                   7983:     if ($$settings{'internal.crosslistings'} ne '') {
                   7984:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   7985:     }
                   7986: 
                   7987:     if (@currxlists > 0) {
                   7988:         foreach (@currxlists) {
                   7989:             if (m/^([^:]+):(\w*)$/) {
                   7990:                 unless (grep/^$1$/,@{$allcourses}) {
                   7991:                     push @{$allcourses},$1;
                   7992:                     $$LC_code{$1} = $2;
                   7993:                 }
                   7994:             }
                   7995:         }
                   7996:     }
                   7997:  
                   7998:     if (@currsections > 0) {
                   7999:         foreach (@currsections) {
                   8000:             if (m/^(\w+):(\w*)$/) {
                   8001:                 my $sec = $coursecode.$1;
                   8002:                 my $lc_sec = $2;
                   8003:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8004:                     push @{$allcourses},$sec;
                   8005:                     $$LC_code{$sec} = $lc_sec;
                   8006:                 }
                   8007:             }
                   8008:         }
                   8009:     }
                   8010:     return;
                   8011: }
                   8012: 
1.112     bowersj2 8013: =pod
                   8014: 
1.780     raeburn  8015: =head1 Slot Helpers
                   8016: 
                   8017: =over 4
                   8018: 
                   8019: =item * sorted_slots()
                   8020: 
                   8021: Sorts an array of slot names in order of slot start time (earliest first). 
                   8022: 
                   8023: Inputs:
                   8024: 
                   8025: =over 4
                   8026: 
                   8027: slotsarr  - Reference to array of unsorted slot names.
                   8028: 
                   8029: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8030: 
1.549     albertel 8031: =back
                   8032: 
1.780     raeburn  8033: Returns:
                   8034: 
                   8035: =over 4
                   8036: 
                   8037: sorted   - An array of slot names sorted by the start time of the slot.
                   8038: 
                   8039: =back
                   8040: 
                   8041: =back
                   8042: 
                   8043: =cut
                   8044: 
                   8045: 
                   8046: sub sorted_slots {
                   8047:     my ($slotsarr,$slots) = @_;
                   8048:     my @sorted;
                   8049:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8050:         @sorted =
                   8051:             sort {
                   8052:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8053:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8054:                      }
                   8055:                      if (ref($slots->{$a})) { return -1;}
                   8056:                      if (ref($slots->{$b})) { return 1;}
                   8057:                      return 0;
                   8058:                  } @{$slotsarr};
                   8059:     }
                   8060:     return @sorted;
                   8061: }
                   8062: 
                   8063: 
                   8064: =pod
                   8065: 
1.549     albertel 8066: =head1 HTTP Helpers
                   8067: 
                   8068: =over 4
                   8069: 
1.648     raeburn  8070: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8071: 
1.258     albertel 8072: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8073: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8074: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8075: 
                   8076: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8077: $possible_names is an ref to an array of form element names.  As an example:
                   8078: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8079: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8080: 
                   8081: =cut
1.1       albertel 8082: 
1.6       albertel 8083: sub get_unprocessed_cgi {
1.25      albertel 8084:   my ($query,$possible_names)= @_;
1.26      matthew  8085:   # $Apache::lonxml::debug=1;
1.356     albertel 8086:   foreach my $pair (split(/&/,$query)) {
                   8087:     my ($name, $value) = split(/=/,$pair);
1.369     www      8088:     $name = &unescape($name);
1.25      albertel 8089:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8090:       $value =~ tr/+/ /;
                   8091:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8092:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8093:     }
1.16      harris41 8094:   }
1.6       albertel 8095: }
                   8096: 
1.112     bowersj2 8097: =pod
                   8098: 
1.648     raeburn  8099: =item * &cacheheader() 
1.112     bowersj2 8100: 
                   8101: returns cache-controlling header code
                   8102: 
                   8103: =cut
                   8104: 
1.7       albertel 8105: sub cacheheader {
1.258     albertel 8106:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8107:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8108:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8109:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8110:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8111:     return $output;
1.7       albertel 8112: }
                   8113: 
1.112     bowersj2 8114: =pod
                   8115: 
1.648     raeburn  8116: =item * &no_cache($r) 
1.112     bowersj2 8117: 
                   8118: specifies header code to not have cache
                   8119: 
                   8120: =cut
                   8121: 
1.9       albertel 8122: sub no_cache {
1.216     albertel 8123:     my ($r) = @_;
                   8124:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8125: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8126:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8127:     $r->no_cache(1);
                   8128:     $r->header_out("Expires" => $date);
                   8129:     $r->header_out("Pragma" => "no-cache");
1.123     www      8130: }
                   8131: 
                   8132: sub content_type {
1.181     albertel 8133:     my ($r,$type,$charset) = @_;
1.299     foxr     8134:     if ($r) {
                   8135: 	#  Note that printout.pl calls this with undef for $r.
                   8136: 	&no_cache($r);
                   8137:     }
1.258     albertel 8138:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8139:     unless ($charset) {
                   8140: 	$charset=&Apache::lonlocal::current_encoding;
                   8141:     }
                   8142:     if ($charset) { $type.='; charset='.$charset; }
                   8143:     if ($r) {
                   8144: 	$r->content_type($type);
                   8145:     } else {
                   8146: 	print("Content-type: $type\n\n");
                   8147:     }
1.9       albertel 8148: }
1.25      albertel 8149: 
1.112     bowersj2 8150: =pod
                   8151: 
1.648     raeburn  8152: =item * &add_to_env($name,$value) 
1.112     bowersj2 8153: 
1.258     albertel 8154: adds $name to the %env hash with value
1.112     bowersj2 8155: $value, if $name already exists, the entry is converted to an array
                   8156: reference and $value is added to the array.
                   8157: 
                   8158: =cut
                   8159: 
1.25      albertel 8160: sub add_to_env {
                   8161:   my ($name,$value)=@_;
1.258     albertel 8162:   if (defined($env{$name})) {
                   8163:     if (ref($env{$name})) {
1.25      albertel 8164:       #already have multiple values
1.258     albertel 8165:       push(@{ $env{$name} },$value);
1.25      albertel 8166:     } else {
                   8167:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8168:       my $first=$env{$name};
                   8169:       undef($env{$name});
                   8170:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8171:     }
                   8172:   } else {
1.258     albertel 8173:     $env{$name}=$value;
1.25      albertel 8174:   }
1.31      albertel 8175: }
1.149     albertel 8176: 
                   8177: =pod
                   8178: 
1.648     raeburn  8179: =item * &get_env_multiple($name) 
1.149     albertel 8180: 
1.258     albertel 8181: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8182: values may be defined and end up as an array ref.
                   8183: 
                   8184: returns an array of values
                   8185: 
                   8186: =cut
                   8187: 
                   8188: sub get_env_multiple {
                   8189:     my ($name) = @_;
                   8190:     my @values;
1.258     albertel 8191:     if (defined($env{$name})) {
1.149     albertel 8192:         # exists is it an array
1.258     albertel 8193:         if (ref($env{$name})) {
                   8194:             @values=@{ $env{$name} };
1.149     albertel 8195:         } else {
1.258     albertel 8196:             $values[0]=$env{$name};
1.149     albertel 8197:         }
                   8198:     }
                   8199:     return(@values);
                   8200: }
                   8201: 
1.660     raeburn  8202: sub ask_for_embedded_content {
                   8203:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8204:     my $upload_output = '
                   8205:    <form name="upload_embedded" action="'.$actionurl.'"
                   8206:                   method="post" enctype="multipart/form-data">';
                   8207:     $upload_output .= $state;
1.661     raeburn  8208:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8209: 
                   8210:     my $num = 0;
                   8211:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8212:         $upload_output .= &start_data_table_row().
                   8213:             '<td>'.$embed_file.'</td><td>';
                   8214:         if ($args->{'ignore_remote_references'}
                   8215:             && $embed_file =~ m{^\w+://}) {
                   8216:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8217:         } elsif ($args->{'error_on_invalid_names'}
                   8218:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8219: 
                   8220:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8221: 
                   8222:         } else {
                   8223:             $upload_output .='
1.661     raeburn  8224:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8225:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8226:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8227:             $upload_output .=
                   8228:                 "\n\t\t".
                   8229:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8230:                 $attrib.'" />';
                   8231:             if (exists($$codebase{$embed_file})) {
                   8232:                 $upload_output .=
                   8233:                     "\n\t\t".
                   8234:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8235:                     &escape($$codebase{$embed_file}).'" />';
                   8236:             }
                   8237:         }
                   8238:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8239:         $num++;
                   8240:     }
                   8241:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8242:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8243:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8244:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8245:    </form>';
                   8246:     return $upload_output;
                   8247: }
                   8248: 
1.661     raeburn  8249: sub upload_embedded {
                   8250:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8251:         $current_disk_usage) = @_;
                   8252:     my $output;
                   8253:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8254:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8255:         my $orig_uploaded_filename =
                   8256:             $env{'form.embedded_item_'.$i.'.filename'};
                   8257: 
                   8258:         $env{'form.embedded_orig_'.$i} =
                   8259:             &unescape($env{'form.embedded_orig_'.$i});
                   8260:         my ($path,$fname) =
                   8261:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8262:         # no path, whole string is fname
                   8263:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8264: 
                   8265:         $path = $env{'form.currentpath'}.$path;
                   8266:         $fname = &Apache::lonnet::clean_filename($fname);
                   8267:         # See if there is anything left
                   8268:         next if ($fname eq '');
                   8269: 
                   8270:         # Check if file already exists as a file or directory.
                   8271:         my ($state,$msg);
                   8272:         if ($context eq 'portfolio') {
                   8273:             my $port_path = $dirpath;
                   8274:             if ($group ne '') {
                   8275:                 $port_path = "groups/$group/$port_path";
                   8276:             }
                   8277:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8278:                                               $dir_root,$port_path,$disk_quota,
                   8279:                                               $current_disk_usage,$uname,$udom);
                   8280:             if ($state eq 'will_exceed_quota'
                   8281:                 || $state eq 'file_locked'
                   8282:                 || $state eq 'file_exists' ) {
                   8283:                 $output .= $msg;
                   8284:                 next;
                   8285:             }
                   8286:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8287:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8288:             if ($state eq 'exists') {
                   8289:                 $output .= $msg;
                   8290:                 next;
                   8291:             }
                   8292:         }
                   8293:         # Check if extension is valid
                   8294:         if (($fname =~ /\.(\w+)$/) &&
                   8295:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8296:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8297:             next;
                   8298:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8299:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8300:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8301:             next;
                   8302:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8303:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8304:             next;
                   8305:         }
                   8306: 
                   8307:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8308:         if ($context eq 'portfolio') {
                   8309:             my $result=
                   8310:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8311:                                                 $dirpath.$path);
                   8312:             if ($result !~ m|^/uploaded/|) {
                   8313:                 $output .= '<span class="LC_error">'
                   8314:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8315:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8316:                       .'</span><br />';
                   8317:                 next;
                   8318:             } else {
                   8319:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8320:                            $path.$fname.'</span>').'</p>';     
                   8321:             }
                   8322:         } else {
                   8323: # Save the file
                   8324:             my $target = $env{'form.embedded_item_'.$i};
                   8325:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8326:             my $dest = $fullpath.$fname;
                   8327:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8328:             my @parts=split(/\//,$fullpath);
                   8329:             my $count;
                   8330:             my $filepath = $dir_root;
                   8331:             for ($count=4;$count<=$#parts;$count++) {
                   8332:                 $filepath .= "/$parts[$count]";
                   8333:                 if ((-e $filepath)!=1) {
                   8334:                     mkdir($filepath,0770);
                   8335:                 }
                   8336:             }
                   8337:             my $fh;
                   8338:             if (!open($fh,'>'.$dest)) {
                   8339:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8340:                 $output .= '<span class="LC_error">'.
                   8341:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8342:                            '</span><br />';
                   8343:             } else {
                   8344:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8345:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8346:                     $output .= '<span class="LC_error">'.
                   8347:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8348:                               '</span><br />';
                   8349:                 } else {
                   8350:                     if ($context eq 'testbank') {
                   8351:                         $output .= &mt('Embedded file uploaded successfully:').
                   8352:                                    '&nbsp;<a href="'.$url.'">'.
                   8353:                                    $orig_uploaded_filename.'</a><br />';
                   8354:                     } else {
1.705     tempelho 8355:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8356:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8357:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8358:                     }
                   8359:                 }
                   8360:                 close($fh);
                   8361:             }
                   8362:         }
                   8363:     }
                   8364:     return $output;
                   8365: }
                   8366: 
                   8367: sub check_for_existing {
                   8368:     my ($path,$fname,$element) = @_;
                   8369:     my ($state,$msg);
                   8370:     if (-d $path.'/'.$fname) {
                   8371:         $state = 'exists';
                   8372:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8373:     } elsif (-e $path.'/'.$fname) {
                   8374:         $state = 'exists';
                   8375:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8376:     }
                   8377:     if ($state eq 'exists') {
                   8378:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8379:     }
                   8380:     return ($state,$msg);
                   8381: }
                   8382: 
                   8383: sub check_for_upload {
                   8384:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8385:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8386:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8387:     my $getpropath = 1;
                   8388:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8389:                                             $getpropath);
                   8390:     my $found_file = 0;
                   8391:     my $locked_file = 0;
                   8392:     foreach my $line (@dir_list) {
                   8393:         my ($file_name)=split(/\&/,$line,2);
                   8394:         if ($file_name eq $fname){
                   8395:             $file_name = $path.$file_name;
                   8396:             if ($group ne '') {
                   8397:                 $file_name = $group.$file_name;
                   8398:             }
                   8399:             $found_file = 1;
                   8400:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8401:                 $locked_file = 1;
                   8402:             }
                   8403:         }
                   8404:     }
                   8405:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8406:         my $msg = '<span class="LC_error">'.
                   8407:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8408:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8409:         return ('will_exceed_quota',$msg);
                   8410:     } elsif ($found_file) {
                   8411:         if ($locked_file) {
                   8412:             my $msg = '<span class="LC_error">';
                   8413:             $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>');
                   8414:             $msg .= '</span><br />';
                   8415:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8416:             return ('file_locked',$msg);
                   8417:         } else {
                   8418:             my $msg = '<span class="LC_error">';
                   8419:             $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'});
                   8420:             $msg .= '</span>';
                   8421:             $msg .= '<br />';
                   8422:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8423:             return ('file_exists',$msg);
                   8424:         }
                   8425:     }
                   8426: }
                   8427: 
1.31      albertel 8428: 
1.41      ng       8429: =pod
1.45      matthew  8430: 
1.464     albertel 8431: =back
1.41      ng       8432: 
1.112     bowersj2 8433: =head1 CSV Upload/Handling functions
1.38      albertel 8434: 
1.41      ng       8435: =over 4
                   8436: 
1.648     raeburn  8437: =item * &upfile_store($r)
1.41      ng       8438: 
                   8439: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8440: needs $env{'form.upfile'}
1.41      ng       8441: returns $datatoken to be put into hidden field
                   8442: 
                   8443: =cut
1.31      albertel 8444: 
                   8445: sub upfile_store {
                   8446:     my $r=shift;
1.258     albertel 8447:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8448:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8449:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8450:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8451: 
1.258     albertel 8452:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8453: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8454:     {
1.158     raeburn  8455:         my $datafile = $r->dir_config('lonDaemons').
                   8456:                            '/tmp/'.$datatoken.'.tmp';
                   8457:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8458:             print $fh $env{'form.upfile'};
1.158     raeburn  8459:             close($fh);
                   8460:         }
1.31      albertel 8461:     }
                   8462:     return $datatoken;
                   8463: }
                   8464: 
1.56      matthew  8465: =pod
                   8466: 
1.648     raeburn  8467: =item * &load_tmp_file($r)
1.41      ng       8468: 
                   8469: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8470: needs $env{'form.datatoken'},
                   8471: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8472: 
                   8473: =cut
1.31      albertel 8474: 
                   8475: sub load_tmp_file {
                   8476:     my $r=shift;
                   8477:     my @studentdata=();
                   8478:     {
1.158     raeburn  8479:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8480:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8481:         if ( open(my $fh,"<$studentfile") ) {
                   8482:             @studentdata=<$fh>;
                   8483:             close($fh);
                   8484:         }
1.31      albertel 8485:     }
1.258     albertel 8486:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8487: }
                   8488: 
1.56      matthew  8489: =pod
                   8490: 
1.648     raeburn  8491: =item * &upfile_record_sep()
1.41      ng       8492: 
                   8493: Separate uploaded file into records
                   8494: returns array of records,
1.258     albertel 8495: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8496: 
                   8497: =cut
1.31      albertel 8498: 
                   8499: sub upfile_record_sep {
1.258     albertel 8500:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8501:     } else {
1.248     albertel 8502: 	my @records;
1.258     albertel 8503: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8504: 	    if ($line=~/^\s*$/) { next; }
                   8505: 	    push(@records,$line);
                   8506: 	}
                   8507: 	return @records;
1.31      albertel 8508:     }
                   8509: }
                   8510: 
1.56      matthew  8511: =pod
                   8512: 
1.648     raeburn  8513: =item * &record_sep($record)
1.41      ng       8514: 
1.258     albertel 8515: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8516: 
                   8517: =cut
                   8518: 
1.263     www      8519: sub takeleft {
                   8520:     my $index=shift;
                   8521:     return substr('0000'.$index,-4,4);
                   8522: }
                   8523: 
1.31      albertel 8524: sub record_sep {
                   8525:     my $record=shift;
                   8526:     my %components=();
1.258     albertel 8527:     if ($env{'form.upfiletype'} eq 'xml') {
                   8528:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8529:         my $i=0;
1.356     albertel 8530:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8531:             $field=~s/^(\"|\')//;
                   8532:             $field=~s/(\"|\')$//;
1.263     www      8533:             $components{&takeleft($i)}=$field;
1.31      albertel 8534:             $i++;
                   8535:         }
1.258     albertel 8536:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8537:         my $i=0;
1.356     albertel 8538:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8539:             $field=~s/^(\"|\')//;
                   8540:             $field=~s/(\"|\')$//;
1.263     www      8541:             $components{&takeleft($i)}=$field;
1.31      albertel 8542:             $i++;
                   8543:         }
                   8544:     } else {
1.561     www      8545:         my $separator=',';
1.480     banghart 8546:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8547:             $separator=';';
1.480     banghart 8548:         }
1.31      albertel 8549:         my $i=0;
1.561     www      8550: # the character we are looking for to indicate the end of a quote or a record 
                   8551:         my $looking_for=$separator;
                   8552: # do not add the characters to the fields
                   8553:         my $ignore=0;
                   8554: # we just encountered a separator (or the beginning of the record)
                   8555:         my $just_found_separator=1;
                   8556: # store the field we are working on here
                   8557:         my $field='';
                   8558: # work our way through all characters in record
                   8559:         foreach my $character ($record=~/(.)/g) {
                   8560:             if ($character eq $looking_for) {
                   8561:                if ($character ne $separator) {
                   8562: # Found the end of a quote, again looking for separator
                   8563:                   $looking_for=$separator;
                   8564:                   $ignore=1;
                   8565:                } else {
                   8566: # Found a separator, store away what we got
                   8567:                   $components{&takeleft($i)}=$field;
                   8568: 	          $i++;
                   8569:                   $just_found_separator=1;
                   8570:                   $ignore=0;
                   8571:                   $field='';
                   8572:                }
                   8573:                next;
                   8574:             }
                   8575: # single or double quotation marks after a separator indicate beginning of a quote
                   8576: # we are now looking for the end of the quote and need to ignore separators
                   8577:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8578:                $looking_for=$character;
                   8579:                next;
                   8580:             }
                   8581: # ignore would be true after we reached the end of a quote
                   8582:             if ($ignore) { next; }
                   8583:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8584:             $field.=$character;
                   8585:             $just_found_separator=0; 
1.31      albertel 8586:         }
1.561     www      8587: # catch the very last entry, since we never encountered the separator
                   8588:         $components{&takeleft($i)}=$field;
1.31      albertel 8589:     }
                   8590:     return %components;
                   8591: }
                   8592: 
1.144     matthew  8593: ######################################################
                   8594: ######################################################
                   8595: 
1.56      matthew  8596: =pod
                   8597: 
1.648     raeburn  8598: =item * &upfile_select_html()
1.41      ng       8599: 
1.144     matthew  8600: Return HTML code to select a file from the users machine and specify 
                   8601: the file type.
1.41      ng       8602: 
                   8603: =cut
                   8604: 
1.144     matthew  8605: ######################################################
                   8606: ######################################################
1.31      albertel 8607: sub upfile_select_html {
1.144     matthew  8608:     my %Types = (
                   8609:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8610:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8611:                  space => &mt('Space separated'),
                   8612:                  tab   => &mt('Tabulator separated'),
                   8613: #                 xml   => &mt('HTML/XML'),
                   8614:                  );
                   8615:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8616:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8617:     foreach my $type (sort(keys(%Types))) {
                   8618:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8619:     }
                   8620:     $Str .= "</select>\n";
                   8621:     return $Str;
1.31      albertel 8622: }
                   8623: 
1.301     albertel 8624: sub get_samples {
                   8625:     my ($records,$toget) = @_;
                   8626:     my @samples=({});
                   8627:     my $got=0;
                   8628:     foreach my $rec (@$records) {
                   8629: 	my %temp = &record_sep($rec);
                   8630: 	if (! grep(/\S/, values(%temp))) { next; }
                   8631: 	if (%temp) {
                   8632: 	    $samples[$got]=\%temp;
                   8633: 	    $got++;
                   8634: 	    if ($got == $toget) { last; }
                   8635: 	}
                   8636:     }
                   8637:     return \@samples;
                   8638: }
                   8639: 
1.144     matthew  8640: ######################################################
                   8641: ######################################################
                   8642: 
1.56      matthew  8643: =pod
                   8644: 
1.648     raeburn  8645: =item * &csv_print_samples($r,$records)
1.41      ng       8646: 
                   8647: Prints a table of sample values from each column uploaded $r is an
                   8648: Apache Request ref, $records is an arrayref from
                   8649: &Apache::loncommon::upfile_record_sep
                   8650: 
                   8651: =cut
                   8652: 
1.144     matthew  8653: ######################################################
                   8654: ######################################################
1.31      albertel 8655: sub csv_print_samples {
                   8656:     my ($r,$records) = @_;
1.662     bisitz   8657:     my $samples = &get_samples($records,5);
1.301     albertel 8658: 
1.594     raeburn  8659:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8660:               &start_data_table_header_row());
1.356     albertel 8661:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8662:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8663:     $r->print(&end_data_table_header_row());
1.301     albertel 8664:     foreach my $hash (@$samples) {
1.594     raeburn  8665: 	$r->print(&start_data_table_row());
1.356     albertel 8666: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8667: 	    $r->print('<td>');
1.356     albertel 8668: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8669: 	    $r->print('</td>');
                   8670: 	}
1.594     raeburn  8671: 	$r->print(&end_data_table_row());
1.31      albertel 8672:     }
1.594     raeburn  8673:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8674: }
                   8675: 
1.144     matthew  8676: ######################################################
                   8677: ######################################################
                   8678: 
1.56      matthew  8679: =pod
                   8680: 
1.648     raeburn  8681: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8682: 
                   8683: Prints a table to create associations between values and table columns.
1.144     matthew  8684: 
1.41      ng       8685: $r is an Apache Request ref,
                   8686: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8687: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8688: 
                   8689: =cut
                   8690: 
1.144     matthew  8691: ######################################################
                   8692: ######################################################
1.31      albertel 8693: sub csv_print_select_table {
                   8694:     my ($r,$records,$d) = @_;
1.301     albertel 8695:     my $i=0;
                   8696:     my $samples = &get_samples($records,1);
1.144     matthew  8697:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8698: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8699:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8700:               '<th>'.&mt('Column').'</th>'.
                   8701:               &end_data_table_header_row()."\n");
1.356     albertel 8702:     foreach my $array_ref (@$d) {
                   8703: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8704: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8705: 
1.875     bisitz   8706: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8707: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8708: 	$r->print('<option value="none"></option>');
1.356     albertel 8709: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8710: 	    $r->print('<option value="'.$sample.'"'.
                   8711:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8712:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8713: 	}
1.594     raeburn  8714: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8715: 	$i++;
                   8716:     }
1.594     raeburn  8717:     $r->print(&end_data_table());
1.31      albertel 8718:     $i--;
                   8719:     return $i;
                   8720: }
1.56      matthew  8721: 
1.144     matthew  8722: ######################################################
                   8723: ######################################################
                   8724: 
1.56      matthew  8725: =pod
1.31      albertel 8726: 
1.648     raeburn  8727: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8728: 
                   8729: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8730: 
                   8731: $r is an Apache Request ref,
                   8732: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8733: $d is an array of 2 element arrays (internal name, displayed name)
                   8734: 
                   8735: =cut
                   8736: 
1.144     matthew  8737: ######################################################
                   8738: ######################################################
1.31      albertel 8739: sub csv_samples_select_table {
                   8740:     my ($r,$records,$d) = @_;
                   8741:     my $i=0;
1.144     matthew  8742:     #
1.662     bisitz   8743:     my $max_samples = 5;
                   8744:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8745:     $r->print(&start_data_table().
                   8746:               &start_data_table_header_row().'<th>'.
                   8747:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8748:               &end_data_table_header_row());
1.301     albertel 8749: 
                   8750:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8751: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8752: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8753: 	foreach my $option (@$d) {
                   8754: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8755: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8756:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8757:                       $display.'</option>');
1.31      albertel 8758: 	}
                   8759: 	$r->print('</select></td><td>');
1.662     bisitz   8760: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8761: 	    if (defined($samples->[$line]{$key})) { 
                   8762: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8763: 	    }
                   8764: 	}
1.594     raeburn  8765: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8766: 	$i++;
                   8767:     }
1.594     raeburn  8768:     $r->print(&end_data_table());
1.31      albertel 8769:     $i--;
                   8770:     return($i);
1.115     matthew  8771: }
                   8772: 
1.144     matthew  8773: ######################################################
                   8774: ######################################################
                   8775: 
1.115     matthew  8776: =pod
                   8777: 
1.648     raeburn  8778: =item * &clean_excel_name($name)
1.115     matthew  8779: 
                   8780: Returns a replacement for $name which does not contain any illegal characters.
                   8781: 
                   8782: =cut
                   8783: 
1.144     matthew  8784: ######################################################
                   8785: ######################################################
1.115     matthew  8786: sub clean_excel_name {
                   8787:     my ($name) = @_;
                   8788:     $name =~ s/[:\*\?\/\\]//g;
                   8789:     if (length($name) > 31) {
                   8790:         $name = substr($name,0,31);
                   8791:     }
                   8792:     return $name;
1.25      albertel 8793: }
1.84      albertel 8794: 
1.85      albertel 8795: =pod
                   8796: 
1.648     raeburn  8797: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8798: 
                   8799: Returns either 1 or undef
                   8800: 
                   8801: 1 if the part is to be hidden, undef if it is to be shown
                   8802: 
                   8803: Arguments are:
                   8804: 
                   8805: $id the id of the part to be checked
                   8806: $symb, optional the symb of the resource to check
                   8807: $udom, optional the domain of the user to check for
                   8808: $uname, optional the username of the user to check for
                   8809: 
                   8810: =cut
1.84      albertel 8811: 
                   8812: sub check_if_partid_hidden {
                   8813:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8814:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8815: 					 $symb,$udom,$uname);
1.141     albertel 8816:     my $truth=1;
                   8817:     #if the string starts with !, then the list is the list to show not hide
                   8818:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8819:     my @hiddenlist=split(/,/,$hiddenparts);
                   8820:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8821: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8822:     }
1.141     albertel 8823:     return !$truth;
1.84      albertel 8824: }
1.127     matthew  8825: 
1.138     matthew  8826: 
                   8827: ############################################################
                   8828: ############################################################
                   8829: 
                   8830: =pod
                   8831: 
1.157     matthew  8832: =back 
                   8833: 
1.138     matthew  8834: =head1 cgi-bin script and graphing routines
                   8835: 
1.157     matthew  8836: =over 4
                   8837: 
1.648     raeburn  8838: =item * &get_cgi_id()
1.138     matthew  8839: 
                   8840: Inputs: none
                   8841: 
                   8842: Returns an id which can be used to pass environment variables
                   8843: to various cgi-bin scripts.  These environment variables will
                   8844: be removed from the users environment after a given time by
                   8845: the routine &Apache::lonnet::transfer_profile_to_env.
                   8846: 
                   8847: =cut
                   8848: 
                   8849: ############################################################
                   8850: ############################################################
1.152     albertel 8851: my $uniq=0;
1.136     matthew  8852: sub get_cgi_id {
1.154     albertel 8853:     $uniq=($uniq+1)%100000;
1.280     albertel 8854:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8855: }
                   8856: 
1.127     matthew  8857: ############################################################
                   8858: ############################################################
                   8859: 
                   8860: =pod
                   8861: 
1.648     raeburn  8862: =item * &DrawBarGraph()
1.127     matthew  8863: 
1.138     matthew  8864: Facilitates the plotting of data in a (stacked) bar graph.
                   8865: Puts plot definition data into the users environment in order for 
                   8866: graph.png to plot it.  Returns an <img> tag for the plot.
                   8867: The bars on the plot are labeled '1','2',...,'n'.
                   8868: 
                   8869: Inputs:
                   8870: 
                   8871: =over 4
                   8872: 
                   8873: =item $Title: string, the title of the plot
                   8874: 
                   8875: =item $xlabel: string, text describing the X-axis of the plot
                   8876: 
                   8877: =item $ylabel: string, text describing the Y-axis of the plot
                   8878: 
                   8879: =item $Max: scalar, the maximum Y value to use in the plot
                   8880: If $Max is < any data point, the graph will not be rendered.
                   8881: 
1.140     matthew  8882: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8883: they are plotted.  If undefined, default values will be used.
                   8884: 
1.178     matthew  8885: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8886: 
1.138     matthew  8887: =item @Values: An array of array references.  Each array reference holds data
                   8888: to be plotted in a stacked bar chart.
                   8889: 
1.239     matthew  8890: =item If the final element of @Values is a hash reference the key/value
                   8891: pairs will be added to the graph definition.
                   8892: 
1.138     matthew  8893: =back
                   8894: 
                   8895: Returns:
                   8896: 
                   8897: An <img> tag which references graph.png and the appropriate identifying
                   8898: information for the plot.
                   8899: 
1.127     matthew  8900: =cut
                   8901: 
                   8902: ############################################################
                   8903: ############################################################
1.134     matthew  8904: sub DrawBarGraph {
1.178     matthew  8905:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8906:     #
                   8907:     if (! defined($colors)) {
                   8908:         $colors = ['#33ff00', 
                   8909:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8910:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8911:                   ]; 
                   8912:     }
1.228     matthew  8913:     my $extra_settings = {};
                   8914:     if (ref($Values[-1]) eq 'HASH') {
                   8915:         $extra_settings = pop(@Values);
                   8916:     }
1.127     matthew  8917:     #
1.136     matthew  8918:     my $identifier = &get_cgi_id();
                   8919:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8920:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8921:         return '';
                   8922:     }
1.225     matthew  8923:     #
                   8924:     my @Labels;
                   8925:     if (defined($labels)) {
                   8926:         @Labels = @$labels;
                   8927:     } else {
                   8928:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8929:             push (@Labels,$i+1);
                   8930:         }
                   8931:     }
                   8932:     #
1.129     matthew  8933:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8934:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8935:     my %ValuesHash;
                   8936:     my $NumSets=1;
                   8937:     foreach my $array (@Values) {
                   8938:         next if (! ref($array));
1.136     matthew  8939:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  8940:             join(',',@$array);
1.129     matthew  8941:     }
1.127     matthew  8942:     #
1.136     matthew  8943:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  8944:     if ($NumBars < 3) {
                   8945:         $width = 120+$NumBars*32;
1.220     matthew  8946:         $xskip = 1;
1.225     matthew  8947:         $bar_width = 30;
                   8948:     } elsif ($NumBars < 5) {
                   8949:         $width = 120+$NumBars*20;
                   8950:         $xskip = 1;
                   8951:         $bar_width = 20;
1.220     matthew  8952:     } elsif ($NumBars < 10) {
1.136     matthew  8953:         $width = 120+$NumBars*15;
                   8954:         $xskip = 1;
                   8955:         $bar_width = 15;
                   8956:     } elsif ($NumBars <= 25) {
                   8957:         $width = 120+$NumBars*11;
                   8958:         $xskip = 5;
                   8959:         $bar_width = 8;
                   8960:     } elsif ($NumBars <= 50) {
                   8961:         $width = 120+$NumBars*8;
                   8962:         $xskip = 5;
                   8963:         $bar_width = 4;
                   8964:     } else {
                   8965:         $width = 120+$NumBars*8;
                   8966:         $xskip = 5;
                   8967:         $bar_width = 4;
                   8968:     }
                   8969:     #
1.137     matthew  8970:     $Max = 1 if ($Max < 1);
                   8971:     if ( int($Max) < $Max ) {
                   8972:         $Max++;
                   8973:         $Max = int($Max);
                   8974:     }
1.127     matthew  8975:     $Title  = '' if (! defined($Title));
                   8976:     $xlabel = '' if (! defined($xlabel));
                   8977:     $ylabel = '' if (! defined($ylabel));
1.369     www      8978:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   8979:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   8980:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  8981:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  8982:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   8983:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   8984:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   8985:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   8986:     $ValuesHash{$id.'.height'}   = $height;
                   8987:     $ValuesHash{$id.'.width'}    = $width;
                   8988:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   8989:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   8990:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  8991:     #
1.228     matthew  8992:     # Deal with other parameters
                   8993:     while (my ($key,$value) = each(%$extra_settings)) {
                   8994:         $ValuesHash{$id.'.'.$key} = $value;
                   8995:     }
                   8996:     #
1.646     raeburn  8997:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  8998:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   8999: }
                   9000: 
                   9001: ############################################################
                   9002: ############################################################
                   9003: 
                   9004: =pod
                   9005: 
1.648     raeburn  9006: =item * &DrawXYGraph()
1.137     matthew  9007: 
1.138     matthew  9008: Facilitates the plotting of data in an XY graph.
                   9009: Puts plot definition data into the users environment in order for 
                   9010: graph.png to plot it.  Returns an <img> tag for the plot.
                   9011: 
                   9012: Inputs:
                   9013: 
                   9014: =over 4
                   9015: 
                   9016: =item $Title: string, the title of the plot
                   9017: 
                   9018: =item $xlabel: string, text describing the X-axis of the plot
                   9019: 
                   9020: =item $ylabel: string, text describing the Y-axis of the plot
                   9021: 
                   9022: =item $Max: scalar, the maximum Y value to use in the plot
                   9023: If $Max is < any data point, the graph will not be rendered.
                   9024: 
                   9025: =item $colors: Array ref containing the hex color codes for the data to be 
                   9026: plotted in.  If undefined, default values will be used.
                   9027: 
                   9028: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9029: 
                   9030: =item $Ydata: Array ref containing Array refs.  
1.185     www      9031: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9032: 
                   9033: =item %Values: hash indicating or overriding any default values which are 
                   9034: passed to graph.png.  
                   9035: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9036: 
                   9037: =back
                   9038: 
                   9039: Returns:
                   9040: 
                   9041: An <img> tag which references graph.png and the appropriate identifying
                   9042: information for the plot.
                   9043: 
1.137     matthew  9044: =cut
                   9045: 
                   9046: ############################################################
                   9047: ############################################################
                   9048: sub DrawXYGraph {
                   9049:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9050:     #
                   9051:     # Create the identifier for the graph
                   9052:     my $identifier = &get_cgi_id();
                   9053:     my $id = 'cgi.'.$identifier;
                   9054:     #
                   9055:     $Title  = '' if (! defined($Title));
                   9056:     $xlabel = '' if (! defined($xlabel));
                   9057:     $ylabel = '' if (! defined($ylabel));
                   9058:     my %ValuesHash = 
                   9059:         (
1.369     www      9060:          $id.'.title'  => &escape($Title),
                   9061:          $id.'.xlabel' => &escape($xlabel),
                   9062:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9063:          $id.'.y_max_value'=> $Max,
                   9064:          $id.'.labels'     => join(',',@$Xlabels),
                   9065:          $id.'.PlotType'   => 'XY',
                   9066:          );
                   9067:     #
                   9068:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9069:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9070:     }
                   9071:     #
                   9072:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9073:         return '';
                   9074:     }
                   9075:     my $NumSets=1;
1.138     matthew  9076:     foreach my $array (@{$Ydata}){
1.137     matthew  9077:         next if (! ref($array));
                   9078:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9079:     }
1.138     matthew  9080:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9081:     #
                   9082:     # Deal with other parameters
                   9083:     while (my ($key,$value) = each(%Values)) {
                   9084:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9085:     }
                   9086:     #
1.646     raeburn  9087:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9088:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9089: }
                   9090: 
                   9091: ############################################################
                   9092: ############################################################
                   9093: 
                   9094: =pod
                   9095: 
1.648     raeburn  9096: =item * &DrawXYYGraph()
1.138     matthew  9097: 
                   9098: Facilitates the plotting of data in an XY graph with two Y axes.
                   9099: Puts plot definition data into the users environment in order for 
                   9100: graph.png to plot it.  Returns an <img> tag for the plot.
                   9101: 
                   9102: Inputs:
                   9103: 
                   9104: =over 4
                   9105: 
                   9106: =item $Title: string, the title of the plot
                   9107: 
                   9108: =item $xlabel: string, text describing the X-axis of the plot
                   9109: 
                   9110: =item $ylabel: string, text describing the Y-axis of the plot
                   9111: 
                   9112: =item $colors: Array ref containing the hex color codes for the data to be 
                   9113: plotted in.  If undefined, default values will be used.
                   9114: 
                   9115: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9116: 
                   9117: =item $Ydata1: The first data set
                   9118: 
                   9119: =item $Min1: The minimum value of the left Y-axis
                   9120: 
                   9121: =item $Max1: The maximum value of the left Y-axis
                   9122: 
                   9123: =item $Ydata2: The second data set
                   9124: 
                   9125: =item $Min2: The minimum value of the right Y-axis
                   9126: 
                   9127: =item $Max2: The maximum value of the left Y-axis
                   9128: 
                   9129: =item %Values: hash indicating or overriding any default values which are 
                   9130: passed to graph.png.  
                   9131: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9132: 
                   9133: =back
                   9134: 
                   9135: Returns:
                   9136: 
                   9137: An <img> tag which references graph.png and the appropriate identifying
                   9138: information for the plot.
1.136     matthew  9139: 
                   9140: =cut
                   9141: 
                   9142: ############################################################
                   9143: ############################################################
1.137     matthew  9144: sub DrawXYYGraph {
                   9145:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9146:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9147:     #
                   9148:     # Create the identifier for the graph
                   9149:     my $identifier = &get_cgi_id();
                   9150:     my $id = 'cgi.'.$identifier;
                   9151:     #
                   9152:     $Title  = '' if (! defined($Title));
                   9153:     $xlabel = '' if (! defined($xlabel));
                   9154:     $ylabel = '' if (! defined($ylabel));
                   9155:     my %ValuesHash = 
                   9156:         (
1.369     www      9157:          $id.'.title'  => &escape($Title),
                   9158:          $id.'.xlabel' => &escape($xlabel),
                   9159:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9160:          $id.'.labels' => join(',',@$Xlabels),
                   9161:          $id.'.PlotType' => 'XY',
                   9162:          $id.'.NumSets' => 2,
1.137     matthew  9163:          $id.'.two_axes' => 1,
                   9164:          $id.'.y1_max_value' => $Max1,
                   9165:          $id.'.y1_min_value' => $Min1,
                   9166:          $id.'.y2_max_value' => $Max2,
                   9167:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9168:          );
                   9169:     #
1.137     matthew  9170:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9171:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9172:     }
                   9173:     #
                   9174:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9175:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9176:         return '';
                   9177:     }
                   9178:     my $NumSets=1;
1.137     matthew  9179:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9180:         next if (! ref($array));
                   9181:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9182:     }
                   9183:     #
                   9184:     # Deal with other parameters
                   9185:     while (my ($key,$value) = each(%Values)) {
                   9186:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9187:     }
                   9188:     #
1.646     raeburn  9189:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9190:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9191: }
                   9192: 
                   9193: ############################################################
                   9194: ############################################################
                   9195: 
                   9196: =pod
                   9197: 
1.157     matthew  9198: =back 
                   9199: 
1.139     matthew  9200: =head1 Statistics helper routines?  
                   9201: 
                   9202: Bad place for them but what the hell.
                   9203: 
1.157     matthew  9204: =over 4
                   9205: 
1.648     raeburn  9206: =item * &chartlink()
1.139     matthew  9207: 
                   9208: Returns a link to the chart for a specific student.  
                   9209: 
                   9210: Inputs:
                   9211: 
                   9212: =over 4
                   9213: 
                   9214: =item $linktext: The text of the link
                   9215: 
                   9216: =item $sname: The students username
                   9217: 
                   9218: =item $sdomain: The students domain
                   9219: 
                   9220: =back
                   9221: 
1.157     matthew  9222: =back
                   9223: 
1.139     matthew  9224: =cut
                   9225: 
                   9226: ############################################################
                   9227: ############################################################
                   9228: sub chartlink {
                   9229:     my ($linktext, $sname, $sdomain) = @_;
                   9230:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9231:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9232:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9233:        '">'.$linktext.'</a>';
1.153     matthew  9234: }
                   9235: 
                   9236: #######################################################
                   9237: #######################################################
                   9238: 
                   9239: =pod
                   9240: 
                   9241: =head1 Course Environment Routines
1.157     matthew  9242: 
                   9243: =over 4
1.153     matthew  9244: 
1.648     raeburn  9245: =item * &restore_course_settings()
1.153     matthew  9246: 
1.648     raeburn  9247: =item * &store_course_settings()
1.153     matthew  9248: 
                   9249: Restores/Store indicated form parameters from the course environment.
                   9250: Will not overwrite existing values of the form parameters.
                   9251: 
                   9252: Inputs: 
                   9253: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9254: 
                   9255: a hash ref describing the data to be stored.  For example:
                   9256:    
                   9257: %Save_Parameters = ('Status' => 'scalar',
                   9258:     'chartoutputmode' => 'scalar',
                   9259:     'chartoutputdata' => 'scalar',
                   9260:     'Section' => 'array',
1.373     raeburn  9261:     'Group' => 'array',
1.153     matthew  9262:     'StudentData' => 'array',
                   9263:     'Maps' => 'array');
                   9264: 
                   9265: Returns: both routines return nothing
                   9266: 
1.631     raeburn  9267: =back
                   9268: 
1.153     matthew  9269: =cut
                   9270: 
                   9271: #######################################################
                   9272: #######################################################
                   9273: sub store_course_settings {
1.496     albertel 9274:     return &store_settings($env{'request.course.id'},@_);
                   9275: }
                   9276: 
                   9277: sub store_settings {
1.153     matthew  9278:     # save to the environment
                   9279:     # appenv the same items, just to be safe
1.300     albertel 9280:     my $udom  = $env{'user.domain'};
                   9281:     my $uname = $env{'user.name'};
1.496     albertel 9282:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9283:     my %SaveHash;
                   9284:     my %AppHash;
                   9285:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9286:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9287:         my $envname = 'environment.'.$basename;
1.258     albertel 9288:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9289:             # Save this value away
                   9290:             if ($type eq 'scalar' &&
1.258     albertel 9291:                 (! exists($env{$envname}) || 
                   9292:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9293:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9294:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9295:             } elsif ($type eq 'array') {
                   9296:                 my $stored_form;
1.258     albertel 9297:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9298:                     $stored_form = join(',',
                   9299:                                         map {
1.369     www      9300:                                             &escape($_);
1.258     albertel 9301:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9302:                 } else {
                   9303:                     $stored_form = 
1.369     www      9304:                         &escape($env{'form.'.$setting});
1.153     matthew  9305:                 }
                   9306:                 # Determine if the array contents are the same.
1.258     albertel 9307:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9308:                     $SaveHash{$basename} = $stored_form;
                   9309:                     $AppHash{$envname}   = $stored_form;
                   9310:                 }
                   9311:             }
                   9312:         }
                   9313:     }
                   9314:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9315:                                           $udom,$uname);
1.153     matthew  9316:     if ($put_result !~ /^(ok|delayed)/) {
                   9317:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9318:                                  'got error:'.$put_result);
                   9319:     }
                   9320:     # Make sure these settings stick around in this session, too
1.646     raeburn  9321:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9322:     return;
                   9323: }
                   9324: 
                   9325: sub restore_course_settings {
1.499     albertel 9326:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9327: }
                   9328: 
                   9329: sub restore_settings {
                   9330:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9331:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9332:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9333:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9334:             '.'.$setting;
1.258     albertel 9335:         if (exists($env{$envname})) {
1.153     matthew  9336:             if ($type eq 'scalar') {
1.258     albertel 9337:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9338:             } elsif ($type eq 'array') {
1.258     albertel 9339:                 $env{'form.'.$setting} = [ 
1.153     matthew  9340:                                            map { 
1.369     www      9341:                                                &unescape($_); 
1.258     albertel 9342:                                            } split(',',$env{$envname})
1.153     matthew  9343:                                            ];
                   9344:             }
                   9345:         }
                   9346:     }
1.127     matthew  9347: }
                   9348: 
1.618     raeburn  9349: #######################################################
                   9350: #######################################################
                   9351: 
                   9352: =pod
                   9353: 
                   9354: =head1 Domain E-mail Routines  
                   9355: 
                   9356: =over 4
                   9357: 
1.648     raeburn  9358: =item * &build_recipient_list()
1.618     raeburn  9359: 
1.884     raeburn  9360: Build recipient lists for five types of e-mail:
1.766     raeburn  9361: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9362: (d) Help requests, (e) Course requests needing approval,  generated by
                   9363: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9364: loncoursequeueadmin.pm respectively.
1.618     raeburn  9365: 
                   9366: Inputs:
1.619     raeburn  9367: defmail (scalar - email address of default recipient), 
1.618     raeburn  9368: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9369: defdom (domain for which to retrieve configuration settings),
                   9370: origmail (scalar - email address of recipient from loncapa.conf, 
                   9371: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9372: 
1.655     raeburn  9373: Returns: comma separated list of addresses to which to send e-mail.
                   9374: 
                   9375: =back
1.618     raeburn  9376: 
                   9377: =cut
                   9378: 
                   9379: ############################################################
                   9380: ############################################################
                   9381: sub build_recipient_list {
1.619     raeburn  9382:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9383:     my @recipients;
                   9384:     my $otheremails;
                   9385:     my %domconfig =
                   9386:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9387:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9388:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9389:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9390:                 my @contacts = ('adminemail','supportemail');
                   9391:                 foreach my $item (@contacts) {
                   9392:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9393:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9394:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9395:                             push(@recipients,$addr);
                   9396:                         }
1.619     raeburn  9397:                     }
1.766     raeburn  9398:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9399:                 }
                   9400:             }
1.766     raeburn  9401:         } elsif ($origmail ne '') {
                   9402:             push(@recipients,$origmail);
1.618     raeburn  9403:         }
1.619     raeburn  9404:     } elsif ($origmail ne '') {
                   9405:         push(@recipients,$origmail);
1.618     raeburn  9406:     }
1.688     raeburn  9407:     if (defined($defmail)) {
                   9408:         if ($defmail ne '') {
                   9409:             push(@recipients,$defmail);
                   9410:         }
1.618     raeburn  9411:     }
                   9412:     if ($otheremails) {
1.619     raeburn  9413:         my @others;
                   9414:         if ($otheremails =~ /,/) {
                   9415:             @others = split(/,/,$otheremails);
1.618     raeburn  9416:         } else {
1.619     raeburn  9417:             push(@others,$otheremails);
                   9418:         }
                   9419:         foreach my $addr (@others) {
                   9420:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9421:                 push(@recipients,$addr);
                   9422:             }
1.618     raeburn  9423:         }
                   9424:     }
1.619     raeburn  9425:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9426:     return $recipientlist;
                   9427: }
                   9428: 
1.127     matthew  9429: ############################################################
                   9430: ############################################################
1.154     albertel 9431: 
1.655     raeburn  9432: =pod
                   9433: 
                   9434: =head1 Course Catalog Routines
                   9435: 
                   9436: =over 4
                   9437: 
                   9438: =item * &gather_categories()
                   9439: 
                   9440: Converts category definitions - keys of categories hash stored in  
                   9441: coursecategories in configuration.db on the primary library server in a 
                   9442: domain - to an array.  Also generates javascript and idx hash used to 
                   9443: generate Domain Coordinator interface for editing Course Categories.
                   9444: 
                   9445: Inputs:
1.663     raeburn  9446: 
1.655     raeburn  9447: categories (reference to hash of category definitions).
1.663     raeburn  9448: 
1.655     raeburn  9449: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9450:       categories and subcategories).
1.663     raeburn  9451: 
1.655     raeburn  9452: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9453:       editing Course Categories).
1.663     raeburn  9454: 
1.655     raeburn  9455: jsarray (reference to array of categories used to create Javascript arrays for
                   9456:          Domain Coordinator interface for editing Course Categories).
                   9457: 
                   9458: Returns: nothing
                   9459: 
                   9460: Side effects: populates cats, idx and jsarray. 
                   9461: 
                   9462: =cut
                   9463: 
                   9464: sub gather_categories {
                   9465:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9466:     my %counters;
                   9467:     my $num = 0;
                   9468:     foreach my $item (keys(%{$categories})) {
                   9469:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9470:         if ($container eq '' && $depth == 0) {
                   9471:             $cats->[$depth][$categories->{$item}] = $cat;
                   9472:         } else {
                   9473:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9474:         }
                   9475:         my ($escitem,$tail) = split(/:/,$item,2);
                   9476:         if ($counters{$tail} eq '') {
                   9477:             $counters{$tail} = $num;
                   9478:             $num ++;
                   9479:         }
                   9480:         if (ref($idx) eq 'HASH') {
                   9481:             $idx->{$item} = $counters{$tail};
                   9482:         }
                   9483:         if (ref($jsarray) eq 'ARRAY') {
                   9484:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9485:         }
                   9486:     }
                   9487:     return;
                   9488: }
                   9489: 
                   9490: =pod
                   9491: 
                   9492: =item * &extract_categories()
                   9493: 
                   9494: Used to generate breadcrumb trails for course categories.
                   9495: 
                   9496: Inputs:
1.663     raeburn  9497: 
1.655     raeburn  9498: categories (reference to hash of category definitions).
1.663     raeburn  9499: 
1.655     raeburn  9500: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9501:       categories and subcategories).
1.663     raeburn  9502: 
1.655     raeburn  9503: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9504: 
1.655     raeburn  9505: allitems (reference to hash - key is category key 
                   9506:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9507: 
1.655     raeburn  9508: idx (reference to hash of counters used in Domain Coordinator interface for
                   9509:       editing Course Categories).
1.663     raeburn  9510: 
1.655     raeburn  9511: jsarray (reference to array of categories used to create Javascript arrays for
                   9512:          Domain Coordinator interface for editing Course Categories).
                   9513: 
1.665     raeburn  9514: subcats (reference to hash of arrays containing all subcategories within each 
                   9515:          category, -recursive)
                   9516: 
1.655     raeburn  9517: Returns: nothing
                   9518: 
                   9519: Side effects: populates trails and allitems hash references.
                   9520: 
                   9521: =cut
                   9522: 
                   9523: sub extract_categories {
1.665     raeburn  9524:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9525:     if (ref($categories) eq 'HASH') {
                   9526:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9527:         if (ref($cats->[0]) eq 'ARRAY') {
                   9528:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9529:                 my $name = $cats->[0][$i];
                   9530:                 my $item = &escape($name).'::0';
                   9531:                 my $trailstr;
                   9532:                 if ($name eq 'instcode') {
                   9533:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9534:                 } else {
                   9535:                     $trailstr = $name;
                   9536:                 }
                   9537:                 if ($allitems->{$item} eq '') {
                   9538:                     push(@{$trails},$trailstr);
                   9539:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9540:                 }
                   9541:                 my @parents = ($name);
                   9542:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9543:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9544:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9545:                         if (ref($subcats) eq 'HASH') {
                   9546:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9547:                         }
                   9548:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9549:                     }
                   9550:                 } else {
                   9551:                     if (ref($subcats) eq 'HASH') {
                   9552:                         $subcats->{$item} = [];
1.655     raeburn  9553:                     }
                   9554:                 }
                   9555:             }
                   9556:         }
                   9557:     }
                   9558:     return;
                   9559: }
                   9560: 
                   9561: =pod
                   9562: 
                   9563: =item *&recurse_categories()
                   9564: 
                   9565: Recursively used to generate breadcrumb trails for course categories.
                   9566: 
                   9567: Inputs:
1.663     raeburn  9568: 
1.655     raeburn  9569: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9570:       categories and subcategories).
1.663     raeburn  9571: 
1.655     raeburn  9572: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9573: 
                   9574: category (current course category, for which breadcrumb trail is being generated).
                   9575: 
                   9576: trails (reference to array of breadcrumb trails for each category).
                   9577: 
1.655     raeburn  9578: allitems (reference to hash - key is category key
                   9579:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9580: 
1.655     raeburn  9581: parents (array containing containers directories for current category, 
                   9582:          back to top level). 
                   9583: 
                   9584: Returns: nothing
                   9585: 
                   9586: Side effects: populates trails and allitems hash references
                   9587: 
                   9588: =cut
                   9589: 
                   9590: sub recurse_categories {
1.665     raeburn  9591:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9592:     my $shallower = $depth - 1;
                   9593:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9594:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9595:             my $name = $cats->[$depth]{$category}[$k];
                   9596:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9597:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9598:             if ($allitems->{$item} eq '') {
                   9599:                 push(@{$trails},$trailstr);
                   9600:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9601:             }
                   9602:             my $deeper = $depth+1;
                   9603:             push(@{$parents},$category);
1.665     raeburn  9604:             if (ref($subcats) eq 'HASH') {
                   9605:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9606:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9607:                     my $higher;
                   9608:                     if ($j > 0) {
                   9609:                         $higher = &escape($parents->[$j]).':'.
                   9610:                                   &escape($parents->[$j-1]).':'.$j;
                   9611:                     } else {
                   9612:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9613:                     }
                   9614:                     push(@{$subcats->{$higher}},$subcat);
                   9615:                 }
                   9616:             }
                   9617:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9618:                                 $subcats);
1.655     raeburn  9619:             pop(@{$parents});
                   9620:         }
                   9621:     } else {
                   9622:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9623:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9624:         if ($allitems->{$item} eq '') {
                   9625:             push(@{$trails},$trailstr);
                   9626:             $allitems->{$item} = scalar(@{$trails})-1;
                   9627:         }
                   9628:     }
                   9629:     return;
                   9630: }
                   9631: 
1.663     raeburn  9632: =pod
                   9633: 
                   9634: =item *&assign_categories_table()
                   9635: 
                   9636: Create a datatable for display of hierarchical categories in a domain,
                   9637: with checkboxes to allow a course to be categorized. 
                   9638: 
                   9639: Inputs:
                   9640: 
                   9641: cathash - reference to hash of categories defined for the domain (from
                   9642:           configuration.db)
                   9643: 
                   9644: currcat - scalar with an & separated list of categories assigned to a course. 
                   9645: 
                   9646: Returns: $output (markup to be displayed) 
                   9647: 
                   9648: =cut
                   9649: 
                   9650: sub assign_categories_table {
                   9651:     my ($cathash,$currcat) = @_;
                   9652:     my $output;
                   9653:     if (ref($cathash) eq 'HASH') {
                   9654:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9655:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9656:         $maxdepth = scalar(@cats);
                   9657:         if (@cats > 0) {
                   9658:             my $itemcount = 0;
                   9659:             if (ref($cats[0]) eq 'ARRAY') {
                   9660:                 $output = &Apache::loncommon::start_data_table();
                   9661:                 my @currcategories;
                   9662:                 if ($currcat ne '') {
                   9663:                     @currcategories = split('&',$currcat);
                   9664:                 }
                   9665:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9666:                     my $parent = $cats[0][$i];
                   9667:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9668:                     next if ($parent eq 'instcode');
                   9669:                     my $item = &escape($parent).'::0';
                   9670:                     my $checked = '';
                   9671:                     if (@currcategories > 0) {
                   9672:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9673:                             $checked = ' checked="checked"';
1.663     raeburn  9674:                         }
                   9675:                     }
1.675     raeburn  9676:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9677:                                '<input type="checkbox" name="usecategory" value="'.
                   9678:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9679:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9680:                     my $depth = 1;
                   9681:                     push(@path,$parent);
                   9682:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9683:                     pop(@path);
                   9684:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9685:                     $itemcount ++;
                   9686:                 }
                   9687:                 $output .= &Apache::loncommon::end_data_table();
                   9688:             }
                   9689:         }
                   9690:     }
                   9691:     return $output;
                   9692: }
                   9693: 
                   9694: =pod
                   9695: 
                   9696: =item *&assign_category_rows()
                   9697: 
                   9698: Create a datatable row for display of nested categories in a domain,
                   9699: with checkboxes to allow a course to be categorized,called recursively.
                   9700: 
                   9701: Inputs:
                   9702: 
                   9703: itemcount - track row number for alternating colors
                   9704: 
                   9705: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9706:       categories and subcategories.
                   9707: 
                   9708: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9709: 
                   9710: parent - parent of current category item
                   9711: 
                   9712: path - Array containing all categories back up through the hierarchy from the
                   9713:        current category to the top level.
                   9714: 
                   9715: currcategories - reference to array of current categories assigned to the course
                   9716: 
                   9717: Returns: $output (markup to be displayed).
                   9718: 
                   9719: =cut
                   9720: 
                   9721: sub assign_category_rows {
                   9722:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9723:     my ($text,$name,$item,$chgstr);
                   9724:     if (ref($cats) eq 'ARRAY') {
                   9725:         my $maxdepth = scalar(@{$cats});
                   9726:         if (ref($cats->[$depth]) eq 'HASH') {
                   9727:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9728:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9729:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9730:                 $text .= '<td><table class="LC_datatable">';
                   9731:                 for (my $j=0; $j<$numchildren; $j++) {
                   9732:                     $name = $cats->[$depth]{$parent}[$j];
                   9733:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9734:                     my $deeper = $depth+1;
                   9735:                     my $checked = '';
                   9736:                     if (ref($currcategories) eq 'ARRAY') {
                   9737:                         if (@{$currcategories} > 0) {
                   9738:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9739:                                 $checked = ' checked="checked"';
1.663     raeburn  9740:                             }
                   9741:                         }
                   9742:                     }
1.664     raeburn  9743:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9744:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9745:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9746:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9747:                              '</td><td>';
1.663     raeburn  9748:                     if (ref($path) eq 'ARRAY') {
                   9749:                         push(@{$path},$name);
                   9750:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9751:                         pop(@{$path});
                   9752:                     }
                   9753:                     $text .= '</td></tr>';
                   9754:                 }
                   9755:                 $text .= '</table></td>';
                   9756:             }
                   9757:         }
                   9758:     }
                   9759:     return $text;
                   9760: }
                   9761: 
1.655     raeburn  9762: ############################################################
                   9763: ############################################################
                   9764: 
                   9765: 
1.443     albertel 9766: sub commit_customrole {
1.664     raeburn  9767:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9768:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9769:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9770:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9771:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9772:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9773:                  '</b><br />';
                   9774:     return $output;
                   9775: }
                   9776: 
                   9777: sub commit_standardrole {
1.541     raeburn  9778:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9779:     my ($output,$logmsg,$linefeed);
                   9780:     if ($context eq 'auto') {
                   9781:         $linefeed = "\n";
                   9782:     } else {
                   9783:         $linefeed = "<br />\n";
                   9784:     }  
1.443     albertel 9785:     if ($three eq 'st') {
1.541     raeburn  9786:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9787:                                          $one,$two,$sec,$context);
                   9788:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9789:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9790:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9791:         } else {
1.541     raeburn  9792:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9793:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9794:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9795:             if ($context eq 'auto') {
                   9796:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9797:             } else {
                   9798:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9799:                &mt('Add to classlist').': <b>ok</b>';
                   9800:             }
                   9801:             $output .= $linefeed;
1.443     albertel 9802:         }
                   9803:     } else {
                   9804:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9805:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9806:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9807:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9808:         if ($context eq 'auto') {
                   9809:             $output .= $result.$linefeed;
                   9810:         } else {
                   9811:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9812:         }
1.443     albertel 9813:     }
                   9814:     return $output;
                   9815: }
                   9816: 
                   9817: sub commit_studentrole {
1.541     raeburn  9818:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9819:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9820:     if ($context eq 'auto') {
                   9821:         $linefeed = "\n";
                   9822:     } else {
                   9823:         $linefeed = '<br />'."\n";
                   9824:     }
1.443     albertel 9825:     if (defined($one) && defined($two)) {
                   9826:         my $cid=$one.'_'.$two;
                   9827:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9828:         my $secchange = 0;
                   9829:         my $expire_role_result;
                   9830:         my $modify_section_result;
1.628     raeburn  9831:         if ($oldsec ne '-1') { 
                   9832:             if ($oldsec ne $sec) {
1.443     albertel 9833:                 $secchange = 1;
1.628     raeburn  9834:                 my $now = time;
1.443     albertel 9835:                 my $uurl='/'.$cid;
                   9836:                 $uurl=~s/\_/\//g;
                   9837:                 if ($oldsec) {
                   9838:                     $uurl.='/'.$oldsec;
                   9839:                 }
1.626     raeburn  9840:                 $oldsecurl = $uurl;
1.628     raeburn  9841:                 $expire_role_result = 
1.652     raeburn  9842:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9843:                 if ($env{'request.course.sec'} ne '') { 
                   9844:                     if ($expire_role_result eq 'refused') {
                   9845:                         my @roles = ('st');
                   9846:                         my @statuses = ('previous');
                   9847:                         my @roledoms = ($one);
                   9848:                         my $withsec = 1;
                   9849:                         my %roleshash = 
                   9850:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9851:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9852:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9853:                             my ($oldstart,$oldend) = 
                   9854:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9855:                             if ($oldend > 0 && $oldend <= $now) {
                   9856:                                 $expire_role_result = 'ok';
                   9857:                             }
                   9858:                         }
                   9859:                     }
                   9860:                 }
1.443     albertel 9861:                 $result = $expire_role_result;
                   9862:             }
                   9863:         }
                   9864:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9865:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9866:             if ($modify_section_result =~ /^ok/) {
                   9867:                 if ($secchange == 1) {
1.628     raeburn  9868:                     if ($sec eq '') {
                   9869:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9870:                     } else {
                   9871:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9872:                     }
1.443     albertel 9873:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9874:                     if ($sec eq '') {
                   9875:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9876:                     } else {
                   9877:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9878:                     }
1.443     albertel 9879:                 } else {
1.628     raeburn  9880:                     if ($sec eq '') {
                   9881:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9882:                     } else {
                   9883:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9884:                     }
1.443     albertel 9885:                 }
                   9886:             } else {
1.628     raeburn  9887:                 if ($secchange) {       
                   9888:                     $$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;
                   9889:                 } else {
                   9890:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9891:                 }
1.443     albertel 9892:             }
                   9893:             $result = $modify_section_result;
                   9894:         } elsif ($secchange == 1) {
1.628     raeburn  9895:             if ($oldsec eq '') {
                   9896:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9897:             } else {
                   9898:                 $$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;
                   9899:             }
1.626     raeburn  9900:             if ($expire_role_result eq 'refused') {
                   9901:                 my $newsecurl = '/'.$cid;
                   9902:                 $newsecurl =~ s/\_/\//g;
                   9903:                 if ($sec ne '') {
                   9904:                     $newsecurl.='/'.$sec;
                   9905:                 }
                   9906:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9907:                     if ($sec eq '') {
                   9908:                         $$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;
                   9909:                     } else {
                   9910:                         $$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;
                   9911:                     }
                   9912:                 }
                   9913:             }
1.443     albertel 9914:         }
                   9915:     } else {
1.626     raeburn  9916:         $$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 9917:         $result = "error: incomplete course id\n";
                   9918:     }
                   9919:     return $result;
                   9920: }
                   9921: 
                   9922: ############################################################
                   9923: ############################################################
                   9924: 
1.566     albertel 9925: sub check_clone {
1.578     raeburn  9926:     my ($args,$linefeed) = @_;
1.566     albertel 9927:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9928:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9929:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9930:     my $clonemsg;
                   9931:     my $can_clone = 0;
1.908     raeburn  9932:     my $lctype = lc($args->{'type'});
                   9933:     if ($lctype ne 'community') {
                   9934:         $lctype = 'course';
                   9935:     }
1.566     albertel 9936:     if ($clonehome eq 'no_host') {
1.908     raeburn  9937:         if ($args->{'type'} eq 'Community') {
                   9938:             $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a non-existent community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   9939:         } else {
                   9940:             $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'});
                   9941:         }     
1.566     albertel 9942:     } else {
                   9943: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908     raeburn  9944:         if ($args->{'type'} eq 'Community') {
                   9945:             if ($clonedesc{'type'} ne 'Community') {
                   9946:                  $clonemsg = &mt('No new community created.').$linefeed.&mt('A new community could not be cloned from the specified original - [_1] - because it is a course not a community.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
                   9947:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9948:             }
                   9949:         }
1.882     raeburn  9950: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   9951:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 9952: 	    $can_clone = 1;
                   9953: 	} else {
                   9954: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   9955: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   9956: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  9957:             if (grep(/^\*$/,@cloners)) {
                   9958:                 $can_clone = 1;
                   9959:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   9960:                 $can_clone = 1;
                   9961:             } else {
1.908     raeburn  9962:                 my $ccrole = 'cc';
                   9963:                 if ($args->{'type'} eq 'Community') {
                   9964:                     $ccrole = 'co';
                   9965:                 }
1.578     raeburn  9966: 	        my %roleshash =
                   9967: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   9968: 					 $args->{'ccdomain'},
1.908     raeburn  9969:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  9970: 					 [$args->{'clonedomain'}]);
1.908     raeburn  9971: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  9972: 		    $can_clone = 1;
                   9973: 	        } else {
1.908     raeburn  9974:                     if ($args->{'type'} eq 'Community') {
                   9975:                         $clonemsg = &mt('No new community created.').$linefeed.&mt('The new community could not be cloned from the existing community because the new community owner ([_1]) does not have cloning rights in the existing community ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
                   9976:                     } else {
                   9977:                         $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'});
                   9978:                     }
1.578     raeburn  9979: 	        }
1.566     albertel 9980: 	    }
1.578     raeburn  9981:         }
1.566     albertel 9982:     }
                   9983:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9984: }
                   9985: 
1.444     albertel 9986: sub construct_course {
1.885     raeburn  9987:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 9988:     my $outcome;
1.541     raeburn  9989:     my $linefeed =  '<br />'."\n";
                   9990:     if ($context eq 'auto') {
                   9991:         $linefeed = "\n";
                   9992:     }
1.566     albertel 9993: 
                   9994: #
                   9995: # Are we cloning?
                   9996: #
                   9997:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   9998:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  9999: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10000: 	if ($context ne 'auto') {
1.578     raeburn  10001:             if ($clonemsg ne '') {
                   10002: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10003:             }
1.566     albertel 10004: 	}
                   10005: 	$outcome .= $clonemsg.$linefeed;
                   10006: 
                   10007:         if (!$can_clone) {
                   10008: 	    return (0,$outcome);
                   10009: 	}
                   10010:     }
                   10011: 
1.444     albertel 10012: #
                   10013: # Open course
                   10014: #
                   10015:     my $crstype = lc($args->{'crstype'});
                   10016:     my %cenv=();
                   10017:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10018:                                              $args->{'cdescr'},
                   10019:                                              $args->{'curl'},
                   10020:                                              $args->{'course_home'},
                   10021:                                              $args->{'nonstandard'},
                   10022:                                              $args->{'crscode'},
                   10023:                                              $args->{'ccuname'}.':'.
                   10024:                                              $args->{'ccdomain'},
1.882     raeburn  10025:                                              $args->{'crstype'},
1.885     raeburn  10026:                                              $cnum,$context,$category);
1.444     albertel 10027: 
                   10028:     # Note: The testing routines depend on this being output; see 
                   10029:     # Utils::Course. This needs to at least be output as a comment
                   10030:     # if anyone ever decides to not show this, and Utils::Course::new
                   10031:     # will need to be suitably modified.
1.541     raeburn  10032:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10033: #
                   10034: # Check if created correctly
                   10035: #
1.479     albertel 10036:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10037:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10038:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10039: 
1.444     albertel 10040: #
1.566     albertel 10041: # Do the cloning
                   10042: #   
                   10043:     if ($can_clone && $cloneid) {
                   10044: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10045: 	if ($context ne 'auto') {
                   10046: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10047: 	}
                   10048: 	$outcome .= $clonemsg.$linefeed;
                   10049: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10050: # Copy all files
1.637     www      10051: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10052: # Restore URL
1.566     albertel 10053: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10054: # Restore title
1.566     albertel 10055: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10056: # Mark as cloned
1.566     albertel 10057: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10058: # Need to clone grading mode
                   10059:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10060:         $cenv{'grading'}=$newenv{'grading'};
                   10061: # Do not clone these environment entries
                   10062:         &Apache::lonnet::del('environment',
                   10063:                   ['default_enrollment_start_date',
                   10064:                    'default_enrollment_end_date',
                   10065:                    'question.email',
                   10066:                    'policy.email',
                   10067:                    'comment.email',
                   10068:                    'pch.users.denied',
1.725     raeburn  10069:                    'plc.users.denied',
                   10070:                    'hidefromcat',
                   10071:                    'categories'],
1.638     www      10072:                    $$crsudom,$$crsunum);
1.444     albertel 10073:     }
1.566     albertel 10074: 
1.444     albertel 10075: #
                   10076: # Set environment (will override cloned, if existing)
                   10077: #
                   10078:     my @sections = ();
                   10079:     my @xlists = ();
                   10080:     if ($args->{'crstype'}) {
                   10081:         $cenv{'type'}=$args->{'crstype'};
                   10082:     }
                   10083:     if ($args->{'crsid'}) {
                   10084:         $cenv{'courseid'}=$args->{'crsid'};
                   10085:     }
                   10086:     if ($args->{'crscode'}) {
                   10087:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10088:     }
                   10089:     if ($args->{'crsquota'} ne '') {
                   10090:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10091:     } else {
                   10092:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10093:     }
                   10094:     if ($args->{'ccuname'}) {
                   10095:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10096:                                         ':'.$args->{'ccdomain'};
                   10097:     } else {
                   10098:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10099:     }
                   10100:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10101:     if ($args->{'crssections'}) {
                   10102:         $cenv{'internal.sectionnums'} = '';
                   10103:         if ($args->{'crssections'} =~ m/,/) {
                   10104:             @sections = split/,/,$args->{'crssections'};
                   10105:         } else {
                   10106:             $sections[0] = $args->{'crssections'};
                   10107:         }
                   10108:         if (@sections > 0) {
                   10109:             foreach my $item (@sections) {
                   10110:                 my ($sec,$gp) = split/:/,$item;
                   10111:                 my $class = $args->{'crscode'}.$sec;
                   10112:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10113:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10114:                 unless ($addcheck eq 'ok') {
                   10115:                     push @badclasses, $class;
                   10116:                 }
                   10117:             }
                   10118:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10119:         }
                   10120:     }
                   10121: # do not hide course coordinator from staff listing, 
                   10122: # even if privileged
                   10123:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10124: # add crosslistings
                   10125:     if ($args->{'crsxlist'}) {
                   10126:         $cenv{'internal.crosslistings'}='';
                   10127:         if ($args->{'crsxlist'} =~ m/,/) {
                   10128:             @xlists = split/,/,$args->{'crsxlist'};
                   10129:         } else {
                   10130:             $xlists[0] = $args->{'crsxlist'};
                   10131:         }
                   10132:         if (@xlists > 0) {
                   10133:             foreach my $item (@xlists) {
                   10134:                 my ($xl,$gp) = split/:/,$item;
                   10135:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10136:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10137:                 unless ($addcheck eq 'ok') {
                   10138:                     push @badclasses, $xl;
                   10139:                 }
                   10140:             }
                   10141:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10142:         }
                   10143:     }
                   10144:     if ($args->{'autoadds'}) {
                   10145:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10146:     }
                   10147:     if ($args->{'autodrops'}) {
                   10148:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10149:     }
                   10150: # check for notification of enrollment changes
                   10151:     my @notified = ();
                   10152:     if ($args->{'notify_owner'}) {
                   10153:         if ($args->{'ccuname'} ne '') {
                   10154:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10155:         }
                   10156:     }
                   10157:     if ($args->{'notify_dc'}) {
                   10158:         if ($uname ne '') { 
1.630     raeburn  10159:             push(@notified,$uname.':'.$udom);
1.444     albertel 10160:         }
                   10161:     }
                   10162:     if (@notified > 0) {
                   10163:         my $notifylist;
                   10164:         if (@notified > 1) {
                   10165:             $notifylist = join(',',@notified);
                   10166:         } else {
                   10167:             $notifylist = $notified[0];
                   10168:         }
                   10169:         $cenv{'internal.notifylist'} = $notifylist;
                   10170:     }
                   10171:     if (@badclasses > 0) {
                   10172:         my %lt=&Apache::lonlocal::texthash(
                   10173:                 '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',
                   10174:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10175:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10176:         );
1.541     raeburn  10177:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10178:                            ' ('.$lt{'adby'}.')';
                   10179:         if ($context eq 'auto') {
                   10180:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10181:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10182:             foreach my $item (@badclasses) {
                   10183:                 if ($context eq 'auto') {
                   10184:                     $outcome .= " - $item\n";
                   10185:                 } else {
                   10186:                     $outcome .= "<li>$item</li>\n";
                   10187:                 }
                   10188:             }
                   10189:             if ($context eq 'auto') {
                   10190:                 $outcome .= $linefeed;
                   10191:             } else {
1.566     albertel 10192:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10193:             }
                   10194:         } 
1.444     albertel 10195:     }
                   10196:     if ($args->{'no_end_date'}) {
                   10197:         $args->{'endaccess'} = 0;
                   10198:     }
                   10199:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10200:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10201:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10202:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10203:     if ($args->{'showphotos'}) {
                   10204:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10205:     }
                   10206:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10207:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10208:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10209:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10210:             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'); 
                   10211:             if ($context eq 'auto') {
                   10212:                 $outcome .= $krb_msg;
                   10213:             } else {
1.566     albertel 10214:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10215:             }
                   10216:             $outcome .= $linefeed;
1.444     albertel 10217:         }
                   10218:     }
                   10219:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10220:        if ($args->{'setpolicy'}) {
                   10221:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10222:        }
                   10223:        if ($args->{'setcontent'}) {
                   10224:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10225:        }
                   10226:     }
                   10227:     if ($args->{'reshome'}) {
                   10228: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10229: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10230:     }
                   10231: #
                   10232: # course has keyed access
                   10233: #
                   10234:     if ($args->{'setkeys'}) {
                   10235:        $cenv{'keyaccess'}='yes';
                   10236:     }
                   10237: # if specified, key authority is not course, but user
                   10238: # only active if keyaccess is yes
                   10239:     if ($args->{'keyauth'}) {
1.487     albertel 10240: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10241: 	$user = &LONCAPA::clean_username($user);
                   10242: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10243: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10244: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10245: 	}
                   10246:     }
                   10247: 
                   10248:     if ($args->{'disresdis'}) {
                   10249:         $cenv{'pch.roles.denied'}='st';
                   10250:     }
                   10251:     if ($args->{'disablechat'}) {
                   10252:         $cenv{'plc.roles.denied'}='st';
                   10253:     }
                   10254: 
                   10255:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10256:     # course
                   10257:     $cenv{'course.helper.not.run'} = 1;
                   10258:     #
                   10259:     # Use new Randomseed
                   10260:     #
                   10261:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10262:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10263:     #
                   10264:     # The encryption code and receipt prefix for this course
                   10265:     #
                   10266:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10267:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10268:     #
                   10269:     # By default, use standard grading
                   10270:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10271: 
1.541     raeburn  10272:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10273:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10274: #
                   10275: # Open all assignments
                   10276: #
                   10277:     if ($args->{'openall'}) {
                   10278:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10279:        my %storecontent = ($storeunder         => time,
                   10280:                            $storeunder.'.type' => 'date_start');
                   10281:        
                   10282:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10283:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10284:    }
                   10285: #
                   10286: # Set first page
                   10287: #
                   10288:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10289: 	    || ($cloneid)) {
1.445     albertel 10290: 	use LONCAPA::map;
1.444     albertel 10291: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10292: 
                   10293: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10294:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10295: 
1.444     albertel 10296:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10297:         my $title; my $url;
                   10298:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10299: 	    $title=&mt('Syllabus');
1.444     albertel 10300:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10301:         } else {
1.690     bisitz   10302:             $title=&mt('Navigate Contents');
1.444     albertel 10303:             $url='/adm/navmaps';
                   10304:         }
1.445     albertel 10305: 
                   10306:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10307: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10308: 
                   10309: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10310:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10311:     }
1.566     albertel 10312: 
                   10313:     return (1,$outcome);
1.444     albertel 10314: }
                   10315: 
                   10316: ############################################################
                   10317: ############################################################
                   10318: 
1.378     raeburn  10319: sub course_type {
                   10320:     my ($cid) = @_;
                   10321:     if (!defined($cid)) {
                   10322:         $cid = $env{'request.course.id'};
                   10323:     }
1.404     albertel 10324:     if (defined($env{'course.'.$cid.'.type'})) {
                   10325:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10326:     } else {
                   10327:         return 'Course';
1.377     raeburn  10328:     }
                   10329: }
1.156     albertel 10330: 
1.406     raeburn  10331: sub group_term {
                   10332:     my $crstype = &course_type();
                   10333:     my %names = (
                   10334:                   'Course' => 'group',
1.865     raeburn  10335:                   'Community' => 'group',
1.406     raeburn  10336:                 );
                   10337:     return $names{$crstype};
                   10338: }
                   10339: 
1.902     raeburn  10340: sub course_types {
                   10341:     my @types = ('official','unofficial','community');
                   10342:     my %typename = (
                   10343:                          official   => 'Official course',
                   10344:                          unofficial => 'Unofficial course',
                   10345:                          community  => 'Community',
                   10346:                    );
                   10347:     return (\@types,\%typename);
                   10348: }
                   10349: 
1.156     albertel 10350: sub icon {
                   10351:     my ($file)=@_;
1.505     albertel 10352:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10353:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10354:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10355:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10356: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10357: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10358: 	            $curfext.".gif") {
                   10359: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10360: 		$curfext.".gif";
                   10361: 	}
                   10362:     }
1.249     albertel 10363:     return &lonhttpdurl($iconname);
1.154     albertel 10364: } 
1.84      albertel 10365: 
1.575     albertel 10366: sub lonhttpdurl {
1.692     www      10367: #
                   10368: # Had been used for "small fry" static images on separate port 8080.
                   10369: # Modify here if lightweight http functionality desired again.
                   10370: # Currently eliminated due to increasing firewall issues.
                   10371: #
1.575     albertel 10372:     my ($url)=@_;
1.692     www      10373:     return $url;
1.215     albertel 10374: }
                   10375: 
1.213     albertel 10376: sub connection_aborted {
                   10377:     my ($r)=@_;
                   10378:     $r->print(" ");$r->rflush();
                   10379:     my $c = $r->connection;
                   10380:     return $c->aborted();
                   10381: }
                   10382: 
1.221     foxr     10383: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10384: #    strings as 'strings'.
                   10385: sub escape_single {
1.221     foxr     10386:     my ($input) = @_;
1.223     albertel 10387:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10388:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10389:     return $input;
                   10390: }
1.223     albertel 10391: 
1.222     foxr     10392: #  Same as escape_single, but escape's "'s  This 
                   10393: #  can be used for  "strings"
                   10394: sub escape_double {
                   10395:     my ($input) = @_;
                   10396:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10397:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10398:     return $input;
                   10399: }
1.223     albertel 10400:  
1.222     foxr     10401: #   Escapes the last element of a full URL.
                   10402: sub escape_url {
                   10403:     my ($url)   = @_;
1.238     raeburn  10404:     my @urlslices = split(/\//, $url,-1);
1.369     www      10405:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10406:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10407: }
1.462     albertel 10408: 
1.820     raeburn  10409: sub compare_arrays {
                   10410:     my ($arrayref1,$arrayref2) = @_;
                   10411:     my (@difference,%count);
                   10412:     @difference = ();
                   10413:     %count = ();
                   10414:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10415:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10416:         foreach my $element (keys(%count)) {
                   10417:             if ($count{$element} == 1) {
                   10418:                 push(@difference,$element);
                   10419:             }
                   10420:         }
                   10421:     }
                   10422:     return @difference;
                   10423: }
                   10424: 
1.817     bisitz   10425: # -------------------------------------------------------- Initialize user login
1.462     albertel 10426: sub init_user_environment {
1.463     albertel 10427:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10428:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10429: 
                   10430:     my $public=($username eq 'public' && $domain eq 'public');
                   10431: 
                   10432: # See if old ID present, if so, remove
                   10433: 
                   10434:     my ($filename,$cookie,$userroles);
                   10435:     my $now=time;
                   10436: 
                   10437:     if ($public) {
                   10438: 	my $max_public=100;
                   10439: 	my $oldest;
                   10440: 	my $oldest_time=0;
                   10441: 	for(my $next=1;$next<=$max_public;$next++) {
                   10442: 	    if (-e $lonids."/publicuser_$next.id") {
                   10443: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10444: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10445: 		    $oldest_time=$mtime;
                   10446: 		    $oldest=$next;
                   10447: 		}
                   10448: 	    } else {
                   10449: 		$cookie="publicuser_$next";
                   10450: 		last;
                   10451: 	    }
                   10452: 	}
                   10453: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10454:     } else {
1.463     albertel 10455: 	# if this isn't a robot, kill any existing non-robot sessions
                   10456: 	if (!$args->{'robot'}) {
                   10457: 	    opendir(DIR,$lonids);
                   10458: 	    while ($filename=readdir(DIR)) {
                   10459: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10460: 		    unlink($lonids.'/'.$filename);
                   10461: 		}
1.462     albertel 10462: 	    }
1.463     albertel 10463: 	    closedir(DIR);
1.462     albertel 10464: 	}
                   10465: # Give them a new cookie
1.463     albertel 10466: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10467: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10468: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10469:     
                   10470: # Initialize roles
                   10471: 
                   10472: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10473:     }
                   10474: # ------------------------------------ Check browser type and MathML capability
                   10475: 
                   10476:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10477:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10478: 
                   10479: # ------------------------------------------------------------- Get environment
                   10480: 
                   10481:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10482:     my ($tmp) = keys(%userenv);
                   10483:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10484: 	# default remote control to off
                   10485: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10486:     } else {
                   10487: 	undef(%userenv);
                   10488:     }
                   10489:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10490: 	$form->{'interface'}=$userenv{'interface'};
                   10491:     }
                   10492:     $env{'environment.remote'}=$userenv{'remote'};
                   10493:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10494: 
                   10495: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10496:     foreach my $option ('interface','localpath','localres') {
                   10497:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10498:     }
                   10499: # --------------------------------------------------------- Write first profile
                   10500: 
                   10501:     {
                   10502: 	my %initial_env = 
                   10503: 	    ("user.name"          => $username,
                   10504: 	     "user.domain"        => $domain,
                   10505: 	     "user.home"          => $authhost,
                   10506: 	     "browser.type"       => $clientbrowser,
                   10507: 	     "browser.version"    => $clientversion,
                   10508: 	     "browser.mathml"     => $clientmathml,
                   10509: 	     "browser.unicode"    => $clientunicode,
                   10510: 	     "browser.os"         => $clientos,
                   10511: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10512: 	     "request.course.fn"  => '',
                   10513: 	     "request.course.uri" => '',
                   10514: 	     "request.course.sec" => '',
                   10515: 	     "request.role"       => 'cm',
                   10516: 	     "request.role.adv"   => $env{'user.adv'},
                   10517: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10518: 
                   10519:         if ($form->{'localpath'}) {
                   10520: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10521: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10522:         }
                   10523: 	
                   10524: 	if ($public) {
                   10525: 	    $initial_env{"environment.remote"} = "off";
                   10526: 	}
                   10527: 	if ($form->{'interface'}) {
                   10528: 	    $form->{'interface'}=~s/\W//gs;
                   10529: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10530: 	    $env{'browser.interface'}=$form->{'interface'};
                   10531: 	}
                   10532: 
1.724     raeburn  10533:         foreach my $tool ('aboutme','blog','portfolio') {
                   10534:             $userenv{'availabletools.'.$tool} = 
                   10535:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10536:         }
                   10537: 
1.864     raeburn  10538:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10539:             $userenv{'canrequest.'.$crstype} =
                   10540:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10541:                                                   'reload','requestcourses');
                   10542:         }
                   10543: 
1.462     albertel 10544: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10545: 	
                   10546: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10547: 		 &GDBM_WRCREAT(),0640)) {
                   10548: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10549: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10550: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10551: 	    if (ref($args->{'extra_env'})) {
                   10552: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10553: 	    }
1.462     albertel 10554: 	    untie(%disk_env);
                   10555: 	} else {
1.705     tempelho 10556: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10557: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10558: 	    return 'error: '.$!;
                   10559: 	}
                   10560:     }
                   10561:     $env{'request.role'}='cm';
                   10562:     $env{'request.role.adv'}=$env{'user.adv'};
                   10563:     $env{'browser.type'}=$clientbrowser;
                   10564: 
                   10565:     return $cookie;
                   10566: 
                   10567: }
                   10568: 
                   10569: sub _add_to_env {
                   10570:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10571:     if (ref($env_data) eq 'HASH') {
                   10572:         while (my ($key,$value) = each(%$env_data)) {
                   10573: 	    $idf->{$prefix.$key} = $value;
                   10574: 	    $env{$prefix.$key}   = $value;
                   10575:         }
1.462     albertel 10576:     }
                   10577: }
                   10578: 
1.685     tempelho 10579: # --- Get the symbolic name of a problem and the url
                   10580: sub get_symb {
                   10581:     my ($request,$silent) = @_;
1.726     raeburn  10582:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10583:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10584:     if ($symb eq '') {
                   10585:         if (!$silent) {
                   10586:             $request->print("Unable to handle ambiguous references:$url:.");
                   10587:             return ();
                   10588:         }
                   10589:     }
                   10590:     &Apache::lonenc::check_decrypt(\$symb);
                   10591:     return ($symb);
                   10592: }
                   10593: 
                   10594: # --------------------------------------------------------------Get annotation
                   10595: 
                   10596: sub get_annotation {
                   10597:     my ($symb,$enc) = @_;
                   10598: 
                   10599:     my $key = $symb;
                   10600:     if (!$enc) {
                   10601:         $key =
                   10602:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10603:     }
                   10604:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10605:     return $annotation{$key};
                   10606: }
                   10607: 
                   10608: sub clean_symb {
1.731     raeburn  10609:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10610: 
                   10611:     &Apache::lonenc::check_decrypt(\$symb);
                   10612:     my $enc = $env{'request.enc'};
1.731     raeburn  10613:     if ($delete_enc) {
1.730     raeburn  10614:         delete($env{'request.enc'});
                   10615:     }
1.685     tempelho 10616: 
                   10617:     return ($symb,$enc);
                   10618: }
1.462     albertel 10619: 
1.41      ng       10620: =pod
                   10621: 
                   10622: =back
                   10623: 
1.112     bowersj2 10624: =cut
1.41      ng       10625: 
1.112     bowersj2 10626: 1;
                   10627: __END__;
1.41      ng       10628: 

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