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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.914   ! faziophi    4: # $Id: loncommon.pm,v 1.913 2009/11/10 13:58:55 droeschl 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.911     bisitz   4719:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4720: 
1.608     albertel 4721:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     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 {
1.911     bisitz   4728:   font-family: $sans;
                   4729:   line-height:130%;
                   4730:   font-size:0.83em;
                   4731:   color:$font;
1.795     www      4732: }
                   4733: 
1.911     bisitz   4734: a:link,
                   4735: a:visited {
                   4736:   font-size:100%;
1.795     www      4737: }
                   4738: 
1.911     bisitz   4739: a:focus {
1.795     www      4740:   color: red;
1.911     bisitz   4741:   background: yellow;
1.795     www      4742: }
1.698     harmsja  4743: 
1.911     bisitz   4744: form, .inline {
                   4745:   display: inline;
1.795     www      4746: }
1.721     harmsja  4747: 
1.795     www      4748: .LC_right {
1.911     bisitz   4749:   text-align:right;
1.795     www      4750: }
                   4751: 
                   4752: .LC_middle {
1.911     bisitz   4753:   vertical-align:middle;
1.795     www      4754: }
1.721     harmsja  4755: 
                   4756: /* just for tests */
1.911     bisitz   4757: .LC_400Box {
                   4758:   width:400px;
                   4759: }
1.721     harmsja  4760: /* end */
                   4761: 
1.778     bisitz   4762: .LC_filename {
                   4763:   font-family: $mono;
                   4764:   white-space:pre;
                   4765: }
                   4766: 
                   4767: .LC_fileicon {
                   4768:   border: none;
                   4769:   height: 1.3em;
                   4770:   vertical-align: text-bottom;
                   4771:   margin-right: 0.3em;
                   4772:   text-decoration:none;
                   4773: }
                   4774: 
1.350     albertel 4775: .LC_error {
                   4776:   color: red;
                   4777:   font-size: larger;
                   4778: }
1.795     www      4779: 
1.457     albertel 4780: .LC_warning,
                   4781: .LC_diff_removed {
1.733     bisitz   4782:   color: red;
1.394     albertel 4783: }
1.532     albertel 4784: 
                   4785: .LC_info,
1.457     albertel 4786: .LC_success,
                   4787: .LC_diff_added {
1.350     albertel 4788:   color: green;
                   4789: }
1.795     www      4790: 
1.802     bisitz   4791: div.LC_confirm_box {
                   4792:   background-color: #FAFAFA;
                   4793:   border: 1px solid $lg_border_color;
                   4794:   margin-right: 0;
                   4795:   padding: 5px;
                   4796: }
                   4797: 
                   4798: div.LC_confirm_box .LC_error img,
                   4799: div.LC_confirm_box .LC_success img {
                   4800:   vertical-align: middle;
                   4801: }
                   4802: 
1.440     albertel 4803: .LC_icon {
1.771     droeschl 4804:   border: none;
1.790     droeschl 4805:   vertical-align: middle;
1.771     droeschl 4806: }
                   4807: 
1.543     albertel 4808: .LC_docs_spacer {
                   4809:   width: 25px;
                   4810:   height: 1px;
1.771     droeschl 4811:   border: none;
1.543     albertel 4812: }
1.346     albertel 4813: 
1.532     albertel 4814: .LC_internal_info {
1.735     bisitz   4815:   color: #999999;
1.532     albertel 4816: }
                   4817: 
1.794     www      4818: .LC_discussion {
1.911     bisitz   4819:   background: $tabbg;
                   4820:   border: 1px solid black;
                   4821:   margin: 2px;
1.794     www      4822: }
                   4823: 
                   4824: .LC_disc_action_links_bar {
1.911     bisitz   4825:   background: $tabbg;
                   4826:   border: none;
                   4827:   margin: 4px;
1.794     www      4828: }
                   4829: 
                   4830: .LC_disc_action_left {
1.911     bisitz   4831:   text-align: left;
1.794     www      4832: }
                   4833: 
                   4834: .LC_disc_action_right {
1.911     bisitz   4835:   text-align: right;
1.794     www      4836: }
                   4837: 
                   4838: .LC_disc_new_item {
1.911     bisitz   4839:   background: white;
                   4840:   border: 2px solid red;
                   4841:   margin: 2px;
1.794     www      4842: }
                   4843: 
                   4844: .LC_disc_old_item {
1.911     bisitz   4845:   background: white;
                   4846:   border: 1px solid black;
                   4847:   margin: 2px;
1.794     www      4848: }
                   4849: 
1.458     albertel 4850: table.LC_pastsubmission {
                   4851:   border: 1px solid black;
                   4852:   margin: 2px;
                   4853: }
                   4854: 
1.795     www      4855: table#LC_top_nav,
                   4856: table#LC_menubuttons,
                   4857: table#LC_nav_location {
1.345     albertel 4858:   width: 100%;
                   4859:   background: $pgbg;
1.392     albertel 4860:   border: 2px;
1.402     albertel 4861:   border-collapse: separate;
1.803     bisitz   4862:   padding: 0;
1.345     albertel 4863: }
1.392     albertel 4864: 
1.801     tempelho 4865: table#LC_title_bar a {
                   4866:   color: $fontmenu;
                   4867: }
1.836     bisitz   4868: 
1.807     droeschl 4869: table#LC_title_bar {
1.819     tempelho 4870:   clear: both;
1.836     bisitz   4871:   display: none;
1.807     droeschl 4872: }
                   4873: 
1.795     www      4874: table#LC_title_bar,
                   4875: table.LC_breadcrumbs,
1.393     albertel 4876: table#LC_title_bar.LC_with_remote {
1.359     albertel 4877:   width: 100%;
1.392     albertel 4878:   border-color: $pgbg;
                   4879:   border-style: solid;
                   4880:   border-width: $border;
1.379     albertel 4881:   background: $pgbg;
1.801     tempelho 4882:   color: $fontmenu;
1.392     albertel 4883:   border-collapse: collapse;
1.803     bisitz   4884:   padding: 0;
1.819     tempelho 4885:   margin: 0;
1.359     albertel 4886: }
1.795     www      4887: 
1.913     droeschl 4888: /* #SD START (work in progress)*/
                   4889: 
                   4890: ul.LC_bct {
                   4891:     margin: 0;
                   4892:     padding: 0;
                   4893: }
                   4894: ul.LC_bct ol {
                   4895:     display: inline;
                   4896: }
                   4897: ul.LC_bct ul {
                   4898:     display: inline;
                   4899:     padding: 0;
                   4900: }
                   4901: ul.LC_bct li {
                   4902:     list-style-type: none;
                   4903:     display: inline;
                   4904: }
                   4905: 
                   4906: 
                   4907: ul.LC_breadcrumb_tools {
                   4908: }
                   4909: 
                   4910: li.LC_breadcrumb_tools {
                   4911: }
                   4912: li.LC_breadcrumb_tools img{
                   4913:     vertical-align: middle;
                   4914: }
                   4915: 
                   4916: .LC_breadcrumb_tools_A {
                   4917:     margin: 0 0 0 1em;
                   4918: }
                   4919: .LC_breadcrumb_tools_B {
                   4920:     float: right;
                   4921:     margin-top: 0.4em;
                   4922: }
                   4923: .LC_breadcrumb_tools_C {
                   4924:     margin: 0 1em 0 0;
                   4925:     float: right;
                   4926: }
                   4927: /* #SD END */
                   4928: 
1.359     albertel 4929: table#LC_title_bar td {
                   4930:   background: $tabbg;
                   4931: }
1.795     www      4932: 
1.911     bisitz   4933: table#LC_menubuttons img {
1.803     bisitz   4934:   border: none;
1.346     albertel 4935: }
1.795     www      4936: 
1.345     albertel 4937: table#LC_top_nav td {
                   4938:   background: $tabbg;
1.803     bisitz   4939:   border: none;
1.407     albertel 4940:   font-size: small;
1.706     harmsja  4941:   vertical-align:top;
                   4942:   padding:2px 5px 2px 5px;
1.345     albertel 4943: }
1.795     www      4944: 
                   4945: table#LC_top_nav td a,
                   4946: div#LC_top_nav a {
1.345     albertel 4947:   color: $font;
                   4948: }
1.795     www      4949: 
1.364     albertel 4950: table#LC_top_nav td.LC_top_nav_logo {
                   4951:   background: $tabbg;
1.432     albertel 4952:   text-align: left;
1.408     albertel 4953:   white-space: nowrap;
1.432     albertel 4954:   width: 31px;
1.408     albertel 4955: }
1.795     www      4956: 
1.408     albertel 4957: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4958:   border: none;
1.408     albertel 4959:   vertical-align: bottom;
1.364     albertel 4960: }
1.795     www      4961: 
1.777     tempelho 4962: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4963: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4964:   width: 2.0em;
                   4965: }
1.795     www      4966: 
1.442     albertel 4967: table#LC_top_nav td.LC_top_nav_login {
                   4968:   width: 4.0em;
                   4969:   text-align: center;
                   4970: }
1.795     www      4971: 
1.842     droeschl 4972: .LC_breadcrumbs_component {
1.911     bisitz   4973:   float: right;
                   4974:   margin: 0 1em;
1.357     albertel 4975: }
1.842     droeschl 4976: .LC_breadcrumbs_component img {
1.911     bisitz   4977:   vertical-align: middle;
1.777     tempelho 4978: }
1.795     www      4979: 
1.383     albertel 4980: td.LC_table_cell_checkbox {
                   4981:   text-align: center;
                   4982: }
1.795     www      4983: 
1.779     bisitz   4984: table#LC_mainmenu td.LC_mainmenu_column {
1.911     bisitz   4985:   vertical-align: top;
1.777     tempelho 4986: }
1.522     albertel 4987: 
1.795     www      4988: .LC_fontsize_small {
1.911     bisitz   4989:   font-size: 70%;
1.705     tempelho 4990: }
                   4991: 
1.844     bisitz   4992: #LC_breadcrumbs {
1.911     bisitz   4993:   clear:both;
                   4994:   background: $sidebg;
                   4995:   border-bottom: 1px solid $lg_border_color;
                   4996:   line-height: 2.5em;
1.904     droeschl 4997:  /* SD working here
                   4998:  height: 2.5em;
                   4999:  overflow: hidden; */
1.911     bisitz   5000:   margin: 0;
                   5001:   padding: 0;
1.819     tempelho 5002: }
1.862     bisitz   5003: 
1.839     droeschl 5004: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5005: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5006:   display:none;
1.839     droeschl 5007: }
1.819     tempelho 5008: 
1.844     bisitz   5009: #LC_head_subbox {
1.911     bisitz   5010:   clear:both;
                   5011:   background: #F8F8F8; /* $sidebg; */
                   5012:   border-bottom: 1px solid $lg_border_color;
                   5013:   margin: 0 0 10px 0;
                   5014:   padding: 5px;
1.822     bisitz   5015: }
                   5016: 
1.795     www      5017: .LC_fontsize_medium {
1.911     bisitz   5018:   font-size: 85%;
1.705     tempelho 5019: }
                   5020: 
1.795     www      5021: .LC_fontsize_large {
1.911     bisitz   5022:   font-size: 120%;
1.705     tempelho 5023: }
                   5024: 
1.346     albertel 5025: .LC_menubuttons_inline_text {
                   5026:   color: $font;
1.698     harmsja  5027:   font-size: 90%;
1.701     harmsja  5028:   padding-left:3px;
1.346     albertel 5029: }
                   5030: 
1.526     www      5031: .LC_menubuttons_link {
                   5032:   text-decoration: none;
                   5033: }
1.795     www      5034: 
1.522     albertel 5035: .LC_menubuttons_category {
1.521     www      5036:   color: $font;
1.526     www      5037:   background: $pgbg;
1.521     www      5038:   font-size: larger;
                   5039:   font-weight: bold;
                   5040: }
                   5041: 
1.346     albertel 5042: td.LC_menubuttons_text {
1.911     bisitz   5043:   color: $font;
1.346     albertel 5044: }
1.706     harmsja  5045: 
1.346     albertel 5046: .LC_current_location {
                   5047:   background: $tabbg;
                   5048: }
1.795     www      5049: 
1.346     albertel 5050: .LC_new_mail {
1.634     www      5051:   background: $tabbg;
1.346     albertel 5052:   font-weight: bold;
                   5053: }
1.347     albertel 5054: 
1.795     www      5055: table.LC_data_table,
                   5056: table.LC_mail_list {
1.347     albertel 5057:   border: 1px solid #000000;
1.402     albertel 5058:   border-collapse: separate;
1.426     albertel 5059:   border-spacing: 1px;
1.610     albertel 5060:   background: $pgbg;
1.347     albertel 5061: }
1.795     www      5062: 
1.422     albertel 5063: .LC_data_table_dense {
                   5064:   font-size: small;
                   5065: }
1.795     www      5066: 
1.507     raeburn  5067: table.LC_nested_outer {
                   5068:   border: 1px solid #000000;
1.589     raeburn  5069:   border-collapse: collapse;
1.803     bisitz   5070:   border-spacing: 0;
1.507     raeburn  5071:   width: 100%;
                   5072: }
1.795     www      5073: 
1.879     raeburn  5074: table.LC_innerpickbox,
1.507     raeburn  5075: table.LC_nested {
1.803     bisitz   5076:   border: none;
1.589     raeburn  5077:   border-collapse: collapse;
1.803     bisitz   5078:   border-spacing: 0;
1.507     raeburn  5079:   width: 100%;
                   5080: }
1.795     www      5081: 
1.911     bisitz   5082: table.LC_data_table tr th,
                   5083: table.LC_calendar tr th,
1.795     www      5084: table.LC_mail_list tr th,
1.879     raeburn  5085: table.LC_prior_tries tr th,
                   5086: table.LC_innerpickbox tr th {
1.349     albertel 5087:   font-weight: bold;
                   5088:   background-color: $data_table_head;
1.801     tempelho 5089:   color:$fontmenu;
1.701     harmsja  5090:   font-size:90%;
1.347     albertel 5091: }
1.795     www      5092: 
1.879     raeburn  5093: table.LC_innerpickbox tr th,
                   5094: table.LC_innerpickbox tr td {
                   5095:   vertical-align: top;
                   5096: }
                   5097: 
1.711     raeburn  5098: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5099:   background-color: #CCCCCC;
1.711     raeburn  5100:   font-weight: bold;
                   5101:   text-align: left;
                   5102: }
1.795     www      5103: 
1.912     bisitz   5104: table.LC_data_table tr.LC_odd_row > td {
                   5105:   background-color: $data_table_light;
                   5106:   padding: 2px;
                   5107:   vertical-align: top;
                   5108: }
                   5109: 
1.809     bisitz   5110: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5111:   background-color: $data_table_light;
1.912     bisitz   5112:   vertical-align: top;
                   5113: }
                   5114: 
                   5115: table.LC_data_table tr.LC_even_row > td {
                   5116:   background-color: $data_table_dark;
1.425     albertel 5117:   padding: 2px;
1.900     bisitz   5118:   vertical-align: top;
1.347     albertel 5119: }
1.795     www      5120: 
1.809     bisitz   5121: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5122:   background-color: $data_table_dark;
1.900     bisitz   5123:   vertical-align: top;
1.347     albertel 5124: }
1.795     www      5125: 
1.425     albertel 5126: table.LC_data_table tr.LC_data_table_highlight td {
                   5127:   background-color: $data_table_darker;
                   5128: }
1.795     www      5129: 
1.639     raeburn  5130: table.LC_data_table tr td.LC_leftcol_header {
                   5131:   background-color: $data_table_head;
                   5132:   font-weight: bold;
                   5133: }
1.795     www      5134: 
1.451     albertel 5135: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5136: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5137:   background-color: #FFFFFF;
1.421     albertel 5138:   font-weight: bold;
                   5139:   font-style: italic;
                   5140:   text-align: center;
                   5141:   padding: 8px;
1.347     albertel 5142: }
1.795     www      5143: 
1.890     droeschl 5144: table.LC_caption {
                   5145: }
                   5146: 
1.507     raeburn  5147: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5148:   padding: 4ex
                   5149: }
1.795     www      5150: 
1.507     raeburn  5151: table.LC_nested_outer tr th {
                   5152:   font-weight: bold;
1.801     tempelho 5153:   color:$fontmenu;
1.507     raeburn  5154:   background-color: $data_table_head;
1.701     harmsja  5155:   font-size: small;
1.507     raeburn  5156:   border-bottom: 1px solid #000000;
                   5157: }
1.795     www      5158: 
1.507     raeburn  5159: table.LC_nested_outer tr td.LC_subheader {
                   5160:   background-color: $data_table_head;
                   5161:   font-weight: bold;
                   5162:   font-size: small;
                   5163:   border-bottom: 1px solid #000000;
                   5164:   text-align: right;
1.451     albertel 5165: }
1.795     www      5166: 
1.507     raeburn  5167: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5168:   background-color: #CCCCCC;
1.451     albertel 5169:   font-weight: bold;
                   5170:   font-size: small;
1.507     raeburn  5171:   text-align: center;
                   5172: }
1.795     www      5173: 
1.589     raeburn  5174: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5175: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5176:   text-align: left;
1.451     albertel 5177: }
1.795     www      5178: 
1.507     raeburn  5179: table.LC_nested td {
1.735     bisitz   5180:   background-color: #FFFFFF;
1.451     albertel 5181:   font-size: small;
1.507     raeburn  5182: }
1.795     www      5183: 
1.507     raeburn  5184: table.LC_nested_outer tr th.LC_right_item,
                   5185: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5186: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5187: table.LC_nested tr td.LC_right_item {
1.451     albertel 5188:   text-align: right;
                   5189: }
                   5190: 
1.507     raeburn  5191: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5192:   background-color: #EEEEEE;
1.451     albertel 5193: }
                   5194: 
1.473     raeburn  5195: table.LC_createuser {
                   5196: }
                   5197: 
                   5198: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5199:   font-size: small;
1.473     raeburn  5200: }
                   5201: 
                   5202: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5203:   background-color: #CCCCCC;
1.473     raeburn  5204:   font-weight: bold;
                   5205:   text-align: center;
                   5206: }
                   5207: 
1.349     albertel 5208: table.LC_calendar {
                   5209:   border: 1px solid #000000;
                   5210:   border-collapse: collapse;
                   5211: }
1.795     www      5212: 
1.349     albertel 5213: table.LC_calendar_pickdate {
                   5214:   font-size: xx-small;
                   5215: }
1.795     www      5216: 
1.349     albertel 5217: table.LC_calendar tr td {
                   5218:   border: 1px solid #000000;
                   5219:   vertical-align: top;
                   5220: }
1.795     www      5221: 
1.349     albertel 5222: table.LC_calendar tr td.LC_calendar_day_empty {
                   5223:   background-color: $data_table_dark;
                   5224: }
1.795     www      5225: 
1.779     bisitz   5226: table.LC_calendar tr td.LC_calendar_day_current {
                   5227:   background-color: $data_table_highlight;
1.777     tempelho 5228: }
1.795     www      5229: 
1.349     albertel 5230: table.LC_mail_list tr.LC_mail_new {
                   5231:   background-color: $mail_new;
                   5232: }
1.795     www      5233: 
1.349     albertel 5234: table.LC_mail_list tr.LC_mail_new:hover {
                   5235:   background-color: $mail_new_hover;
                   5236: }
1.795     www      5237: 
                   5238: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5239: }
1.795     www      5240: 
                   5241: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5242: }
1.795     www      5243: 
1.349     albertel 5244: table.LC_mail_list tr.LC_mail_read {
                   5245:   background-color: $mail_read;
                   5246: }
1.795     www      5247: 
1.349     albertel 5248: table.LC_mail_list tr.LC_mail_read:hover {
                   5249:   background-color: $mail_read_hover;
                   5250: }
1.795     www      5251: 
1.349     albertel 5252: table.LC_mail_list tr.LC_mail_replied {
                   5253:   background-color: $mail_replied;
                   5254: }
1.795     www      5255: 
1.349     albertel 5256: table.LC_mail_list tr.LC_mail_replied:hover {
                   5257:   background-color: $mail_replied_hover;
                   5258: }
1.795     www      5259: 
1.349     albertel 5260: table.LC_mail_list tr.LC_mail_other {
                   5261:   background-color: $mail_other;
                   5262: }
1.795     www      5263: 
1.349     albertel 5264: table.LC_mail_list tr.LC_mail_other:hover {
                   5265:   background-color: $mail_other_hover;
                   5266: }
1.494     raeburn  5267: 
1.777     tempelho 5268: table.LC_data_table tr > td.LC_browser_file,
                   5269: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5270:   background: #AAEE77;
1.389     albertel 5271: }
1.795     www      5272: 
1.777     tempelho 5273: table.LC_data_table tr > td.LC_browser_file_locked,
                   5274: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5275:   background: #FFAA99;
1.387     albertel 5276: }
1.795     www      5277: 
1.777     tempelho 5278: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5279:   background: #888888;
1.779     bisitz   5280: }
1.795     www      5281: 
1.777     tempelho 5282: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5283: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5284:   background: #F8F866;
1.777     tempelho 5285: }
1.795     www      5286: 
1.696     bisitz   5287: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5288:   background: #E0E8FF;
1.387     albertel 5289: }
1.696     bisitz   5290: 
1.707     bisitz   5291: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5292:   /* background: #77FF77; */
1.707     bisitz   5293: }
1.795     www      5294: 
1.707     bisitz   5295: table.LC_data_table tr > td.LC_roles_future {
                   5296:   background: #FFFF77;
                   5297: }
1.795     www      5298: 
1.707     bisitz   5299: table.LC_data_table tr > td.LC_roles_will {
                   5300:   background: #FFAA77;
                   5301: }
1.795     www      5302: 
1.707     bisitz   5303: table.LC_data_table tr > td.LC_roles_expired {
                   5304:   background: #FF7777;
                   5305: }
1.795     www      5306: 
1.707     bisitz   5307: table.LC_data_table tr > td.LC_roles_will_not {
                   5308:   background: #AAFF77;
                   5309: }
1.795     www      5310: 
1.707     bisitz   5311: table.LC_data_table tr > td.LC_roles_selected {
                   5312:   background: #11CC55;
                   5313: }
                   5314: 
1.388     albertel 5315: span.LC_current_location {
1.701     harmsja  5316:   font-size:larger;
1.388     albertel 5317:   background: $pgbg;
                   5318: }
1.387     albertel 5319: 
1.395     albertel 5320: span.LC_parm_menu_item {
                   5321:   font-size: larger;
                   5322: }
1.795     www      5323: 
1.395     albertel 5324: span.LC_parm_scope_all {
                   5325:   color: red;
                   5326: }
1.795     www      5327: 
1.395     albertel 5328: span.LC_parm_scope_folder {
                   5329:   color: green;
                   5330: }
1.795     www      5331: 
1.395     albertel 5332: span.LC_parm_scope_resource {
                   5333:   color: orange;
                   5334: }
1.795     www      5335: 
1.395     albertel 5336: span.LC_parm_part {
                   5337:   color: blue;
                   5338: }
1.795     www      5339: 
1.911     bisitz   5340: span.LC_parm_folder,
                   5341: span.LC_parm_symb {
1.395     albertel 5342:   font-size: x-small;
                   5343:   font-family: $mono;
                   5344:   color: #AAAAAA;
                   5345: }
                   5346: 
1.795     www      5347: td.LC_parm_overview_level_menu,
                   5348: td.LC_parm_overview_map_menu,
                   5349: td.LC_parm_overview_parm_selectors,
                   5350: td.LC_parm_overview_restrictions  {
1.396     albertel 5351:   border: 1px solid black;
                   5352:   border-collapse: collapse;
                   5353: }
1.795     www      5354: 
1.396     albertel 5355: table.LC_parm_overview_restrictions td {
                   5356:   border-width: 1px 4px 1px 4px;
                   5357:   border-style: solid;
                   5358:   border-color: $pgbg;
                   5359:   text-align: center;
                   5360: }
1.795     www      5361: 
1.396     albertel 5362: table.LC_parm_overview_restrictions th {
                   5363:   background: $tabbg;
                   5364:   border-width: 1px 4px 1px 4px;
                   5365:   border-style: solid;
                   5366:   border-color: $pgbg;
                   5367: }
1.795     www      5368: 
1.398     albertel 5369: table#LC_helpmenu {
1.803     bisitz   5370:   border: none;
1.398     albertel 5371:   height: 55px;
1.803     bisitz   5372:   border-spacing: 0;
1.398     albertel 5373: }
                   5374: 
                   5375: table#LC_helpmenu fieldset legend {
                   5376:   font-size: larger;
                   5377: }
1.795     www      5378: 
1.397     albertel 5379: table#LC_helpmenu_links {
                   5380:   width: 100%;
                   5381:   border: 1px solid black;
                   5382:   background: $pgbg;
1.803     bisitz   5383:   padding: 0;
1.397     albertel 5384:   border-spacing: 1px;
                   5385: }
1.795     www      5386: 
1.397     albertel 5387: table#LC_helpmenu_links tr td {
                   5388:   padding: 1px;
                   5389:   background: $tabbg;
1.399     albertel 5390:   text-align: center;
                   5391:   font-weight: bold;
1.397     albertel 5392: }
1.396     albertel 5393: 
1.795     www      5394: table#LC_helpmenu_links a:link,
                   5395: table#LC_helpmenu_links a:visited,
1.397     albertel 5396: table#LC_helpmenu_links a:active {
                   5397:   text-decoration: none;
                   5398:   color: $font;
                   5399: }
1.795     www      5400: 
1.397     albertel 5401: table#LC_helpmenu_links a:hover {
                   5402:   text-decoration: underline;
                   5403:   color: $vlink;
                   5404: }
1.396     albertel 5405: 
1.417     albertel 5406: .LC_chrt_popup_exists {
                   5407:   border: 1px solid #339933;
                   5408:   margin: -1px;
                   5409: }
1.795     www      5410: 
1.417     albertel 5411: .LC_chrt_popup_up {
                   5412:   border: 1px solid yellow;
                   5413:   margin: -1px;
                   5414: }
1.795     www      5415: 
1.417     albertel 5416: .LC_chrt_popup {
                   5417:   border: 1px solid #8888FF;
                   5418:   background: #CCCCFF;
                   5419: }
1.795     www      5420: 
1.421     albertel 5421: table.LC_pick_box {
                   5422:   border-collapse: separate;
                   5423:   background: white;
                   5424:   border: 1px solid black;
                   5425:   border-spacing: 1px;
                   5426: }
1.795     www      5427: 
1.421     albertel 5428: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5429:   background: $sidebg;
1.421     albertel 5430:   font-weight: bold;
1.900     bisitz   5431:   text-align: left;
1.740     bisitz   5432:   vertical-align: top;
1.421     albertel 5433:   width: 184px;
                   5434:   padding: 8px;
                   5435: }
1.795     www      5436: 
1.579     raeburn  5437: table.LC_pick_box td.LC_pick_box_value {
                   5438:   text-align: left;
                   5439:   padding: 8px;
                   5440: }
1.795     www      5441: 
1.579     raeburn  5442: table.LC_pick_box td.LC_pick_box_select {
                   5443:   text-align: left;
                   5444:   padding: 8px;
                   5445: }
1.795     www      5446: 
1.424     albertel 5447: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5448:   padding: 0;
1.421     albertel 5449:   height: 1px;
                   5450:   background: black;
                   5451: }
1.795     www      5452: 
1.421     albertel 5453: table.LC_pick_box td.LC_pick_box_submit {
                   5454:   text-align: right;
                   5455: }
1.795     www      5456: 
1.579     raeburn  5457: table.LC_pick_box td.LC_evenrow_value {
                   5458:   text-align: left;
                   5459:   padding: 8px;
                   5460:   background-color: $data_table_light;
                   5461: }
1.795     www      5462: 
1.579     raeburn  5463: table.LC_pick_box td.LC_oddrow_value {
                   5464:   text-align: left;
                   5465:   padding: 8px;
                   5466:   background-color: $data_table_light;
                   5467: }
1.795     www      5468: 
1.579     raeburn  5469: span.LC_helpform_receipt_cat {
                   5470:   font-weight: bold;
                   5471: }
1.795     www      5472: 
1.424     albertel 5473: table.LC_group_priv_box {
                   5474:   background: white;
                   5475:   border: 1px solid black;
                   5476:   border-spacing: 1px;
                   5477: }
1.795     www      5478: 
1.424     albertel 5479: table.LC_group_priv_box td.LC_pick_box_title {
                   5480:   background: $tabbg;
                   5481:   font-weight: bold;
                   5482:   text-align: right;
                   5483:   width: 184px;
                   5484: }
1.795     www      5485: 
1.424     albertel 5486: table.LC_group_priv_box td.LC_groups_fixed {
                   5487:   background: $data_table_light;
                   5488:   text-align: center;
                   5489: }
1.795     www      5490: 
1.424     albertel 5491: table.LC_group_priv_box td.LC_groups_optional {
                   5492:   background: $data_table_dark;
                   5493:   text-align: center;
                   5494: }
1.795     www      5495: 
1.424     albertel 5496: table.LC_group_priv_box td.LC_groups_functionality {
                   5497:   background: $data_table_darker;
                   5498:   text-align: center;
                   5499:   font-weight: bold;
                   5500: }
1.795     www      5501: 
1.424     albertel 5502: table.LC_group_priv td {
                   5503:   text-align: left;
1.803     bisitz   5504:   padding: 0;
1.424     albertel 5505: }
                   5506: 
1.421     albertel 5507: table.LC_notify_front_page {
                   5508:   background: white;
                   5509:   border: 1px solid black;
                   5510:   padding: 8px;
                   5511: }
1.795     www      5512: 
1.421     albertel 5513: table.LC_notify_front_page td {
                   5514:   padding: 8px;
                   5515: }
1.795     www      5516: 
1.424     albertel 5517: .LC_navbuttons {
                   5518:   margin: 2ex 0ex 2ex 0ex;
                   5519: }
1.795     www      5520: 
1.423     albertel 5521: .LC_topic_bar {
                   5522:   font-weight: bold;
                   5523:   width: 100%;
                   5524:   background: $tabbg;
                   5525:   vertical-align: middle;
                   5526:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5527:   padding: 3px;
1.423     albertel 5528: }
1.795     www      5529: 
1.423     albertel 5530: .LC_topic_bar span {
                   5531:   vertical-align: middle;
                   5532: }
1.795     www      5533: 
1.423     albertel 5534: .LC_topic_bar img {
                   5535:   vertical-align: bottom;
                   5536: }
1.795     www      5537: 
1.423     albertel 5538: table.LC_course_group_status {
                   5539:   margin: 20px;
                   5540: }
1.795     www      5541: 
1.423     albertel 5542: table.LC_status_selector td {
                   5543:   vertical-align: top;
                   5544:   text-align: center;
1.424     albertel 5545:   padding: 4px;
                   5546: }
1.795     www      5547: 
1.599     albertel 5548: div.LC_feedback_link {
1.616     albertel 5549:   clear: both;
1.829     kalberla 5550:   background: $sidebg;
1.779     bisitz   5551:   width: 100%;
1.829     kalberla 5552:   padding-bottom: 10px;
                   5553:   border: 1px $tabbg solid;
1.833     kalberla 5554:   height: 22px;
                   5555:   line-height: 22px;
                   5556:   padding-top: 5px;
                   5557: }
                   5558: 
                   5559: div.LC_feedback_link img {
                   5560:   height: 22px;
1.867     kalberla 5561:   vertical-align:middle;
1.829     kalberla 5562: }
                   5563: 
1.911     bisitz   5564: div.LC_feedback_link a {
1.829     kalberla 5565:   text-decoration: none;
1.489     raeburn  5566: }
1.795     www      5567: 
1.867     kalberla 5568: div.LC_comblock {
1.911     bisitz   5569:   display:inline;
1.867     kalberla 5570:   color:$font;
                   5571:   font-size:90%;
                   5572: }
                   5573: 
                   5574: div.LC_feedback_link div.LC_comblock {
                   5575:   padding-left:5px;
                   5576: }
                   5577: 
                   5578: div.LC_feedback_link div.LC_comblock a {
                   5579:   color:$font;
                   5580: }
                   5581: 
1.489     raeburn  5582: span.LC_feedback_link {
1.858     bisitz   5583:   /* background: $feedback_link_bg; */
1.599     albertel 5584:   font-size: larger;
                   5585: }
1.795     www      5586: 
1.599     albertel 5587: span.LC_message_link {
1.858     bisitz   5588:   /* background: $feedback_link_bg; */
1.599     albertel 5589:   font-size: larger;
                   5590:   position: absolute;
                   5591:   right: 1em;
1.489     raeburn  5592: }
1.421     albertel 5593: 
1.515     albertel 5594: table.LC_prior_tries {
1.524     albertel 5595:   border: 1px solid #000000;
                   5596:   border-collapse: separate;
                   5597:   border-spacing: 1px;
1.515     albertel 5598: }
1.523     albertel 5599: 
1.515     albertel 5600: table.LC_prior_tries td {
1.524     albertel 5601:   padding: 2px;
1.515     albertel 5602: }
1.523     albertel 5603: 
                   5604: .LC_answer_correct {
1.795     www      5605:   background: lightgreen;
                   5606:   color: darkgreen;
                   5607:   padding: 6px;
1.523     albertel 5608: }
1.795     www      5609: 
1.523     albertel 5610: .LC_answer_charged_try {
1.797     www      5611:   background: #FFAAAA;
1.795     www      5612:   color: darkred;
                   5613:   padding: 6px;
1.523     albertel 5614: }
1.795     www      5615: 
1.779     bisitz   5616: .LC_answer_not_charged_try,
1.523     albertel 5617: .LC_answer_no_grade,
                   5618: .LC_answer_late {
1.795     www      5619:   background: lightyellow;
1.523     albertel 5620:   color: black;
1.795     www      5621:   padding: 6px;
1.523     albertel 5622: }
1.795     www      5623: 
1.523     albertel 5624: .LC_answer_previous {
1.795     www      5625:   background: lightblue;
                   5626:   color: darkblue;
                   5627:   padding: 6px;
1.523     albertel 5628: }
1.795     www      5629: 
1.779     bisitz   5630: .LC_answer_no_message {
1.777     tempelho 5631:   background: #FFFFFF;
                   5632:   color: black;
1.795     www      5633:   padding: 6px;
1.779     bisitz   5634: }
1.795     www      5635: 
1.779     bisitz   5636: .LC_answer_unknown {
                   5637:   background: orange;
                   5638:   color: black;
1.795     www      5639:   padding: 6px;
1.777     tempelho 5640: }
1.795     www      5641: 
1.529     albertel 5642: span.LC_prior_numerical,
                   5643: span.LC_prior_string,
                   5644: span.LC_prior_custom,
                   5645: span.LC_prior_reaction,
                   5646: span.LC_prior_math {
1.523     albertel 5647:   font-family: monospace;
                   5648:   white-space: pre;
                   5649: }
                   5650: 
1.525     albertel 5651: span.LC_prior_string {
                   5652:   font-family: monospace;
                   5653:   white-space: pre;
                   5654: }
                   5655: 
1.523     albertel 5656: table.LC_prior_option {
                   5657:   width: 100%;
                   5658:   border-collapse: collapse;
                   5659: }
1.795     www      5660: 
1.911     bisitz   5661: table.LC_prior_rank,
1.795     www      5662: table.LC_prior_match {
1.528     albertel 5663:   border-collapse: collapse;
                   5664: }
1.795     www      5665: 
1.528     albertel 5666: table.LC_prior_option tr td,
                   5667: table.LC_prior_rank tr td,
                   5668: table.LC_prior_match tr td {
1.524     albertel 5669:   border: 1px solid #000000;
1.515     albertel 5670: }
                   5671: 
1.855     bisitz   5672: .LC_nobreak {
1.544     albertel 5673:   white-space: nowrap;
1.519     raeburn  5674: }
                   5675: 
1.576     raeburn  5676: span.LC_cusr_emph {
                   5677:   font-style: italic;
                   5678: }
                   5679: 
1.633     raeburn  5680: span.LC_cusr_subheading {
                   5681:   font-weight: normal;
                   5682:   font-size: 85%;
                   5683: }
                   5684: 
1.545     albertel 5685: table.LC_docs_documents {
                   5686:   background: #BBBBBB;
1.803     bisitz   5687:   border-width: 0;
1.545     albertel 5688:   border-collapse: collapse;
                   5689: }
1.795     www      5690: 
1.777     tempelho 5691: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5692:   border: 2px solid black;
                   5693:   padding: 4px;
1.777     tempelho 5694: }
1.795     www      5695: 
1.861     bisitz   5696: div.LC_docs_entry_move {
1.859     bisitz   5697:   border: 1px solid #BBBBBB;
1.545     albertel 5698:   background: #DDDDDD;
1.861     bisitz   5699:   width: 22px;
1.859     bisitz   5700:   padding: 1px;
                   5701:   margin: 0;
1.545     albertel 5702: }
                   5703: 
1.861     bisitz   5704: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5705: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5706:   background: #DDDDDD;
                   5707:   font-size: x-small;
                   5708: }
1.795     www      5709: 
1.861     bisitz   5710: .LC_docs_entry_parameter {
                   5711:   white-space: nowrap;
                   5712: }
                   5713: 
1.544     albertel 5714: .LC_docs_copy {
1.545     albertel 5715:   color: #000099;
1.544     albertel 5716: }
1.795     www      5717: 
1.544     albertel 5718: .LC_docs_cut {
1.545     albertel 5719:   color: #550044;
1.544     albertel 5720: }
1.795     www      5721: 
1.544     albertel 5722: .LC_docs_rename {
1.545     albertel 5723:   color: #009900;
1.544     albertel 5724: }
1.795     www      5725: 
1.544     albertel 5726: .LC_docs_remove {
1.545     albertel 5727:   color: #990000;
                   5728: }
                   5729: 
1.547     albertel 5730: .LC_docs_reinit_warn,
                   5731: .LC_docs_ext_edit {
                   5732:   font-size: x-small;
                   5733: }
                   5734: 
1.545     albertel 5735: table.LC_docs_adddocs td,
                   5736: table.LC_docs_adddocs th {
                   5737:   border: 1px solid #BBBBBB;
                   5738:   padding: 4px;
                   5739:   background: #DDDDDD;
1.543     albertel 5740: }
                   5741: 
1.584     albertel 5742: table.LC_sty_begin {
                   5743:   background: #BBFFBB;
                   5744: }
1.795     www      5745: 
1.584     albertel 5746: table.LC_sty_end {
                   5747:   background: #FFBBBB;
                   5748: }
                   5749: 
1.589     raeburn  5750: table.LC_double_column {
1.803     bisitz   5751:   border-width: 0;
1.589     raeburn  5752:   border-collapse: collapse;
                   5753:   width: 100%;
                   5754:   padding: 2px;
                   5755: }
                   5756: 
                   5757: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5758:   top: 2px;
1.589     raeburn  5759:   left: 2px;
                   5760:   width: 47%;
                   5761:   vertical-align: top;
                   5762: }
                   5763: 
                   5764: table.LC_double_column tr td.LC_right_col {
                   5765:   top: 2px;
1.779     bisitz   5766:   right: 2px;
1.589     raeburn  5767:   width: 47%;
                   5768:   vertical-align: top;
                   5769: }
                   5770: 
1.591     raeburn  5771: div.LC_left_float {
                   5772:   float: left;
                   5773:   padding-right: 5%;
1.597     albertel 5774:   padding-bottom: 4px;
1.591     raeburn  5775: }
                   5776: 
                   5777: div.LC_clear_float_header {
1.597     albertel 5778:   padding-bottom: 2px;
1.591     raeburn  5779: }
                   5780: 
                   5781: div.LC_clear_float_footer {
1.597     albertel 5782:   padding-top: 10px;
1.591     raeburn  5783:   clear: both;
                   5784: }
                   5785: 
1.597     albertel 5786: div.LC_grade_show_user {
                   5787:   margin-top: 20px;
                   5788:   border: 1px solid black;
                   5789: }
1.795     www      5790: 
1.597     albertel 5791: div.LC_grade_user_name {
                   5792:   background: #DDDDEE;
                   5793:   border-bottom: 1px solid black;
1.705     tempelho 5794:   font-weight: bold;
                   5795:   font-size: large;
1.597     albertel 5796: }
1.795     www      5797: 
1.597     albertel 5798: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5799:   background: #DDEEDD;
                   5800: }
                   5801: 
                   5802: div.LC_grade_show_problem,
                   5803: div.LC_grade_submissions,
                   5804: div.LC_grade_message_center,
                   5805: div.LC_grade_info_links,
                   5806: div.LC_grade_assign {
                   5807:   margin: 5px;
                   5808:   width: 99%;
                   5809:   background: #FFFFFF;
                   5810: }
1.795     www      5811: 
1.597     albertel 5812: div.LC_grade_show_problem_header,
                   5813: div.LC_grade_submissions_header,
                   5814: div.LC_grade_message_center_header,
                   5815: div.LC_grade_assign_header {
1.705     tempelho 5816:   font-weight: bold;
                   5817:   font-size: large;
1.597     albertel 5818: }
1.795     www      5819: 
1.597     albertel 5820: div.LC_grade_show_problem_problem,
                   5821: div.LC_grade_submissions_body,
                   5822: div.LC_grade_message_center_body,
                   5823: div.LC_grade_assign_body {
                   5824:   border: 1px solid black;
                   5825:   width: 99%;
                   5826:   background: #FFFFFF;
                   5827: }
1.795     www      5828: 
1.598     albertel 5829: span.LC_grade_check_note {
1.705     tempelho 5830:   font-weight: normal;
                   5831:   font-size: medium;
1.598     albertel 5832:   display: inline;
                   5833:   position: absolute;
                   5834:   right: 1em;
                   5835: }
1.597     albertel 5836: 
1.613     albertel 5837: table.LC_scantron_action {
                   5838:   width: 100%;
                   5839: }
1.795     www      5840: 
1.613     albertel 5841: table.LC_scantron_action tr th {
1.698     harmsja  5842:   font-weight:bold;
                   5843:   font-style:normal;
1.613     albertel 5844: }
1.795     www      5845: 
1.779     bisitz   5846: .LC_edit_problem_header,
1.614     albertel 5847: div.LC_edit_problem_footer {
1.705     tempelho 5848:   font-weight: normal;
                   5849:   font-size:  medium;
1.602     albertel 5850:   margin: 2px;
1.600     albertel 5851: }
1.795     www      5852: 
1.600     albertel 5853: div.LC_edit_problem_header,
1.602     albertel 5854: div.LC_edit_problem_header div,
1.614     albertel 5855: div.LC_edit_problem_footer,
                   5856: div.LC_edit_problem_footer div,
1.602     albertel 5857: div.LC_edit_problem_editxml_header,
                   5858: div.LC_edit_problem_editxml_header div {
1.600     albertel 5859:   margin-top: 5px;
                   5860: }
1.795     www      5861: 
1.600     albertel 5862: div.LC_edit_problem_header_title {
1.705     tempelho 5863:   font-weight: bold;
                   5864:   font-size: larger;
1.602     albertel 5865:   background: $tabbg;
                   5866:   padding: 3px;
                   5867: }
1.795     www      5868: 
1.602     albertel 5869: table.LC_edit_problem_header_title {
1.705     tempelho 5870:   font-size: larger;
                   5871:   font-weight:  bold;
1.602     albertel 5872:   width: 100%;
                   5873:   border-color: $pgbg;
                   5874:   border-style: solid;
                   5875:   border-width: $border;
1.600     albertel 5876:   background: $tabbg;
1.602     albertel 5877:   border-collapse: collapse;
1.803     bisitz   5878:   padding: 0;
1.602     albertel 5879: }
                   5880: 
                   5881: div.LC_edit_problem_discards {
                   5882:   float: left;
                   5883:   padding-bottom: 5px;
                   5884: }
1.795     www      5885: 
1.602     albertel 5886: div.LC_edit_problem_saves {
                   5887:   float: right;
                   5888:   padding-bottom: 5px;
1.600     albertel 5889: }
1.795     www      5890: 
1.911     bisitz   5891: img.stift {
1.803     bisitz   5892:   border-width: 0;
                   5893:   vertical-align: middle;
1.677     riegler  5894: }
1.680     riegler  5895: 
1.911     bisitz   5896: table#LC_mainmenu {
                   5897:   margin-top:10px;
                   5898:   width:80%;
1.681     riegler  5899: }
                   5900: 
1.911     bisitz   5901: table#LC_mainmenu td.LC_mainmenu_col_fieldset {
1.680     riegler  5902:   vertical-align: top;
                   5903:   width: 45%;
                   5904: }
1.795     www      5905: 
1.779     bisitz   5906: .LC_mainmenu_fieldset_category {
                   5907:   color: $font;
                   5908:   background: $pgbg;
                   5909:   font-size: small;
                   5910:   font-weight: bold;
1.777     tempelho 5911: }
1.795     www      5912: 
1.716     raeburn  5913: div.LC_createcourse {
1.911     bisitz   5914:   margin: 10px 10px 10px 10px;
1.716     raeburn  5915: }
                   5916: 
1.693     droeschl 5917: /* ---- Remove when done ----
                   5918: # The following styles is part of the redesign of LON-CAPA and are
                   5919: # subject to change during this project.
                   5920: # Don't rely on their current functionality as they might be 
                   5921: # changed or removed.
                   5922: # --------------------------*/
                   5923: 
1.698     harmsja  5924: a:hover,
1.897     wenzelju 5925: ol.LC_primary_menu a:hover,
1.721     harmsja  5926: ol#LC_MenuBreadcrumbs a:hover,
                   5927: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5928: ul#LC_secondary_menu a:hover,
1.721     harmsja  5929: .LC_FormSectionClearButton input:hover
1.795     www      5930: ul.LC_TabContent   li:hover a {
1.911     bisitz   5931:   color:#BF2317;
                   5932:   text-decoration:none;
1.693     droeschl 5933: }
                   5934: 
1.779     bisitz   5935: h1 {
1.911     bisitz   5936:   padding: 0;
                   5937:   line-height:130%;
1.693     droeschl 5938: }
1.698     harmsja  5939: 
1.911     bisitz   5940: h2,
                   5941: h3,
                   5942: h4,
                   5943: h5,
                   5944: h6 {
                   5945:   margin: 5px 0 5px 0;
                   5946:   padding: 0;
                   5947:   line-height:130%;
1.693     droeschl 5948: }
1.795     www      5949: 
                   5950: .LC_hcell {
1.911     bisitz   5951:   padding:3px 15px 3px 15px;
                   5952:   margin: 0;
                   5953:   background-color:$tabbg;
                   5954:   color:$fontmenu;
                   5955:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5956: }
1.795     www      5957: 
1.840     bisitz   5958: .LC_Box > .LC_hcell {
1.911     bisitz   5959:   margin: 0 -10px 10px -10px;
1.835     bisitz   5960: }
                   5961: 
1.721     harmsja  5962: .LC_noBorder {
1.911     bisitz   5963:   border: 0;
1.914   ! faziophi 5964:   vertical-align: middle;
1.698     harmsja  5965: }
1.693     droeschl 5966: 
1.761     tempelho 5967: .LC_Right {
1.911     bisitz   5968:   float: right;
                   5969:   margin: 0;
                   5970:   padding: 0;
1.761     tempelho 5971: }
                   5972: 
1.721     harmsja  5973: .LC_FormSectionClearButton input {
1.911     bisitz   5974:   background-color:transparent;
                   5975:   border: none;
                   5976:   cursor:pointer;
                   5977:   text-decoration:underline;
1.693     droeschl 5978: }
1.763     bisitz   5979: 
                   5980: .LC_help_open_topic {
1.911     bisitz   5981:   color: #FFFFFF;
                   5982:   background-color: #EEEEFF;
                   5983:   margin: 1px;
                   5984:   padding: 4px;
                   5985:   border: 1px solid #000033;
                   5986:   white-space: nowrap;
                   5987:   /* vertical-align: middle; */
1.759     neumanie 5988: }
1.693     droeschl 5989: 
1.911     bisitz   5990: dl,
                   5991: ul,
                   5992: div,
                   5993: fieldset {
                   5994:   margin: 10px 10px 10px 0;
                   5995:   /* overflow: hidden; */
1.693     droeschl 5996: }
1.795     www      5997: 
1.838     bisitz   5998: fieldset > legend {
1.911     bisitz   5999:   font-weight: bold;
                   6000:   padding: 0 5px 0 5px;
1.838     bisitz   6001: }
                   6002: 
1.813     bisitz   6003: #LC_nav_bar {
1.911     bisitz   6004:   float: left;
                   6005:   margin: 0.2em 0 0 0;
1.807     droeschl 6006: }
                   6007: 
1.911     bisitz   6008: #LC_nav_bar em {
                   6009:   font-weight: bold;
                   6010:   font-style: normal;
1.807     droeschl 6011: }
                   6012: 
1.897     wenzelju 6013: ol.LC_primary_menu {
1.911     bisitz   6014:   float: right;
                   6015:   margin: 0.2em 0 0 0;
1.807     droeschl 6016: }
                   6017: 
1.852     droeschl 6018: ol#LC_PathBreadcrumbs {
1.911     bisitz   6019:   margin: 0;
1.693     droeschl 6020: }
                   6021: 
1.897     wenzelju 6022: ol.LC_primary_menu li {
1.911     bisitz   6023:   display: inline;
                   6024:   padding: 5px 5px 0 10px;
                   6025:   vertical-align: top;
1.693     droeschl 6026: }
                   6027: 
1.897     wenzelju 6028: ol.LC_primary_menu li img {
1.911     bisitz   6029:   vertical-align: bottom;
1.693     droeschl 6030: }
                   6031: 
1.897     wenzelju 6032: ol.LC_primary_menu a {
1.911     bisitz   6033:   font-size: 90%;
                   6034:   color: RGB(80, 80, 80);
                   6035:   text-decoration: none;
1.693     droeschl 6036: }
1.795     www      6037: 
1.897     wenzelju 6038: ul#LC_secondary_menu {
1.911     bisitz   6039:   clear: both;
                   6040:   color: $fontmenu;
                   6041:   background: $tabbg;
                   6042:   list-style: none;
                   6043:   padding: 0;
                   6044:   margin: 0;
                   6045:   width: 100%;
1.808     droeschl 6046: }
                   6047: 
1.897     wenzelju 6048: ul#LC_secondary_menu li {
1.911     bisitz   6049:   font-weight: bold;
                   6050:   line-height: 1.8em;
                   6051:   padding: 0 0.8em;
                   6052:   border-right: 1px solid black;
                   6053:   display: inline;
                   6054:   vertical-align: middle;
1.807     droeschl 6055: }
                   6056: 
1.847     tempelho 6057: ul.LC_TabContent {
1.911     bisitz   6058:   display:block;
                   6059:   background: $sidebg;
                   6060:   border-bottom: solid 1px $lg_border_color;
                   6061:   list-style:none;
                   6062:   margin: 0 -10px;
                   6063:   padding: 0;
1.693     droeschl 6064: }
                   6065: 
1.795     www      6066: ul.LC_TabContent li,
                   6067: ul.LC_TabContentBigger li {
1.911     bisitz   6068:   float:left;
1.741     harmsja  6069: }
1.795     www      6070: 
1.897     wenzelju 6071: ul#LC_secondary_menu li a {
1.911     bisitz   6072:   color: $fontmenu;
                   6073:   text-decoration: none;
1.693     droeschl 6074: }
1.795     www      6075: 
1.721     harmsja  6076: ul.LC_TabContent {
1.911     bisitz   6077:   min-height:1.5em;
1.721     harmsja  6078: }
1.795     www      6079: 
                   6080: ul.LC_TabContent li {
1.911     bisitz   6081:   vertical-align:middle;
                   6082:   padding: 0 10px 0 10px;
                   6083:   background-color:$tabbg;
                   6084:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6085: }
1.795     www      6086: 
1.847     tempelho 6087: ul.LC_TabContent .right {
1.911     bisitz   6088:   float:right;
1.847     tempelho 6089: }
                   6090: 
1.911     bisitz   6091: ul.LC_TabContent li a,
                   6092: ul.LC_TabContent li {
                   6093:   color:rgb(47,47,47);
                   6094:   text-decoration:none;
                   6095:   font-size:95%;
                   6096:   font-weight:bold;
                   6097:   padding-right: 16px;
1.721     harmsja  6098: }
1.795     www      6099: 
1.911     bisitz   6100: ul.LC_TabContent li:hover,
                   6101: ul.LC_TabContent li.active {
                   6102:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6103:   border-bottom:solid 2px #FFFFFF;
                   6104:   padding-right: 16px;
1.744     ehlerst  6105: }
1.795     www      6106: 
1.870     tempelho 6107: #maincoursedoc {
1.911     bisitz   6108:   clear:both;
1.870     tempelho 6109: }
                   6110: 
                   6111: ul.LC_TabContentBigger {
1.911     bisitz   6112:   display:block;
                   6113:   list-style:none;
                   6114:   padding: 0;
1.870     tempelho 6115: }
                   6116: 
1.795     www      6117: ul.LC_TabContentBigger li {
1.911     bisitz   6118:   vertical-align:bottom;
                   6119:   height: 30px;
                   6120:   font-size:110%;
                   6121:   font-weight:bold;
                   6122:   color: #737373;
1.841     tempelho 6123: }
                   6124: 
1.870     tempelho 6125: 
                   6126: ul.LC_TabContentBigger li a {
1.911     bisitz   6127:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6128:   height: 30px;
                   6129:   line-height: 30px;
                   6130:   text-align: center;
                   6131:   display: block;
                   6132:   text-decoration: none;
1.741     harmsja  6133: }
1.795     www      6134: 
1.911     bisitz   6135: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6136: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6137:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6138:   color:$font;
                   6139:   text-decoration: underline;
1.744     ehlerst  6140: }
1.795     www      6141: 
1.870     tempelho 6142: 
                   6143: ul.LC_TabContentBigger li b {
1.911     bisitz   6144:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6145:   display: block;
                   6146:   float: left;
                   6147:   padding: 0 30px;
1.870     tempelho 6148: }
                   6149: 
                   6150: ul.LC_TabContentBigger li:hover b,
                   6151: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6152:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6153:   color:$font;
                   6154:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6155: }
1.693     droeschl 6156: 
1.870     tempelho 6157: 
1.862     bisitz   6158: ul.LC_CourseBreadcrumbs {
                   6159:   background: $sidebg;
                   6160:   line-height: 32px;
                   6161:   padding-left: 10px;
                   6162:   margin: 0 0 10px 0;
                   6163:   list-style-position: inside;
                   6164: 
                   6165: }
                   6166: 
1.911     bisitz   6167: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6168: ol#LC_PathBreadcrumbs {
1.911     bisitz   6169:   padding-left: 10px;
                   6170:   margin: 0;
                   6171:   list-style-position: inside;
1.904     droeschl 6172:     /* SD working here
                   6173:     white-space: nowrap; */
1.693     droeschl 6174: }
                   6175: 
1.911     bisitz   6176: ol#LC_MenuBreadcrumbs li,
                   6177: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6178: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6179:   display: inline;
                   6180:   white-space: nowrap;
1.904     droeschl 6181:     /* SD working here
                   6182:     white-space: normal; */
1.693     droeschl 6183: }
                   6184: 
1.823     bisitz   6185: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6186: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6187:   text-decoration: none;
                   6188:   font-size:90%;
1.693     droeschl 6189: }
1.795     www      6190: 
                   6191: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6192:   text-decoration:none;
                   6193:   font-size:100%;
                   6194:   font-weight:bold;
1.693     droeschl 6195: }
1.795     www      6196: 
1.840     bisitz   6197: .LC_Box {
1.911     bisitz   6198:   border: solid 1px $lg_border_color;
                   6199:   padding: 0 10px 10px 10px;
1.746     neumanie 6200: }
1.795     www      6201: 
                   6202: .LC_AboutMe_Image {
1.911     bisitz   6203:   float:left;
                   6204:   margin-right:10px;
1.747     neumanie 6205: }
1.795     www      6206: 
                   6207: .LC_Clear_AboutMe_Image {
1.911     bisitz   6208:   clear:left;
1.747     neumanie 6209: }
1.795     www      6210: 
1.721     harmsja  6211: dl.LC_ListStyleClean dt {
1.911     bisitz   6212:   padding-right: 5px;
                   6213:   display: table-header-group;
1.693     droeschl 6214: }
                   6215: 
1.721     harmsja  6216: dl.LC_ListStyleClean dd {
1.911     bisitz   6217:   display: table-row;
1.693     droeschl 6218: }
                   6219: 
1.721     harmsja  6220: .LC_ListStyleClean,
                   6221: .LC_ListStyleSimple,
                   6222: .LC_ListStyleNormal,
1.777     tempelho 6223: .LC_ListStyle_Border,
1.795     www      6224: .LC_ListStyleSpecial {
1.911     bisitz   6225:   /* display:block; */
                   6226:   list-style-position: inside;
                   6227:   list-style-type: none;
                   6228:   overflow: hidden;
                   6229:   padding: 0;
1.693     droeschl 6230: }
                   6231: 
1.721     harmsja  6232: .LC_ListStyleSimple li,
                   6233: .LC_ListStyleSimple dd,
                   6234: .LC_ListStyleNormal li,
                   6235: .LC_ListStyleNormal dd,
                   6236: .LC_ListStyleSpecial li,
1.795     www      6237: .LC_ListStyleSpecial dd {
1.911     bisitz   6238:   margin: 0;
                   6239:   padding: 5px 5px 5px 10px;
                   6240:   clear: both;
1.693     droeschl 6241: }
                   6242: 
1.721     harmsja  6243: .LC_ListStyleClean li,
                   6244: .LC_ListStyleClean dd {
1.911     bisitz   6245:   padding-top: 0;
                   6246:   padding-bottom: 0;
1.693     droeschl 6247: }
                   6248: 
1.721     harmsja  6249: .LC_ListStyleSimple dd,
1.795     www      6250: .LC_ListStyleSimple li {
1.911     bisitz   6251:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6252: }
                   6253: 
1.721     harmsja  6254: .LC_ListStyleSpecial li,
                   6255: .LC_ListStyleSpecial dd {
1.911     bisitz   6256:   list-style-type: none;
                   6257:   background-color: RGB(220, 220, 220);
                   6258:   margin-bottom: 4px;
1.693     droeschl 6259: }
                   6260: 
1.721     harmsja  6261: table.LC_SimpleTable {
1.911     bisitz   6262:   margin:5px;
                   6263:   border:solid 1px $lg_border_color;
1.795     www      6264: }
1.693     droeschl 6265: 
1.721     harmsja  6266: table.LC_SimpleTable tr {
1.911     bisitz   6267:   padding: 0;
                   6268:   border:solid 1px $lg_border_color;
1.693     droeschl 6269: }
1.795     www      6270: 
                   6271: table.LC_SimpleTable thead {
1.911     bisitz   6272:   background:rgb(220,220,220);
1.693     droeschl 6273: }
                   6274: 
1.721     harmsja  6275: div.LC_columnSection {
1.911     bisitz   6276:   display: block;
                   6277:   clear: both;
                   6278:   overflow: hidden;
                   6279:   margin: 0;
1.693     droeschl 6280: }
                   6281: 
1.721     harmsja  6282: div.LC_columnSection>* {
1.911     bisitz   6283:   float: left;
                   6284:   margin: 10px 20px 10px 0;
                   6285:   overflow:hidden;
1.693     droeschl 6286: }
1.721     harmsja  6287: 
1.694     tempelho 6288: .LC_loginpage_container {
1.911     bisitz   6289:   text-align:left;
                   6290:   margin : 0 auto;
                   6291:   width:90%;
                   6292:   padding: 10px;
                   6293:   height: auto;
                   6294:   background-color:#FFFFFF;
                   6295:   border:1px solid #CCCCCC;
1.694     tempelho 6296: }
                   6297: 
                   6298: 
                   6299: .LC_loginpage_loginContainer {
1.911     bisitz   6300:   float:left;
                   6301:   width: 182px;
                   6302:   padding: 2px;
                   6303:   border:1px solid #CCCCCC;
                   6304:   background-color:$loginbg;
1.694     tempelho 6305: }
                   6306: 
1.795     www      6307: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6308:   margin-top: 0;
                   6309:   display:block;
                   6310:   background:$bgcol;
                   6311:   color:$textcol;
                   6312:   padding-left:5px;
1.712     muellerd 6313: }
1.785     tempelho 6314: 
1.694     tempelho 6315: .LC_loginpage_loginInfo {
1.911     bisitz   6316:   float:left;
                   6317:   width:182px;
                   6318:   border:1px solid #CCCCCC;
                   6319:   padding:2px;
1.712     muellerd 6320: }
                   6321: 
1.694     tempelho 6322: .LC_loginpage_space {
1.911     bisitz   6323:   clear: both;
                   6324:   margin-bottom: 20px;
                   6325:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6326: }
                   6327: 
1.785     tempelho 6328: .LC_loginpage_floatLeft {
1.911     bisitz   6329:   float: left;
                   6330:   width: 200px;
                   6331:   margin: 0;
1.785     tempelho 6332: }
                   6333: 
1.795     www      6334: table em {
1.911     bisitz   6335:   font-weight: bold;
                   6336:   font-style: normal;
1.748     schulted 6337: }
1.795     www      6338: 
1.779     bisitz   6339: table.LC_tableBrowseRes,
1.795     www      6340: table.LC_tableOfContent {
1.911     bisitz   6341:   border:none;
                   6342:   border-spacing: 1px;
                   6343:   padding: 3px;
                   6344:   background-color: #FFFFFF;
                   6345:   font-size: 90%;
1.753     droeschl 6346: }
1.789     droeschl 6347: 
1.911     bisitz   6348: table.LC_tableOfContent {
                   6349:   border-collapse: collapse;
1.789     droeschl 6350: }
                   6351: 
1.771     droeschl 6352: table.LC_tableBrowseRes a,
1.768     schulted 6353: table.LC_tableOfContent a {
1.911     bisitz   6354:   background-color: transparent;
                   6355:   text-decoration: none;
1.753     droeschl 6356: }
                   6357: 
1.771     droeschl 6358: table.LC_tableBrowseRes tr.LC_trOdd,
1.911     bisitz   6359: table.LC_tableOfContent tr.LC_trOdd {
                   6360:   background-color: #EEEEEE;
1.753     droeschl 6361: }
                   6362: 
1.795     www      6363: table.LC_tableOfContent img {
1.911     bisitz   6364:   border: none;
                   6365:   height: 1.3em;
                   6366:   vertical-align: text-bottom;
                   6367:   margin-right: 0.3em;
1.753     droeschl 6368: }
1.757     schulted 6369: 
1.795     www      6370: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6371:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6372: }
                   6373: 
1.795     www      6374: a#LC_content_toolbar_launchnav {
1.911     bisitz   6375:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6376: }
                   6377: 
1.795     www      6378: a#LC_content_toolbar_closenav {
1.911     bisitz   6379:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6380: }
                   6381: 
1.795     www      6382: a#LC_content_toolbar_everything {
1.911     bisitz   6383:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6384: }
                   6385: 
1.795     www      6386: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6387:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6388: }
                   6389: 
1.795     www      6390: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6391:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6392: }
                   6393: 
1.795     www      6394: a#LC_content_toolbar_changefolder {
1.911     bisitz   6395:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6396: }
                   6397: 
1.795     www      6398: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6399:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6400: }
                   6401: 
1.795     www      6402: ul#LC_toolbar li a:hover {
1.911     bisitz   6403:   background-position: bottom center;
1.757     schulted 6404: }
                   6405: 
1.795     www      6406: ul#LC_toolbar {
1.911     bisitz   6407:   padding: 0;
                   6408:   margin: 2px;
                   6409:   list-style:none;
                   6410:   position:relative;
                   6411:   background-color:white;
1.757     schulted 6412: }
                   6413: 
1.795     www      6414: ul#LC_toolbar li {
1.911     bisitz   6415:   border:1px solid white;
                   6416:   padding: 0;
                   6417:   margin: 0;
                   6418:   float: left;
                   6419:   display:inline;
                   6420:   vertical-align:middle;
                   6421: }
1.757     schulted 6422: 
1.783     amueller 6423: 
1.795     www      6424: a.LC_toolbarItem {
1.911     bisitz   6425:   display:block;
                   6426:   padding: 0;
                   6427:   margin: 0;
                   6428:   height: 32px;
                   6429:   width: 32px;
                   6430:   color:white;
                   6431:   border: none;
                   6432:   background-repeat:no-repeat;
                   6433:   background-color:transparent;
1.757     schulted 6434: }
                   6435: 
1.843     bisitz   6436: ul.LC_funclist li {
1.782     bisitz   6437:   float: left;
                   6438:   white-space: nowrap;
                   6439:   height: 35px; /* at least as high as heighest list item */
1.803     bisitz   6440:   margin: 0 15px 15px 10px;
1.782     bisitz   6441: }
                   6442: 
1.757     schulted 6443: 
1.343     albertel 6444: END
                   6445: }
                   6446: 
1.306     albertel 6447: =pod
                   6448: 
                   6449: =item * &headtag()
                   6450: 
                   6451: Returns a uniform footer for LON-CAPA web pages.
                   6452: 
1.307     albertel 6453: Inputs: $title - optional title for the head
                   6454:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6455:         $args - optional arguments
1.319     albertel 6456:             force_register - if is true call registerurl so the remote is 
                   6457:                              informed
1.415     albertel 6458:             redirect       -> array ref of
                   6459:                                    1- seconds before redirect occurs
                   6460:                                    2- url to redirect to
                   6461:                                    3- whether the side effect should occur
1.315     albertel 6462:                            (side effect of setting 
                   6463:                                $env{'internal.head.redirect'} to the url 
                   6464:                                redirected too)
1.352     albertel 6465:             domain         -> force to color decorate a page for a specific
                   6466:                                domain
                   6467:             function       -> force usage of a specific rolish color scheme
                   6468:             bgcolor        -> override the default page bgcolor
1.460     albertel 6469:             no_auto_mt_title
                   6470:                            -> prevent &mt()ing the title arg
1.464     albertel 6471: 
1.306     albertel 6472: =cut
                   6473: 
                   6474: sub headtag {
1.313     albertel 6475:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6476:     
1.363     albertel 6477:     my $function = $args->{'function'} || &get_users_function();
                   6478:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6479:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6480:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6481: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6482: 		   #time(),
1.418     albertel 6483: 		   $env{'environment.color.timestamp'},
1.363     albertel 6484: 		   $function,$domain,$bgcolor);
                   6485: 
1.369     www      6486:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6487: 
1.308     albertel 6488:     my $result =
                   6489: 	'<head>'.
1.461     albertel 6490: 	&font_settings();
1.319     albertel 6491: 
1.461     albertel 6492:     if (!$args->{'frameset'}) {
                   6493: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6494:     }
1.319     albertel 6495:     if ($args->{'force_register'}) {
                   6496: 	$result .= &Apache::lonmenu::registerurl(1);
                   6497:     }
1.436     albertel 6498:     if (!$args->{'no_nav_bar'} 
                   6499: 	&& !$args->{'only_body'}
                   6500: 	&& !$args->{'frameset'}) {
                   6501: 	$result .= &help_menu_js();
                   6502:     }
1.319     albertel 6503: 
1.314     albertel 6504:     if (ref($args->{'redirect'})) {
1.414     albertel 6505: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6506: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6507: 	if (!$inhibit_continue) {
                   6508: 	    $env{'internal.head.redirect'} = $url;
                   6509: 	}
1.313     albertel 6510: 	$result.=<<ADDMETA
                   6511: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6512: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6513: ADDMETA
                   6514:     }
1.306     albertel 6515:     if (!defined($title)) {
                   6516: 	$title = 'The LearningOnline Network with CAPA';
                   6517:     }
1.460     albertel 6518:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6519:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6520: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6521: 	.$head_extra;
1.306     albertel 6522:     return $result;
                   6523: }
                   6524: 
                   6525: =pod
                   6526: 
1.340     albertel 6527: =item * &font_settings()
                   6528: 
                   6529: Returns neccessary <meta> to set the proper encoding
                   6530: 
                   6531: Inputs: none
                   6532: 
                   6533: =cut
                   6534: 
                   6535: sub font_settings {
                   6536:     my $headerstring='';
1.647     www      6537:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6538: 	$headerstring.=
                   6539: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6540:     }
                   6541:     return $headerstring;
                   6542: }
                   6543: 
1.341     albertel 6544: =pod
                   6545: 
                   6546: =item * &xml_begin()
                   6547: 
                   6548: Returns the needed doctype and <html>
                   6549: 
                   6550: Inputs: none
                   6551: 
                   6552: =cut
                   6553: 
                   6554: sub xml_begin {
                   6555:     my $output='';
                   6556: 
1.592     albertel 6557:     if ($env{'internal.start_page'}==1) {
                   6558: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6559:     }
1.342     albertel 6560: 
1.341     albertel 6561:     if ($env{'browser.mathml'}) {
                   6562: 	$output='<?xml version="1.0"?>'
                   6563:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6564: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6565:             
                   6566: #	    .'<!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">] >'
                   6567: 	    .'<!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">'
                   6568:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6569: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6570:     } else {
1.849     bisitz   6571: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6572:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6573:     }
                   6574:     return $output;
                   6575: }
1.340     albertel 6576: 
                   6577: =pod
                   6578: 
1.306     albertel 6579: =item * &endheadtag()
                   6580: 
                   6581: Returns a uniform </head> for LON-CAPA web pages.
                   6582: 
                   6583: Inputs: none
                   6584: 
                   6585: =cut
                   6586: 
                   6587: sub endheadtag {
                   6588:     return '</head>';
                   6589: }
                   6590: 
                   6591: =pod
                   6592: 
                   6593: =item * &head()
                   6594: 
                   6595: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6596: 
1.648     raeburn  6597: Inputs:
                   6598: 
                   6599: =over 4
                   6600: 
                   6601: $title - optional title for the page
                   6602: 
                   6603: $head_extra - optional extra HTML to put inside the <head>
                   6604: 
                   6605: =back
1.405     albertel 6606: 
1.306     albertel 6607: =cut
                   6608: 
                   6609: sub head {
1.325     albertel 6610:     my ($title,$head_extra,$args) = @_;
                   6611:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6612: }
                   6613: 
                   6614: =pod
                   6615: 
                   6616: =item * &start_page()
                   6617: 
                   6618: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6619: 
1.648     raeburn  6620: Inputs:
                   6621: 
                   6622: =over 4
                   6623: 
                   6624: $title - optional title for the page
                   6625: 
                   6626: $head_extra - optional extra HTML to incude inside the <head>
                   6627: 
                   6628: $args - additional optional args supported are:
                   6629: 
                   6630: =over 8
                   6631: 
                   6632:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6633:                                     arg on
1.814     bisitz   6634:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6635:              add_entries    -> additional attributes to add to the  <body>
                   6636:              domain         -> force to color decorate a page for a 
1.317     albertel 6637:                                     specific domain
1.648     raeburn  6638:              function       -> force usage of a specific rolish color
1.317     albertel 6639:                                     scheme
1.648     raeburn  6640:              redirect       -> see &headtag()
                   6641:              bgcolor        -> override the default page bg color
                   6642:              js_ready       -> return a string ready for being used in 
1.317     albertel 6643:                                     a javascript writeln
1.648     raeburn  6644:              html_encode    -> return a string ready for being used in 
1.320     albertel 6645:                                     a html attribute
1.648     raeburn  6646:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6647:                                     $forcereg arg
1.648     raeburn  6648:              frameset       -> if true will start with a <frameset>
1.330     albertel 6649:                                     rather than <body>
1.648     raeburn  6650:              skip_phases    -> hash ref of 
1.338     albertel 6651:                                     head -> skip the <html><head> generation
                   6652:                                     body -> skip all <body> generation
1.648     raeburn  6653:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6654:                                     'Switch To Inline Menu' link
1.648     raeburn  6655:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6656:              inherit_jsmath -> when creating popup window in a page,
                   6657:                                     should it have jsmath forced on by the
                   6658:                                     current page
1.867     kalberla 6659:              bread_crumbs ->             Array containing breadcrumbs
                   6660:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6661: 
1.648     raeburn  6662: =back
1.460     albertel 6663: 
1.648     raeburn  6664: =back
1.562     albertel 6665: 
1.306     albertel 6666: =cut
                   6667: 
                   6668: sub start_page {
1.309     albertel 6669:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6670:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6671:     my %head_args;
1.352     albertel 6672:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6673: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6674: 		     'no_auto_mt_title') {
1.319     albertel 6675: 	if (defined($args->{$arg})) {
1.324     raeburn  6676: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6677: 	}
1.313     albertel 6678:     }
1.319     albertel 6679: 
1.315     albertel 6680:     $env{'internal.start_page'}++;
1.338     albertel 6681:     my $result;
                   6682:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6683: 	$result.=
1.341     albertel 6684: 	    &xml_begin().
1.338     albertel 6685: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6686:     }
                   6687:     
                   6688:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6689: 	if ($args->{'frameset'}) {
                   6690: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6691: 						$args->{'add_entries'});
                   6692: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6693:         } else {
                   6694:             $result .=
                   6695:                 &bodytag($title, 
                   6696:                          $args->{'function'},       $args->{'add_entries'},
                   6697:                          $args->{'only_body'},      $args->{'domain'},
                   6698:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6699:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6700:                          $args);
                   6701:         }
1.330     albertel 6702:     }
1.338     albertel 6703: 
1.315     albertel 6704:     if ($args->{'js_ready'}) {
1.713     kaisler  6705: 		$result = &js_ready($result);
1.315     albertel 6706:     }
1.320     albertel 6707:     if ($args->{'html_encode'}) {
1.713     kaisler  6708: 		$result = &html_encode($result);
                   6709:     }
                   6710: 
1.813     bisitz   6711:     # Preparation for new and consistent functionlist at top of screen
                   6712:     # if ($args->{'functionlist'}) {
                   6713:     #            $result .= &build_functionlist();
                   6714:     #}
                   6715: 
                   6716:     # Don't add anything more if only_body wanted
                   6717:     return $result if $args->{'only_body'};
                   6718: 
                   6719:     #Breadcrumbs
1.758     kaisler  6720:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6721: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6722: 		#if any br links exists, add them to the breadcrumbs
                   6723: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6724: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6725: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6726: 			}
                   6727: 		}
                   6728: 
                   6729: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6730: 		if(exists($args->{'bread_crumbs_component'})){
                   6731: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6732: 		}else{
                   6733: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6734: 		}
1.320     albertel 6735:     }
1.315     albertel 6736:     return $result;
1.306     albertel 6737: }
                   6738: 
1.330     albertel 6739: 
1.306     albertel 6740: =pod
                   6741: 
                   6742: =item * &head()
                   6743: 
                   6744: Returns a complete </body></html> section for LON-CAPA web pages.
                   6745: 
1.315     albertel 6746: Inputs:         $args - additional optional args supported are:
                   6747:                  js_ready     -> return a string ready for being used in 
                   6748:                                  a javascript writeln
1.320     albertel 6749:                  html_encode  -> return a string ready for being used in 
                   6750:                                  a html attribute
1.330     albertel 6751:                  frameset     -> if true will start with a <frameset>
                   6752:                                  rather than <body>
1.493     albertel 6753:                  dicsussion   -> if true will get discussion from
                   6754:                                   lonxml::xmlend
                   6755:                                  (you can pass the target and parser arguments
                   6756:                                   through optional 'target' and 'parser' args
                   6757:                                   to this routine)
1.306     albertel 6758: 
                   6759: =cut
                   6760: 
                   6761: sub end_page {
1.315     albertel 6762:     my ($args) = @_;
                   6763:     $env{'internal.end_page'}++;
1.330     albertel 6764:     my $result;
1.335     albertel 6765:     if ($args->{'discussion'}) {
                   6766: 	my ($target,$parser);
                   6767: 	if (ref($args->{'discussion'})) {
                   6768: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6769: 				$args->{'discussion'}{'parser'});
                   6770: 	}
                   6771: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6772:     }
                   6773: 
1.330     albertel 6774:     if ($args->{'frameset'}) {
                   6775: 	$result .= '</frameset>';
                   6776:     } else {
1.635     raeburn  6777: 	$result .= &endbodytag($args);
1.330     albertel 6778:     }
                   6779:     $result .= "\n</html>";
                   6780: 
1.315     albertel 6781:     if ($args->{'js_ready'}) {
1.317     albertel 6782: 	$result = &js_ready($result);
1.315     albertel 6783:     }
1.335     albertel 6784: 
1.320     albertel 6785:     if ($args->{'html_encode'}) {
                   6786: 	$result = &html_encode($result);
                   6787:     }
1.335     albertel 6788: 
1.315     albertel 6789:     return $result;
                   6790: }
                   6791: 
1.320     albertel 6792: sub html_encode {
                   6793:     my ($result) = @_;
                   6794: 
1.322     albertel 6795:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6796:     
                   6797:     return $result;
                   6798: }
1.317     albertel 6799: sub js_ready {
                   6800:     my ($result) = @_;
                   6801: 
1.323     albertel 6802:     $result =~ s/[\n\r]/ /xmsg;
                   6803:     $result =~ s/\\/\\\\/xmsg;
                   6804:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6805:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6806:     
                   6807:     return $result;
                   6808: }
                   6809: 
1.315     albertel 6810: sub validate_page {
                   6811:     if (  exists($env{'internal.start_page'})
1.316     albertel 6812: 	  &&     $env{'internal.start_page'} > 1) {
                   6813: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6814: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6815: 				 $ENV{'request.filename'});
1.315     albertel 6816:     }
                   6817:     if (  exists($env{'internal.end_page'})
1.316     albertel 6818: 	  &&     $env{'internal.end_page'} > 1) {
                   6819: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6820: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6821: 				 $env{'request.filename'});
1.315     albertel 6822:     }
                   6823:     if (     exists($env{'internal.start_page'})
                   6824: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6825: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6826: 				 $env{'request.filename'});
1.315     albertel 6827:     }
                   6828:     if (   ! exists($env{'internal.start_page'})
                   6829: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6830: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6831: 				 $env{'request.filename'});
1.315     albertel 6832:     }
1.306     albertel 6833: }
1.315     albertel 6834: 
1.318     albertel 6835: sub simple_error_page {
                   6836:     my ($r,$title,$msg) = @_;
                   6837:     my $page =
                   6838: 	&Apache::loncommon::start_page($title).
                   6839: 	&mt($msg).
                   6840: 	&Apache::loncommon::end_page();
                   6841:     if (ref($r)) {
                   6842: 	$r->print($page);
1.327     albertel 6843: 	return;
1.318     albertel 6844:     }
                   6845:     return $page;
                   6846: }
1.347     albertel 6847: 
                   6848: {
1.610     albertel 6849:     my @row_count;
1.347     albertel 6850:     sub start_data_table {
1.422     albertel 6851: 	my ($add_class) = @_;
                   6852: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6853: 	unshift(@row_count,0);
1.422     albertel 6854: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6855:     }
                   6856: 
                   6857:     sub end_data_table {
1.610     albertel 6858: 	shift(@row_count);
1.389     albertel 6859: 	return '</table>'."\n";;
1.347     albertel 6860:     }
                   6861: 
                   6862:     sub start_data_table_row {
1.422     albertel 6863: 	my ($add_class) = @_;
1.610     albertel 6864: 	$row_count[0]++;
                   6865: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6866: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 6867: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6868:     }
1.471     banghart 6869:     
                   6870:     sub continue_data_table_row {
                   6871: 	my ($add_class) = @_;
1.610     albertel 6872: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6873: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 6874: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6875:     }
1.347     albertel 6876: 
                   6877:     sub end_data_table_row {
1.389     albertel 6878: 	return '</tr>'."\n";;
1.347     albertel 6879:     }
1.367     www      6880: 
1.421     albertel 6881:     sub start_data_table_empty_row {
1.707     bisitz   6882: #	$row_count[0]++;
1.421     albertel 6883: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6884:     }
                   6885: 
                   6886:     sub end_data_table_empty_row {
                   6887: 	return '</tr>'."\n";;
                   6888:     }
                   6889: 
1.367     www      6890:     sub start_data_table_header_row {
1.389     albertel 6891: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6892:     }
                   6893: 
                   6894:     sub end_data_table_header_row {
1.389     albertel 6895: 	return '</tr>'."\n";;
1.367     www      6896:     }
1.890     droeschl 6897: 
                   6898:     sub data_table_caption {
                   6899:         my $caption = shift;
                   6900:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6901:     }
1.347     albertel 6902: }
                   6903: 
1.548     albertel 6904: =pod
                   6905: 
                   6906: =item * &inhibit_menu_check($arg)
                   6907: 
                   6908: Checks for a inhibitmenu state and generates output to preserve it
                   6909: 
                   6910: Inputs:         $arg - can be any of
                   6911:                      - undef - in which case the return value is a string 
                   6912:                                to add  into arguments list of a uri
                   6913:                      - 'input' - in which case the return value is a HTML
                   6914:                                  <form> <input> field of type hidden to
                   6915:                                  preserve the value
                   6916:                      - a url - in which case the return value is the url with
                   6917:                                the neccesary cgi args added to preserve the
                   6918:                                inhibitmenu state
                   6919:                      - a ref to a url - no return value, but the string is
                   6920:                                         updated to include the neccessary cgi
                   6921:                                         args to preserve the inhibitmenu state
                   6922: 
                   6923: =cut
                   6924: 
                   6925: sub inhibit_menu_check {
                   6926:     my ($arg) = @_;
                   6927:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6928:     if ($arg eq 'input') {
                   6929: 	if ($env{'form.inhibitmenu'}) {
                   6930: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6931: 	} else {
                   6932: 	    return
                   6933: 	}
                   6934:     }
                   6935:     if ($env{'form.inhibitmenu'}) {
                   6936: 	if (ref($arg)) {
                   6937: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6938: 	} elsif ($arg eq '') {
                   6939: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6940: 	} else {
                   6941: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6942: 	}
                   6943:     }
                   6944:     if (!ref($arg)) {
                   6945: 	return $arg;
                   6946:     }
                   6947: }
                   6948: 
1.251     albertel 6949: ###############################################
1.182     matthew  6950: 
                   6951: =pod
                   6952: 
1.549     albertel 6953: =back
                   6954: 
                   6955: =head1 User Information Routines
                   6956: 
                   6957: =over 4
                   6958: 
1.405     albertel 6959: =item * &get_users_function()
1.182     matthew  6960: 
                   6961: Used by &bodytag to determine the current users primary role.
                   6962: Returns either 'student','coordinator','admin', or 'author'.
                   6963: 
                   6964: =cut
                   6965: 
                   6966: ###############################################
                   6967: sub get_users_function {
1.815     tempelho 6968:     my $function = 'norole';
1.818     tempelho 6969:     if ($env{'request.role'}=~/^(st)/) {
                   6970:         $function='student';
                   6971:     }
1.907     raeburn  6972:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  6973:         $function='coordinator';
                   6974:     }
1.258     albertel 6975:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6976:         $function='admin';
                   6977:     }
1.826     bisitz   6978:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6979:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6980:         $function='author';
                   6981:     }
                   6982:     return $function;
1.54      www      6983: }
1.99      www      6984: 
                   6985: ###############################################
                   6986: 
1.233     raeburn  6987: =pod
                   6988: 
1.821     raeburn  6989: =item * &show_course()
                   6990: 
                   6991: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   6992: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   6993: 
                   6994: Inputs:
                   6995: None
                   6996: 
                   6997: Outputs:
                   6998: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   6999: 
                   7000: =cut
                   7001: 
                   7002: ###############################################
                   7003: sub show_course {
                   7004:     my $course = !$env{'user.adv'};
                   7005:     if (!$env{'user.adv'}) {
                   7006:         foreach my $env (keys(%env)) {
                   7007:             next if ($env !~ m/^user\.priv\./);
                   7008:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7009:                 $course = 0;
                   7010:                 last;
                   7011:             }
                   7012:         }
                   7013:     }
                   7014:     return $course;
                   7015: }
                   7016: 
                   7017: ###############################################
                   7018: 
                   7019: =pod
                   7020: 
1.542     raeburn  7021: =item * &check_user_status()
1.274     raeburn  7022: 
                   7023: Determines current status of supplied role for a
                   7024: specific user. Roles can be active, previous or future.
                   7025: 
                   7026: Inputs: 
                   7027: user's domain, user's username, course's domain,
1.375     raeburn  7028: course's number, optional section ID.
1.274     raeburn  7029: 
                   7030: Outputs:
                   7031: role status: active, previous or future. 
                   7032: 
                   7033: =cut
                   7034: 
                   7035: sub check_user_status {
1.412     raeburn  7036:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7037:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7038:     my @uroles = keys %userinfo;
                   7039:     my $srchstr;
                   7040:     my $active_chk = 'none';
1.412     raeburn  7041:     my $now = time;
1.274     raeburn  7042:     if (@uroles > 0) {
1.908     raeburn  7043:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7044:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7045:         } else {
1.412     raeburn  7046:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7047:         }
                   7048:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7049:             my $role_end = 0;
                   7050:             my $role_start = 0;
                   7051:             $active_chk = 'active';
1.412     raeburn  7052:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7053:                 $role_end = $1;
                   7054:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7055:                     $role_start = $1;
1.274     raeburn  7056:                 }
                   7057:             }
                   7058:             if ($role_start > 0) {
1.412     raeburn  7059:                 if ($now < $role_start) {
1.274     raeburn  7060:                     $active_chk = 'future';
                   7061:                 }
                   7062:             }
                   7063:             if ($role_end > 0) {
1.412     raeburn  7064:                 if ($now > $role_end) {
1.274     raeburn  7065:                     $active_chk = 'previous';
                   7066:                 }
                   7067:             }
                   7068:         }
                   7069:     }
                   7070:     return $active_chk;
                   7071: }
                   7072: 
                   7073: ###############################################
                   7074: 
                   7075: =pod
                   7076: 
1.405     albertel 7077: =item * &get_sections()
1.233     raeburn  7078: 
                   7079: Determines all the sections for a course including
                   7080: sections with students and sections containing other roles.
1.419     raeburn  7081: Incoming parameters: 
                   7082: 
                   7083: 1. domain
                   7084: 2. course number 
                   7085: 3. reference to array containing roles for which sections should 
                   7086: be gathered (optional).
                   7087: 4. reference to array containing status types for which sections 
                   7088: should be gathered (optional).
                   7089: 
                   7090: If the third argument is undefined, sections are gathered for any role. 
                   7091: If the fourth argument is undefined, sections are gathered for any status.
                   7092: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7093:  
1.374     raeburn  7094: Returns section hash (keys are section IDs, values are
                   7095: number of users in each section), subject to the
1.419     raeburn  7096: optional roles filter, optional status filter 
1.233     raeburn  7097: 
                   7098: =cut
                   7099: 
                   7100: ###############################################
                   7101: sub get_sections {
1.419     raeburn  7102:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7103:     if (!defined($cdom) || !defined($cnum)) {
                   7104:         my $cid =  $env{'request.course.id'};
                   7105: 
                   7106: 	return if (!defined($cid));
                   7107: 
                   7108:         $cdom = $env{'course.'.$cid.'.domain'};
                   7109:         $cnum = $env{'course.'.$cid.'.num'};
                   7110:     }
                   7111: 
                   7112:     my %sectioncount;
1.419     raeburn  7113:     my $now = time;
1.240     albertel 7114: 
1.366     albertel 7115:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7116: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7117: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7118: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7119:         my $start_index = &Apache::loncoursedata::CL_START();
                   7120:         my $end_index = &Apache::loncoursedata::CL_END();
                   7121:         my $status;
1.366     albertel 7122: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7123: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7124: 				                     $data->[$status_index],
                   7125:                                                      $data->[$start_index],
                   7126:                                                      $data->[$end_index]);
                   7127:             if ($stu_status eq 'Active') {
                   7128:                 $status = 'active';
                   7129:             } elsif ($end < $now) {
                   7130:                 $status = 'previous';
                   7131:             } elsif ($start > $now) {
                   7132:                 $status = 'future';
                   7133:             } 
                   7134: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7135:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7136:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7137: 		    $sectioncount{$section}++;
                   7138:                 }
1.240     albertel 7139: 	    }
                   7140: 	}
                   7141:     }
                   7142:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7143:     foreach my $user (sort(keys(%courseroles))) {
                   7144: 	if ($user !~ /^(\w{2})/) { next; }
                   7145: 	my ($role) = ($user =~ /^(\w{2})/);
                   7146: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7147: 	my ($section,$status);
1.240     albertel 7148: 	if ($role eq 'cr' &&
                   7149: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7150: 	    $section=$1;
                   7151: 	}
                   7152: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7153: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7154:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7155:         if ($end == -1 && $start == -1) {
                   7156:             next; #deleted role
                   7157:         }
                   7158:         if (!defined($possible_status)) { 
                   7159:             $sectioncount{$section}++;
                   7160:         } else {
                   7161:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7162:                 $status = 'active';
                   7163:             } elsif ($end < $now) {
                   7164:                 $status = 'future';
                   7165:             } elsif ($start > $now) {
                   7166:                 $status = 'previous';
                   7167:             }
                   7168:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7169:                 $sectioncount{$section}++;
                   7170:             }
                   7171:         }
1.233     raeburn  7172:     }
1.366     albertel 7173:     return %sectioncount;
1.233     raeburn  7174: }
                   7175: 
1.274     raeburn  7176: ###############################################
1.294     raeburn  7177: 
                   7178: =pod
1.405     albertel 7179: 
                   7180: =item * &get_course_users()
                   7181: 
1.275     raeburn  7182: Retrieves usernames:domains for users in the specified course
                   7183: with specific role(s), and access status. 
                   7184: 
                   7185: Incoming parameters:
1.277     albertel 7186: 1. course domain
                   7187: 2. course number
                   7188: 3. access status: users must have - either active, 
1.275     raeburn  7189: previous, future, or all.
1.277     albertel 7190: 4. reference to array of permissible roles
1.288     raeburn  7191: 5. reference to array of section restrictions (optional)
                   7192: 6. reference to results object (hash of hashes).
                   7193: 7. reference to optional userdata hash
1.609     raeburn  7194: 8. reference to optional statushash
1.630     raeburn  7195: 9. flag if privileged users (except those set to unhide in
                   7196:    course settings) should be excluded    
1.609     raeburn  7197: Keys of top level results hash are roles.
1.275     raeburn  7198: Keys of inner hashes are username:domain, with 
                   7199: values set to access type.
1.288     raeburn  7200: Optional userdata hash returns an array with arguments in the 
                   7201: same order as loncoursedata::get_classlist() for student data.
                   7202: 
1.609     raeburn  7203: Optional statushash returns
                   7204: 
1.288     raeburn  7205: Entries for end, start, section and status are blank because
                   7206: of the possibility of multiple values for non-student roles.
                   7207: 
1.275     raeburn  7208: =cut
1.405     albertel 7209: 
1.275     raeburn  7210: ###############################################
1.405     albertel 7211: 
1.275     raeburn  7212: sub get_course_users {
1.630     raeburn  7213:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7214:     my %idx = ();
1.419     raeburn  7215:     my %seclists;
1.288     raeburn  7216: 
                   7217:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7218:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7219:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7220:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7221:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7222:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7223:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7224:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7225: 
1.290     albertel 7226:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7227:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7228:         my $now = time;
1.277     albertel 7229:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7230:             my $match = 0;
1.412     raeburn  7231:             my $secmatch = 0;
1.419     raeburn  7232:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7233:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7234:             if ($section eq '') {
                   7235:                 $section = 'none';
                   7236:             }
1.291     albertel 7237:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7238:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7239:                     $secmatch = 1;
                   7240:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7241:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7242:                         $secmatch = 1;
                   7243:                     }
                   7244:                 } else {  
1.419     raeburn  7245: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7246: 		        $secmatch = 1;
                   7247:                     }
1.290     albertel 7248: 		}
1.412     raeburn  7249:                 if (!$secmatch) {
                   7250:                     next;
                   7251:                 }
1.419     raeburn  7252:             }
1.275     raeburn  7253:             if (defined($$types{'active'})) {
1.288     raeburn  7254:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7255:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7256:                     $match = 1;
1.275     raeburn  7257:                 }
                   7258:             }
                   7259:             if (defined($$types{'previous'})) {
1.609     raeburn  7260:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7261:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7262:                     $match = 1;
1.275     raeburn  7263:                 }
                   7264:             }
                   7265:             if (defined($$types{'future'})) {
1.609     raeburn  7266:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7267:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7268:                     $match = 1;
1.275     raeburn  7269:                 }
                   7270:             }
1.609     raeburn  7271:             if ($match) {
                   7272:                 push(@{$seclists{$student}},$section);
                   7273:                 if (ref($userdata) eq 'HASH') {
                   7274:                     $$userdata{$student} = $$classlist{$student};
                   7275:                 }
                   7276:                 if (ref($statushash) eq 'HASH') {
                   7277:                     $statushash->{$student}{'st'}{$section} = $status;
                   7278:                 }
1.288     raeburn  7279:             }
1.275     raeburn  7280:         }
                   7281:     }
1.412     raeburn  7282:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7283:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7284:         my $now = time;
1.609     raeburn  7285:         my %displaystatus = ( previous => 'Expired',
                   7286:                               active   => 'Active',
                   7287:                               future   => 'Future',
                   7288:                             );
1.630     raeburn  7289:         my %nothide;
                   7290:         if ($hidepriv) {
                   7291:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7292:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7293:                 if ($user !~ /:/) {
                   7294:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7295:                 } else {
                   7296:                     $nothide{$user} = 1;
                   7297:                 }
                   7298:             }
                   7299:         }
1.439     raeburn  7300:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7301:             my $match = 0;
1.412     raeburn  7302:             my $secmatch = 0;
1.439     raeburn  7303:             my $status;
1.412     raeburn  7304:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7305:             $user =~ s/:$//;
1.439     raeburn  7306:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7307:             if ($end == -1 || $start == -1) {
                   7308:                 next;
                   7309:             }
                   7310:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7311:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7312:                 my ($uname,$udom) = split(/:/,$user);
                   7313:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7314:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7315:                         $secmatch = 1;
                   7316:                     } elsif ($usec eq '') {
1.420     albertel 7317:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7318:                             $secmatch = 1;
                   7319:                         }
                   7320:                     } else {
                   7321:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7322:                             $secmatch = 1;
                   7323:                         }
                   7324:                     }
                   7325:                     if (!$secmatch) {
                   7326:                         next;
                   7327:                     }
1.288     raeburn  7328:                 }
1.419     raeburn  7329:                 if ($usec eq '') {
                   7330:                     $usec = 'none';
                   7331:                 }
1.275     raeburn  7332:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7333:                     if ($hidepriv) {
                   7334:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7335:                             (!$nothide{$uname.':'.$udom})) {
                   7336:                             next;
                   7337:                         }
                   7338:                     }
1.503     raeburn  7339:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7340:                         $status = 'previous';
                   7341:                     } elsif ($start > $now) {
                   7342:                         $status = 'future';
                   7343:                     } else {
                   7344:                         $status = 'active';
                   7345:                     }
1.277     albertel 7346:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7347:                         if ($status eq $type) {
1.420     albertel 7348:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7349:                                 push(@{$$users{$role}{$user}},$type);
                   7350:                             }
1.288     raeburn  7351:                             $match = 1;
                   7352:                         }
                   7353:                     }
1.419     raeburn  7354:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7355:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7356: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7357:                         }
1.420     albertel 7358:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7359:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7360:                         }
1.609     raeburn  7361:                         if (ref($statushash) eq 'HASH') {
                   7362:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7363:                         }
1.275     raeburn  7364:                     }
                   7365:                 }
                   7366:             }
                   7367:         }
1.290     albertel 7368:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7369:             if ((defined($cdom)) && (defined($cnum))) {
                   7370:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7371:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7372:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7373:                     next if ($owner eq '');
                   7374:                     my ($ownername,$ownerdom);
                   7375:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7376:                         $ownername = $1;
                   7377:                         $ownerdom = $2;
                   7378:                     } else {
                   7379:                         $ownername = $owner;
                   7380:                         $ownerdom = $cdom;
                   7381:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7382:                     }
                   7383:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7384:                     if (defined($userdata) && 
1.609     raeburn  7385: 			!exists($$userdata{$owner})) {
                   7386: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7387:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7388:                             push(@{$seclists{$owner}},'none');
                   7389:                         }
                   7390:                         if (ref($statushash) eq 'HASH') {
                   7391:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7392:                         }
1.290     albertel 7393: 		    }
1.279     raeburn  7394:                 }
                   7395:             }
                   7396:         }
1.419     raeburn  7397:         foreach my $user (keys(%seclists)) {
                   7398:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7399:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7400:         }
1.275     raeburn  7401:     }
                   7402:     return;
                   7403: }
                   7404: 
1.288     raeburn  7405: sub get_user_info {
                   7406:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7407:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7408: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7409:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7410:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7411:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7412:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7413:     return;
                   7414: }
1.275     raeburn  7415: 
1.472     raeburn  7416: ###############################################
                   7417: 
                   7418: =pod
                   7419: 
                   7420: =item * &get_user_quota()
                   7421: 
                   7422: Retrieves quota assigned for storage of portfolio files for a user  
                   7423: 
                   7424: Incoming parameters:
                   7425: 1. user's username
                   7426: 2. user's domain
                   7427: 
                   7428: Returns:
1.536     raeburn  7429: 1. Disk quota (in Mb) assigned to student.
                   7430: 2. (Optional) Type of setting: custom or default
                   7431:    (individually assigned or default for user's 
                   7432:    institutional status).
                   7433: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7434:    or student - types as defined in localenroll::inst_usertypes 
                   7435:    for user's domain, which determines default quota for user.
                   7436: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7437: 
                   7438: If a value has been stored in the user's environment, 
1.536     raeburn  7439: it will return that, otherwise it returns the maximal default
                   7440: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7441: 
                   7442: =cut
                   7443: 
                   7444: ###############################################
                   7445: 
                   7446: 
                   7447: sub get_user_quota {
                   7448:     my ($uname,$udom) = @_;
1.536     raeburn  7449:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7450:     if (!defined($udom)) {
                   7451:         $udom = $env{'user.domain'};
                   7452:     }
                   7453:     if (!defined($uname)) {
                   7454:         $uname = $env{'user.name'};
                   7455:     }
                   7456:     if (($udom eq '' || $uname eq '') ||
                   7457:         ($udom eq 'public') && ($uname eq 'public')) {
                   7458:         $quota = 0;
1.536     raeburn  7459:         $quotatype = 'default';
                   7460:         $defquota = 0; 
1.472     raeburn  7461:     } else {
1.536     raeburn  7462:         my $inststatus;
1.472     raeburn  7463:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7464:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7465:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7466:         } else {
1.536     raeburn  7467:             my %userenv = 
                   7468:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7469:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7470:             my ($tmp) = keys(%userenv);
                   7471:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7472:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7473:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7474:             } else {
                   7475:                 undef(%userenv);
                   7476:             }
                   7477:         }
1.536     raeburn  7478:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7479:         if ($quota eq '') {
1.536     raeburn  7480:             $quota = $defquota;
                   7481:             $quotatype = 'default';
                   7482:         } else {
                   7483:             $quotatype = 'custom';
1.472     raeburn  7484:         }
                   7485:     }
1.536     raeburn  7486:     if (wantarray) {
                   7487:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7488:     } else {
                   7489:         return $quota;
                   7490:     }
1.472     raeburn  7491: }
                   7492: 
                   7493: ###############################################
                   7494: 
                   7495: =pod
                   7496: 
                   7497: =item * &default_quota()
                   7498: 
1.536     raeburn  7499: Retrieves default quota assigned for storage of user portfolio files,
                   7500: given an (optional) user's institutional status.
1.472     raeburn  7501: 
                   7502: Incoming parameters:
                   7503: 1. domain
1.536     raeburn  7504: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7505:    status types (e.g., faculty, staff, student etc.)
                   7506:    which apply to the user for whom the default is being retrieved.
                   7507:    If the institutional status string in undefined, the domain
                   7508:    default quota will be returned. 
1.472     raeburn  7509: 
                   7510: Returns:
                   7511: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7512: 2. (Optional) institutional type which determined the value of the
                   7513:    default quota.
1.472     raeburn  7514: 
                   7515: If a value has been stored in the domain's configuration db,
                   7516: it will return that, otherwise it returns 20 (for backwards 
                   7517: compatibility with domains which have not set up a configuration
                   7518: db file; the original statically defined portfolio quota was 20 Mb). 
                   7519: 
1.536     raeburn  7520: If the user's status includes multiple types (e.g., staff and student),
                   7521: the largest default quota which applies to the user determines the
                   7522: default quota returned.
                   7523: 
1.780     raeburn  7524: =back
                   7525: 
1.472     raeburn  7526: =cut
                   7527: 
                   7528: ###############################################
                   7529: 
                   7530: 
                   7531: sub default_quota {
1.536     raeburn  7532:     my ($udom,$inststatus) = @_;
                   7533:     my ($defquota,$settingstatus);
                   7534:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7535:                                             ['quotas'],$udom);
                   7536:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7537:         if ($inststatus ne '') {
1.765     raeburn  7538:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7539:             foreach my $item (@statuses) {
1.711     raeburn  7540:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7541:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7542:                         if ($defquota eq '') {
                   7543:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7544:                             $settingstatus = $item;
                   7545:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7546:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7547:                             $settingstatus = $item;
                   7548:                         }
                   7549:                     }
                   7550:                 } else {
                   7551:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7552:                         if ($defquota eq '') {
                   7553:                             $defquota = $quotahash{'quotas'}{$item};
                   7554:                             $settingstatus = $item;
                   7555:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7556:                             $defquota = $quotahash{'quotas'}{$item};
                   7557:                             $settingstatus = $item;
                   7558:                         }
1.536     raeburn  7559:                     }
                   7560:                 }
                   7561:             }
                   7562:         }
                   7563:         if ($defquota eq '') {
1.711     raeburn  7564:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7565:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7566:             } else {
                   7567:                 $defquota = $quotahash{'quotas'}{'default'};
                   7568:             }
1.536     raeburn  7569:             $settingstatus = 'default';
                   7570:         }
                   7571:     } else {
                   7572:         $settingstatus = 'default';
                   7573:         $defquota = 20;
                   7574:     }
                   7575:     if (wantarray) {
                   7576:         return ($defquota,$settingstatus);
1.472     raeburn  7577:     } else {
1.536     raeburn  7578:         return $defquota;
1.472     raeburn  7579:     }
                   7580: }
                   7581: 
1.384     raeburn  7582: sub get_secgrprole_info {
                   7583:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7584:     my %sections_count = &get_sections($cdom,$cnum);
                   7585:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7586:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7587:     my @groups = sort(keys(%curr_groups));
                   7588:     my $allroles = [];
                   7589:     my $rolehash;
                   7590:     my $accesshash = {
                   7591:                      active => 'Currently has access',
                   7592:                      future => 'Will have future access',
                   7593:                      previous => 'Previously had access',
                   7594:                   };
                   7595:     if ($needroles) {
                   7596:         $rolehash = {'all' => 'all'};
1.385     albertel 7597:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7598: 	if (&Apache::lonnet::error(%user_roles)) {
                   7599: 	    undef(%user_roles);
                   7600: 	}
                   7601:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7602:             my ($role)=split(/\:/,$item,2);
                   7603:             if ($role eq 'cr') { next; }
                   7604:             if ($role =~ /^cr/) {
                   7605:                 $$rolehash{$role} = (split('/',$role))[3];
                   7606:             } else {
                   7607:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7608:             }
                   7609:         }
                   7610:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7611:             push(@{$allroles},$key);
                   7612:         }
                   7613:         push (@{$allroles},'st');
                   7614:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7615:     }
                   7616:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7617: }
                   7618: 
1.555     raeburn  7619: sub user_picker {
1.627     raeburn  7620:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7621:     my $currdom = $dom;
                   7622:     my %curr_selected = (
                   7623:                         srchin => 'dom',
1.580     raeburn  7624:                         srchby => 'lastname',
1.555     raeburn  7625:                       );
                   7626:     my $srchterm;
1.625     raeburn  7627:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7628:         if ($srch->{'srchby'} ne '') {
                   7629:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7630:         }
                   7631:         if ($srch->{'srchin'} ne '') {
                   7632:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7633:         }
                   7634:         if ($srch->{'srchtype'} ne '') {
                   7635:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7636:         }
                   7637:         if ($srch->{'srchdomain'} ne '') {
                   7638:             $currdom = $srch->{'srchdomain'};
                   7639:         }
                   7640:         $srchterm = $srch->{'srchterm'};
                   7641:     }
                   7642:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7643:                     'usr'       => 'Search criteria',
1.563     raeburn  7644:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7645:                     'uname'     => 'username',
                   7646:                     'lastname'  => 'last name',
1.555     raeburn  7647:                     'lastfirst' => 'last name, first name',
1.558     albertel 7648:                     'crs'       => 'in this course',
1.576     raeburn  7649:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7650:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7651:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7652:                     'exact'     => 'is',
                   7653:                     'contains'  => 'contains',
1.569     raeburn  7654:                     'begins'    => 'begins with',
1.571     raeburn  7655:                     'youm'      => "You must include some text to search for.",
                   7656:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7657:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7658:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7659:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7660:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7661:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7662:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7663:                                        );
1.563     raeburn  7664:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7665:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7666: 
                   7667:     my @srchins = ('crs','dom','alc','instd');
                   7668: 
                   7669:     foreach my $option (@srchins) {
                   7670:         # FIXME 'alc' option unavailable until 
                   7671:         #       loncreateuser::print_user_query_page()
                   7672:         #       has been completed.
                   7673:         next if ($option eq 'alc');
1.880     raeburn  7674:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7675:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7676:         if ($curr_selected{'srchin'} eq $option) {
                   7677:             $srchinsel .= ' 
                   7678:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7679:         } else {
                   7680:             $srchinsel .= '
                   7681:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7682:         }
1.555     raeburn  7683:     }
1.563     raeburn  7684:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7685: 
                   7686:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7687:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7688:         if ($curr_selected{'srchby'} eq $option) {
                   7689:             $srchbysel .= '
                   7690:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7691:         } else {
                   7692:             $srchbysel .= '
                   7693:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7694:          }
                   7695:     }
                   7696:     $srchbysel .= "\n  </select>\n";
                   7697: 
                   7698:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7699:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7700:         if ($curr_selected{'srchtype'} eq $option) {
                   7701:             $srchtypesel .= '
                   7702:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7703:         } else {
                   7704:             $srchtypesel .= '
                   7705:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7706:         }
                   7707:     }
                   7708:     $srchtypesel .= "\n  </select>\n";
                   7709: 
1.558     albertel 7710:     my ($newuserscript,$new_user_create);
1.556     raeburn  7711: 
                   7712:     if ($forcenewuser) {
1.576     raeburn  7713:         if (ref($srch) eq 'HASH') {
                   7714:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7715:                 if ($cancreate) {
                   7716:                     $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>';
                   7717:                 } else {
1.799     bisitz   7718:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7719:                     my %usertypetext = (
                   7720:                         official   => 'institutional',
                   7721:                         unofficial => 'non-institutional',
                   7722:                     );
1.799     bisitz   7723:                     $new_user_create = '<p class="LC_warning">'
                   7724:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7725:                                       .' '
                   7726:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7727:                                           ,'<a href="'.$helplink.'">','</a>')
                   7728:                                       .'</p><br />';
1.627     raeburn  7729:                 }
1.576     raeburn  7730:             }
                   7731:         }
                   7732: 
1.556     raeburn  7733:         $newuserscript = <<"ENDSCRIPT";
                   7734: 
1.570     raeburn  7735: function setSearch(createnew,callingForm) {
1.556     raeburn  7736:     if (createnew == 1) {
1.570     raeburn  7737:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7738:             if (callingForm.srchby.options[i].value == 'uname') {
                   7739:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7740:             }
                   7741:         }
1.570     raeburn  7742:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7743:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7744: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7745:             }
                   7746:         }
1.570     raeburn  7747:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7748:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7749:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7750:             }
                   7751:         }
1.570     raeburn  7752:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7753:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7754:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7755:             }
                   7756:         }
                   7757:     }
                   7758: }
                   7759: ENDSCRIPT
1.558     albertel 7760: 
1.556     raeburn  7761:     }
                   7762: 
1.555     raeburn  7763:     my $output = <<"END_BLOCK";
1.556     raeburn  7764: <script type="text/javascript">
1.824     bisitz   7765: // <![CDATA[
1.570     raeburn  7766: function validateEntry(callingForm) {
1.558     albertel 7767: 
1.556     raeburn  7768:     var checkok = 1;
1.558     albertel 7769:     var srchin;
1.570     raeburn  7770:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7771: 	if ( callingForm.srchin[i].checked ) {
                   7772: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7773: 	}
                   7774:     }
                   7775: 
1.570     raeburn  7776:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7777:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7778:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7779:     var srchterm =  callingForm.srchterm.value;
                   7780:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7781:     var msg = "";
                   7782: 
                   7783:     if (srchterm == "") {
                   7784:         checkok = 0;
1.571     raeburn  7785:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7786:     }
                   7787: 
1.569     raeburn  7788:     if (srchtype== 'begins') {
                   7789:         if (srchterm.length < 2) {
                   7790:             checkok = 0;
1.571     raeburn  7791:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7792:         }
                   7793:     }
                   7794: 
1.556     raeburn  7795:     if (srchtype== 'contains') {
                   7796:         if (srchterm.length < 3) {
                   7797:             checkok = 0;
1.571     raeburn  7798:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7799:         }
                   7800:     }
                   7801:     if (srchin == 'instd') {
                   7802:         if (srchdomain == '') {
                   7803:             checkok = 0;
1.571     raeburn  7804:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7805:         }
                   7806:     }
                   7807:     if (srchin == 'dom') {
                   7808:         if (srchdomain == '') {
                   7809:             checkok = 0;
1.571     raeburn  7810:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7811:         }
                   7812:     }
                   7813:     if (srchby == 'lastfirst') {
                   7814:         if (srchterm.indexOf(",") == -1) {
                   7815:             checkok = 0;
1.571     raeburn  7816:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7817:         }
                   7818:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7819:             checkok = 0;
1.571     raeburn  7820:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7821:         }
                   7822:     }
                   7823:     if (checkok == 0) {
1.571     raeburn  7824:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7825:         return;
                   7826:     }
                   7827:     if (checkok == 1) {
1.570     raeburn  7828:         callingForm.submit();
1.556     raeburn  7829:     }
                   7830: }
                   7831: 
                   7832: $newuserscript
                   7833: 
1.824     bisitz   7834: // ]]>
1.556     raeburn  7835: </script>
1.558     albertel 7836: 
                   7837: $new_user_create
                   7838: 
1.555     raeburn  7839: END_BLOCK
1.558     albertel 7840: 
1.876     raeburn  7841:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7842:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7843:                $domform.
                   7844:                &Apache::lonhtmlcommon::row_closure().
                   7845:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7846:                $srchbysel.
                   7847:                $srchtypesel. 
                   7848:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7849:                $srchinsel.
                   7850:                &Apache::lonhtmlcommon::row_closure(1). 
                   7851:                &Apache::lonhtmlcommon::end_pick_box().
                   7852:                '<br />';
1.555     raeburn  7853:     return $output;
                   7854: }
                   7855: 
1.612     raeburn  7856: sub user_rule_check {
1.615     raeburn  7857:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7858:     my $response;
                   7859:     if (ref($usershash) eq 'HASH') {
                   7860:         foreach my $user (keys(%{$usershash})) {
                   7861:             my ($uname,$udom) = split(/:/,$user);
                   7862:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7863:             my ($id,$newuser);
1.612     raeburn  7864:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7865:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7866:                 $id = $usershash->{$user}->{'id'};
                   7867:             }
                   7868:             my $inst_response;
                   7869:             if (ref($checks) eq 'HASH') {
                   7870:                 if (defined($checks->{'username'})) {
1.615     raeburn  7871:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7872:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7873:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7874:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7875:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7876:                 }
1.615     raeburn  7877:             } else {
                   7878:                 ($inst_response,%{$inst_results->{$user}}) =
                   7879:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7880:                 return;
1.612     raeburn  7881:             }
1.615     raeburn  7882:             if (!$got_rules->{$udom}) {
1.612     raeburn  7883:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7884:                                                   ['usercreation'],$udom);
                   7885:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7886:                     foreach my $item ('username','id') {
1.612     raeburn  7887:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7888:                             $$curr_rules{$udom}{$item} = 
                   7889:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7890:                         }
                   7891:                     }
                   7892:                 }
1.615     raeburn  7893:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7894:             }
1.612     raeburn  7895:             foreach my $item (keys(%{$checks})) {
                   7896:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7897:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7898:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7899:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7900:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7901:                                 if ($rule_check{$rule}) {
                   7902:                                     $$rulematch{$user}{$item} = $rule;
                   7903:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7904:                                         if (ref($inst_results) eq 'HASH') {
                   7905:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7906:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7907:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7908:                                                 }
1.612     raeburn  7909:                                             }
                   7910:                                         }
1.615     raeburn  7911:                                     }
                   7912:                                     last;
1.585     raeburn  7913:                                 }
                   7914:                             }
                   7915:                         }
                   7916:                     }
                   7917:                 }
                   7918:             }
                   7919:         }
                   7920:     }
1.612     raeburn  7921:     return;
                   7922: }
                   7923: 
                   7924: sub user_rule_formats {
                   7925:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7926:     my %text = ( 
                   7927:                  'username' => 'Usernames',
                   7928:                  'id'       => 'IDs',
                   7929:                );
                   7930:     my $output;
                   7931:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7932:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7933:         if (@{$ruleorder} > 0) {
                   7934:             $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>';
                   7935:             foreach my $rule (@{$ruleorder}) {
                   7936:                 if (ref($curr_rules) eq 'ARRAY') {
                   7937:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7938:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7939:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7940:                                         $rules->{$rule}{'desc'}.'</li>';
                   7941:                         }
                   7942:                     }
                   7943:                 }
                   7944:             }
                   7945:             $output .= '</ul>';
                   7946:         }
                   7947:     }
                   7948:     return $output;
                   7949: }
                   7950: 
                   7951: sub instrule_disallow_msg {
1.615     raeburn  7952:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7953:     my $response;
                   7954:     my %text = (
                   7955:                   item   => 'username',
                   7956:                   items  => 'usernames',
                   7957:                   match  => 'matches',
                   7958:                   do     => 'does',
                   7959:                   action => 'a username',
                   7960:                   one    => 'one',
                   7961:                );
                   7962:     if ($count > 1) {
                   7963:         $text{'item'} = 'usernames';
                   7964:         $text{'match'} ='match';
                   7965:         $text{'do'} = 'do';
                   7966:         $text{'action'} = 'usernames',
                   7967:         $text{'one'} = 'ones';
                   7968:     }
                   7969:     if ($checkitem eq 'id') {
                   7970:         $text{'items'} = 'IDs';
                   7971:         $text{'item'} = 'ID';
                   7972:         $text{'action'} = 'an ID';
1.615     raeburn  7973:         if ($count > 1) {
                   7974:             $text{'item'} = 'IDs';
                   7975:             $text{'action'} = 'IDs';
                   7976:         }
1.612     raeburn  7977:     }
1.674     bisitz   7978:     $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  7979:     if ($mode eq 'upload') {
                   7980:         if ($checkitem eq 'username') {
                   7981:             $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'}.");
                   7982:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7983:             $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  7984:         }
1.669     raeburn  7985:     } elsif ($mode eq 'selfcreate') {
                   7986:         if ($checkitem eq 'id') {
                   7987:             $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.");
                   7988:         }
1.615     raeburn  7989:     } else {
                   7990:         if ($checkitem eq 'username') {
                   7991:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   7992:         } elsif ($checkitem eq 'id') {
                   7993:             $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.");
                   7994:         }
1.612     raeburn  7995:     }
                   7996:     return $response;
1.585     raeburn  7997: }
                   7998: 
1.624     raeburn  7999: sub personal_data_fieldtitles {
                   8000:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8001:                         id => 'Student/Employee ID',
                   8002:                         permanentemail => 'E-mail address',
                   8003:                         lastname => 'Last Name',
                   8004:                         firstname => 'First Name',
                   8005:                         middlename => 'Middle Name',
                   8006:                         generation => 'Generation',
                   8007:                         gen => 'Generation',
1.765     raeburn  8008:                         inststatus => 'Affiliation',
1.624     raeburn  8009:                    );
                   8010:     return %fieldtitles;
                   8011: }
                   8012: 
1.642     raeburn  8013: sub sorted_inst_types {
                   8014:     my ($dom) = @_;
                   8015:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8016:     my $othertitle = &mt('All users');
                   8017:     if ($env{'request.course.id'}) {
1.668     raeburn  8018:         $othertitle  = &mt('Any users');
1.642     raeburn  8019:     }
                   8020:     my @types;
                   8021:     if (ref($order) eq 'ARRAY') {
                   8022:         @types = @{$order};
                   8023:     }
                   8024:     if (@types == 0) {
                   8025:         if (ref($usertypes) eq 'HASH') {
                   8026:             @types = sort(keys(%{$usertypes}));
                   8027:         }
                   8028:     }
                   8029:     if (keys(%{$usertypes}) > 0) {
                   8030:         $othertitle = &mt('Other users');
                   8031:     }
                   8032:     return ($othertitle,$usertypes,\@types);
                   8033: }
                   8034: 
1.645     raeburn  8035: sub get_institutional_codes {
                   8036:     my ($settings,$allcourses,$LC_code) = @_;
                   8037: # Get complete list of course sections to update
                   8038:     my @currsections = ();
                   8039:     my @currxlists = ();
                   8040:     my $coursecode = $$settings{'internal.coursecode'};
                   8041: 
                   8042:     if ($$settings{'internal.sectionnums'} ne '') {
                   8043:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8044:     }
                   8045: 
                   8046:     if ($$settings{'internal.crosslistings'} ne '') {
                   8047:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8048:     }
                   8049: 
                   8050:     if (@currxlists > 0) {
                   8051:         foreach (@currxlists) {
                   8052:             if (m/^([^:]+):(\w*)$/) {
                   8053:                 unless (grep/^$1$/,@{$allcourses}) {
                   8054:                     push @{$allcourses},$1;
                   8055:                     $$LC_code{$1} = $2;
                   8056:                 }
                   8057:             }
                   8058:         }
                   8059:     }
                   8060:  
                   8061:     if (@currsections > 0) {
                   8062:         foreach (@currsections) {
                   8063:             if (m/^(\w+):(\w*)$/) {
                   8064:                 my $sec = $coursecode.$1;
                   8065:                 my $lc_sec = $2;
                   8066:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8067:                     push @{$allcourses},$sec;
                   8068:                     $$LC_code{$sec} = $lc_sec;
                   8069:                 }
                   8070:             }
                   8071:         }
                   8072:     }
                   8073:     return;
                   8074: }
                   8075: 
1.112     bowersj2 8076: =pod
                   8077: 
1.780     raeburn  8078: =head1 Slot Helpers
                   8079: 
                   8080: =over 4
                   8081: 
                   8082: =item * sorted_slots()
                   8083: 
                   8084: Sorts an array of slot names in order of slot start time (earliest first). 
                   8085: 
                   8086: Inputs:
                   8087: 
                   8088: =over 4
                   8089: 
                   8090: slotsarr  - Reference to array of unsorted slot names.
                   8091: 
                   8092: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8093: 
1.549     albertel 8094: =back
                   8095: 
1.780     raeburn  8096: Returns:
                   8097: 
                   8098: =over 4
                   8099: 
                   8100: sorted   - An array of slot names sorted by the start time of the slot.
                   8101: 
                   8102: =back
                   8103: 
                   8104: =back
                   8105: 
                   8106: =cut
                   8107: 
                   8108: 
                   8109: sub sorted_slots {
                   8110:     my ($slotsarr,$slots) = @_;
                   8111:     my @sorted;
                   8112:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8113:         @sorted =
                   8114:             sort {
                   8115:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8116:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8117:                      }
                   8118:                      if (ref($slots->{$a})) { return -1;}
                   8119:                      if (ref($slots->{$b})) { return 1;}
                   8120:                      return 0;
                   8121:                  } @{$slotsarr};
                   8122:     }
                   8123:     return @sorted;
                   8124: }
                   8125: 
                   8126: 
                   8127: =pod
                   8128: 
1.549     albertel 8129: =head1 HTTP Helpers
                   8130: 
                   8131: =over 4
                   8132: 
1.648     raeburn  8133: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8134: 
1.258     albertel 8135: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8136: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8137: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8138: 
                   8139: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8140: $possible_names is an ref to an array of form element names.  As an example:
                   8141: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8142: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8143: 
                   8144: =cut
1.1       albertel 8145: 
1.6       albertel 8146: sub get_unprocessed_cgi {
1.25      albertel 8147:   my ($query,$possible_names)= @_;
1.26      matthew  8148:   # $Apache::lonxml::debug=1;
1.356     albertel 8149:   foreach my $pair (split(/&/,$query)) {
                   8150:     my ($name, $value) = split(/=/,$pair);
1.369     www      8151:     $name = &unescape($name);
1.25      albertel 8152:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8153:       $value =~ tr/+/ /;
                   8154:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8155:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8156:     }
1.16      harris41 8157:   }
1.6       albertel 8158: }
                   8159: 
1.112     bowersj2 8160: =pod
                   8161: 
1.648     raeburn  8162: =item * &cacheheader() 
1.112     bowersj2 8163: 
                   8164: returns cache-controlling header code
                   8165: 
                   8166: =cut
                   8167: 
1.7       albertel 8168: sub cacheheader {
1.258     albertel 8169:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8170:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8171:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8172:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8173:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8174:     return $output;
1.7       albertel 8175: }
                   8176: 
1.112     bowersj2 8177: =pod
                   8178: 
1.648     raeburn  8179: =item * &no_cache($r) 
1.112     bowersj2 8180: 
                   8181: specifies header code to not have cache
                   8182: 
                   8183: =cut
                   8184: 
1.9       albertel 8185: sub no_cache {
1.216     albertel 8186:     my ($r) = @_;
                   8187:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8188: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8189:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8190:     $r->no_cache(1);
                   8191:     $r->header_out("Expires" => $date);
                   8192:     $r->header_out("Pragma" => "no-cache");
1.123     www      8193: }
                   8194: 
                   8195: sub content_type {
1.181     albertel 8196:     my ($r,$type,$charset) = @_;
1.299     foxr     8197:     if ($r) {
                   8198: 	#  Note that printout.pl calls this with undef for $r.
                   8199: 	&no_cache($r);
                   8200:     }
1.258     albertel 8201:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8202:     unless ($charset) {
                   8203: 	$charset=&Apache::lonlocal::current_encoding;
                   8204:     }
                   8205:     if ($charset) { $type.='; charset='.$charset; }
                   8206:     if ($r) {
                   8207: 	$r->content_type($type);
                   8208:     } else {
                   8209: 	print("Content-type: $type\n\n");
                   8210:     }
1.9       albertel 8211: }
1.25      albertel 8212: 
1.112     bowersj2 8213: =pod
                   8214: 
1.648     raeburn  8215: =item * &add_to_env($name,$value) 
1.112     bowersj2 8216: 
1.258     albertel 8217: adds $name to the %env hash with value
1.112     bowersj2 8218: $value, if $name already exists, the entry is converted to an array
                   8219: reference and $value is added to the array.
                   8220: 
                   8221: =cut
                   8222: 
1.25      albertel 8223: sub add_to_env {
                   8224:   my ($name,$value)=@_;
1.258     albertel 8225:   if (defined($env{$name})) {
                   8226:     if (ref($env{$name})) {
1.25      albertel 8227:       #already have multiple values
1.258     albertel 8228:       push(@{ $env{$name} },$value);
1.25      albertel 8229:     } else {
                   8230:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8231:       my $first=$env{$name};
                   8232:       undef($env{$name});
                   8233:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8234:     }
                   8235:   } else {
1.258     albertel 8236:     $env{$name}=$value;
1.25      albertel 8237:   }
1.31      albertel 8238: }
1.149     albertel 8239: 
                   8240: =pod
                   8241: 
1.648     raeburn  8242: =item * &get_env_multiple($name) 
1.149     albertel 8243: 
1.258     albertel 8244: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8245: values may be defined and end up as an array ref.
                   8246: 
                   8247: returns an array of values
                   8248: 
                   8249: =cut
                   8250: 
                   8251: sub get_env_multiple {
                   8252:     my ($name) = @_;
                   8253:     my @values;
1.258     albertel 8254:     if (defined($env{$name})) {
1.149     albertel 8255:         # exists is it an array
1.258     albertel 8256:         if (ref($env{$name})) {
                   8257:             @values=@{ $env{$name} };
1.149     albertel 8258:         } else {
1.258     albertel 8259:             $values[0]=$env{$name};
1.149     albertel 8260:         }
                   8261:     }
                   8262:     return(@values);
                   8263: }
                   8264: 
1.660     raeburn  8265: sub ask_for_embedded_content {
                   8266:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8267:     my $upload_output = '
                   8268:    <form name="upload_embedded" action="'.$actionurl.'"
                   8269:                   method="post" enctype="multipart/form-data">';
                   8270:     $upload_output .= $state;
1.661     raeburn  8271:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8272: 
                   8273:     my $num = 0;
                   8274:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8275:         $upload_output .= &start_data_table_row().
                   8276:             '<td>'.$embed_file.'</td><td>';
                   8277:         if ($args->{'ignore_remote_references'}
                   8278:             && $embed_file =~ m{^\w+://}) {
                   8279:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8280:         } elsif ($args->{'error_on_invalid_names'}
                   8281:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8282: 
                   8283:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8284: 
                   8285:         } else {
                   8286:             $upload_output .='
1.661     raeburn  8287:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8288:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8289:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8290:             $upload_output .=
                   8291:                 "\n\t\t".
                   8292:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8293:                 $attrib.'" />';
                   8294:             if (exists($$codebase{$embed_file})) {
                   8295:                 $upload_output .=
                   8296:                     "\n\t\t".
                   8297:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8298:                     &escape($$codebase{$embed_file}).'" />';
                   8299:             }
                   8300:         }
                   8301:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8302:         $num++;
                   8303:     }
                   8304:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8305:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8306:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8307:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8308:    </form>';
                   8309:     return $upload_output;
                   8310: }
                   8311: 
1.661     raeburn  8312: sub upload_embedded {
                   8313:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8314:         $current_disk_usage) = @_;
                   8315:     my $output;
                   8316:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8317:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8318:         my $orig_uploaded_filename =
                   8319:             $env{'form.embedded_item_'.$i.'.filename'};
                   8320: 
                   8321:         $env{'form.embedded_orig_'.$i} =
                   8322:             &unescape($env{'form.embedded_orig_'.$i});
                   8323:         my ($path,$fname) =
                   8324:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8325:         # no path, whole string is fname
                   8326:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8327: 
                   8328:         $path = $env{'form.currentpath'}.$path;
                   8329:         $fname = &Apache::lonnet::clean_filename($fname);
                   8330:         # See if there is anything left
                   8331:         next if ($fname eq '');
                   8332: 
                   8333:         # Check if file already exists as a file or directory.
                   8334:         my ($state,$msg);
                   8335:         if ($context eq 'portfolio') {
                   8336:             my $port_path = $dirpath;
                   8337:             if ($group ne '') {
                   8338:                 $port_path = "groups/$group/$port_path";
                   8339:             }
                   8340:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8341:                                               $dir_root,$port_path,$disk_quota,
                   8342:                                               $current_disk_usage,$uname,$udom);
                   8343:             if ($state eq 'will_exceed_quota'
                   8344:                 || $state eq 'file_locked'
                   8345:                 || $state eq 'file_exists' ) {
                   8346:                 $output .= $msg;
                   8347:                 next;
                   8348:             }
                   8349:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8350:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8351:             if ($state eq 'exists') {
                   8352:                 $output .= $msg;
                   8353:                 next;
                   8354:             }
                   8355:         }
                   8356:         # Check if extension is valid
                   8357:         if (($fname =~ /\.(\w+)$/) &&
                   8358:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8359:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8360:             next;
                   8361:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8362:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8363:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8364:             next;
                   8365:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8366:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8367:             next;
                   8368:         }
                   8369: 
                   8370:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8371:         if ($context eq 'portfolio') {
                   8372:             my $result=
                   8373:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8374:                                                 $dirpath.$path);
                   8375:             if ($result !~ m|^/uploaded/|) {
                   8376:                 $output .= '<span class="LC_error">'
                   8377:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8378:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8379:                       .'</span><br />';
                   8380:                 next;
                   8381:             } else {
                   8382:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8383:                            $path.$fname.'</span>').'</p>';     
                   8384:             }
                   8385:         } else {
                   8386: # Save the file
                   8387:             my $target = $env{'form.embedded_item_'.$i};
                   8388:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8389:             my $dest = $fullpath.$fname;
                   8390:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8391:             my @parts=split(/\//,$fullpath);
                   8392:             my $count;
                   8393:             my $filepath = $dir_root;
                   8394:             for ($count=4;$count<=$#parts;$count++) {
                   8395:                 $filepath .= "/$parts[$count]";
                   8396:                 if ((-e $filepath)!=1) {
                   8397:                     mkdir($filepath,0770);
                   8398:                 }
                   8399:             }
                   8400:             my $fh;
                   8401:             if (!open($fh,'>'.$dest)) {
                   8402:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8403:                 $output .= '<span class="LC_error">'.
                   8404:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8405:                            '</span><br />';
                   8406:             } else {
                   8407:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8408:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8409:                     $output .= '<span class="LC_error">'.
                   8410:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8411:                               '</span><br />';
                   8412:                 } else {
                   8413:                     if ($context eq 'testbank') {
                   8414:                         $output .= &mt('Embedded file uploaded successfully:').
                   8415:                                    '&nbsp;<a href="'.$url.'">'.
                   8416:                                    $orig_uploaded_filename.'</a><br />';
                   8417:                     } else {
1.705     tempelho 8418:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8419:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8420:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8421:                     }
                   8422:                 }
                   8423:                 close($fh);
                   8424:             }
                   8425:         }
                   8426:     }
                   8427:     return $output;
                   8428: }
                   8429: 
                   8430: sub check_for_existing {
                   8431:     my ($path,$fname,$element) = @_;
                   8432:     my ($state,$msg);
                   8433:     if (-d $path.'/'.$fname) {
                   8434:         $state = 'exists';
                   8435:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8436:     } elsif (-e $path.'/'.$fname) {
                   8437:         $state = 'exists';
                   8438:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8439:     }
                   8440:     if ($state eq 'exists') {
                   8441:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8442:     }
                   8443:     return ($state,$msg);
                   8444: }
                   8445: 
                   8446: sub check_for_upload {
                   8447:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8448:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8449:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8450:     my $getpropath = 1;
                   8451:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8452:                                             $getpropath);
                   8453:     my $found_file = 0;
                   8454:     my $locked_file = 0;
                   8455:     foreach my $line (@dir_list) {
                   8456:         my ($file_name)=split(/\&/,$line,2);
                   8457:         if ($file_name eq $fname){
                   8458:             $file_name = $path.$file_name;
                   8459:             if ($group ne '') {
                   8460:                 $file_name = $group.$file_name;
                   8461:             }
                   8462:             $found_file = 1;
                   8463:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8464:                 $locked_file = 1;
                   8465:             }
                   8466:         }
                   8467:     }
                   8468:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8469:         my $msg = '<span class="LC_error">'.
                   8470:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8471:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8472:         return ('will_exceed_quota',$msg);
                   8473:     } elsif ($found_file) {
                   8474:         if ($locked_file) {
                   8475:             my $msg = '<span class="LC_error">';
                   8476:             $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>');
                   8477:             $msg .= '</span><br />';
                   8478:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8479:             return ('file_locked',$msg);
                   8480:         } else {
                   8481:             my $msg = '<span class="LC_error">';
                   8482:             $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'});
                   8483:             $msg .= '</span>';
                   8484:             $msg .= '<br />';
                   8485:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8486:             return ('file_exists',$msg);
                   8487:         }
                   8488:     }
                   8489: }
                   8490: 
1.31      albertel 8491: 
1.41      ng       8492: =pod
1.45      matthew  8493: 
1.464     albertel 8494: =back
1.41      ng       8495: 
1.112     bowersj2 8496: =head1 CSV Upload/Handling functions
1.38      albertel 8497: 
1.41      ng       8498: =over 4
                   8499: 
1.648     raeburn  8500: =item * &upfile_store($r)
1.41      ng       8501: 
                   8502: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8503: needs $env{'form.upfile'}
1.41      ng       8504: returns $datatoken to be put into hidden field
                   8505: 
                   8506: =cut
1.31      albertel 8507: 
                   8508: sub upfile_store {
                   8509:     my $r=shift;
1.258     albertel 8510:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8511:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8512:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8513:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8514: 
1.258     albertel 8515:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8516: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8517:     {
1.158     raeburn  8518:         my $datafile = $r->dir_config('lonDaemons').
                   8519:                            '/tmp/'.$datatoken.'.tmp';
                   8520:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8521:             print $fh $env{'form.upfile'};
1.158     raeburn  8522:             close($fh);
                   8523:         }
1.31      albertel 8524:     }
                   8525:     return $datatoken;
                   8526: }
                   8527: 
1.56      matthew  8528: =pod
                   8529: 
1.648     raeburn  8530: =item * &load_tmp_file($r)
1.41      ng       8531: 
                   8532: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8533: needs $env{'form.datatoken'},
                   8534: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8535: 
                   8536: =cut
1.31      albertel 8537: 
                   8538: sub load_tmp_file {
                   8539:     my $r=shift;
                   8540:     my @studentdata=();
                   8541:     {
1.158     raeburn  8542:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8543:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8544:         if ( open(my $fh,"<$studentfile") ) {
                   8545:             @studentdata=<$fh>;
                   8546:             close($fh);
                   8547:         }
1.31      albertel 8548:     }
1.258     albertel 8549:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8550: }
                   8551: 
1.56      matthew  8552: =pod
                   8553: 
1.648     raeburn  8554: =item * &upfile_record_sep()
1.41      ng       8555: 
                   8556: Separate uploaded file into records
                   8557: returns array of records,
1.258     albertel 8558: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8559: 
                   8560: =cut
1.31      albertel 8561: 
                   8562: sub upfile_record_sep {
1.258     albertel 8563:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8564:     } else {
1.248     albertel 8565: 	my @records;
1.258     albertel 8566: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8567: 	    if ($line=~/^\s*$/) { next; }
                   8568: 	    push(@records,$line);
                   8569: 	}
                   8570: 	return @records;
1.31      albertel 8571:     }
                   8572: }
                   8573: 
1.56      matthew  8574: =pod
                   8575: 
1.648     raeburn  8576: =item * &record_sep($record)
1.41      ng       8577: 
1.258     albertel 8578: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8579: 
                   8580: =cut
                   8581: 
1.263     www      8582: sub takeleft {
                   8583:     my $index=shift;
                   8584:     return substr('0000'.$index,-4,4);
                   8585: }
                   8586: 
1.31      albertel 8587: sub record_sep {
                   8588:     my $record=shift;
                   8589:     my %components=();
1.258     albertel 8590:     if ($env{'form.upfiletype'} eq 'xml') {
                   8591:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8592:         my $i=0;
1.356     albertel 8593:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8594:             $field=~s/^(\"|\')//;
                   8595:             $field=~s/(\"|\')$//;
1.263     www      8596:             $components{&takeleft($i)}=$field;
1.31      albertel 8597:             $i++;
                   8598:         }
1.258     albertel 8599:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8600:         my $i=0;
1.356     albertel 8601:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8602:             $field=~s/^(\"|\')//;
                   8603:             $field=~s/(\"|\')$//;
1.263     www      8604:             $components{&takeleft($i)}=$field;
1.31      albertel 8605:             $i++;
                   8606:         }
                   8607:     } else {
1.561     www      8608:         my $separator=',';
1.480     banghart 8609:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8610:             $separator=';';
1.480     banghart 8611:         }
1.31      albertel 8612:         my $i=0;
1.561     www      8613: # the character we are looking for to indicate the end of a quote or a record 
                   8614:         my $looking_for=$separator;
                   8615: # do not add the characters to the fields
                   8616:         my $ignore=0;
                   8617: # we just encountered a separator (or the beginning of the record)
                   8618:         my $just_found_separator=1;
                   8619: # store the field we are working on here
                   8620:         my $field='';
                   8621: # work our way through all characters in record
                   8622:         foreach my $character ($record=~/(.)/g) {
                   8623:             if ($character eq $looking_for) {
                   8624:                if ($character ne $separator) {
                   8625: # Found the end of a quote, again looking for separator
                   8626:                   $looking_for=$separator;
                   8627:                   $ignore=1;
                   8628:                } else {
                   8629: # Found a separator, store away what we got
                   8630:                   $components{&takeleft($i)}=$field;
                   8631: 	          $i++;
                   8632:                   $just_found_separator=1;
                   8633:                   $ignore=0;
                   8634:                   $field='';
                   8635:                }
                   8636:                next;
                   8637:             }
                   8638: # single or double quotation marks after a separator indicate beginning of a quote
                   8639: # we are now looking for the end of the quote and need to ignore separators
                   8640:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8641:                $looking_for=$character;
                   8642:                next;
                   8643:             }
                   8644: # ignore would be true after we reached the end of a quote
                   8645:             if ($ignore) { next; }
                   8646:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8647:             $field.=$character;
                   8648:             $just_found_separator=0; 
1.31      albertel 8649:         }
1.561     www      8650: # catch the very last entry, since we never encountered the separator
                   8651:         $components{&takeleft($i)}=$field;
1.31      albertel 8652:     }
                   8653:     return %components;
                   8654: }
                   8655: 
1.144     matthew  8656: ######################################################
                   8657: ######################################################
                   8658: 
1.56      matthew  8659: =pod
                   8660: 
1.648     raeburn  8661: =item * &upfile_select_html()
1.41      ng       8662: 
1.144     matthew  8663: Return HTML code to select a file from the users machine and specify 
                   8664: the file type.
1.41      ng       8665: 
                   8666: =cut
                   8667: 
1.144     matthew  8668: ######################################################
                   8669: ######################################################
1.31      albertel 8670: sub upfile_select_html {
1.144     matthew  8671:     my %Types = (
                   8672:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8673:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8674:                  space => &mt('Space separated'),
                   8675:                  tab   => &mt('Tabulator separated'),
                   8676: #                 xml   => &mt('HTML/XML'),
                   8677:                  );
                   8678:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8679:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8680:     foreach my $type (sort(keys(%Types))) {
                   8681:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8682:     }
                   8683:     $Str .= "</select>\n";
                   8684:     return $Str;
1.31      albertel 8685: }
                   8686: 
1.301     albertel 8687: sub get_samples {
                   8688:     my ($records,$toget) = @_;
                   8689:     my @samples=({});
                   8690:     my $got=0;
                   8691:     foreach my $rec (@$records) {
                   8692: 	my %temp = &record_sep($rec);
                   8693: 	if (! grep(/\S/, values(%temp))) { next; }
                   8694: 	if (%temp) {
                   8695: 	    $samples[$got]=\%temp;
                   8696: 	    $got++;
                   8697: 	    if ($got == $toget) { last; }
                   8698: 	}
                   8699:     }
                   8700:     return \@samples;
                   8701: }
                   8702: 
1.144     matthew  8703: ######################################################
                   8704: ######################################################
                   8705: 
1.56      matthew  8706: =pod
                   8707: 
1.648     raeburn  8708: =item * &csv_print_samples($r,$records)
1.41      ng       8709: 
                   8710: Prints a table of sample values from each column uploaded $r is an
                   8711: Apache Request ref, $records is an arrayref from
                   8712: &Apache::loncommon::upfile_record_sep
                   8713: 
                   8714: =cut
                   8715: 
1.144     matthew  8716: ######################################################
                   8717: ######################################################
1.31      albertel 8718: sub csv_print_samples {
                   8719:     my ($r,$records) = @_;
1.662     bisitz   8720:     my $samples = &get_samples($records,5);
1.301     albertel 8721: 
1.594     raeburn  8722:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8723:               &start_data_table_header_row());
1.356     albertel 8724:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8725:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8726:     $r->print(&end_data_table_header_row());
1.301     albertel 8727:     foreach my $hash (@$samples) {
1.594     raeburn  8728: 	$r->print(&start_data_table_row());
1.356     albertel 8729: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8730: 	    $r->print('<td>');
1.356     albertel 8731: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8732: 	    $r->print('</td>');
                   8733: 	}
1.594     raeburn  8734: 	$r->print(&end_data_table_row());
1.31      albertel 8735:     }
1.594     raeburn  8736:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8737: }
                   8738: 
1.144     matthew  8739: ######################################################
                   8740: ######################################################
                   8741: 
1.56      matthew  8742: =pod
                   8743: 
1.648     raeburn  8744: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8745: 
                   8746: Prints a table to create associations between values and table columns.
1.144     matthew  8747: 
1.41      ng       8748: $r is an Apache Request ref,
                   8749: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8750: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8751: 
                   8752: =cut
                   8753: 
1.144     matthew  8754: ######################################################
                   8755: ######################################################
1.31      albertel 8756: sub csv_print_select_table {
                   8757:     my ($r,$records,$d) = @_;
1.301     albertel 8758:     my $i=0;
                   8759:     my $samples = &get_samples($records,1);
1.144     matthew  8760:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8761: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8762:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8763:               '<th>'.&mt('Column').'</th>'.
                   8764:               &end_data_table_header_row()."\n");
1.356     albertel 8765:     foreach my $array_ref (@$d) {
                   8766: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8767: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8768: 
1.875     bisitz   8769: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8770: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8771: 	$r->print('<option value="none"></option>');
1.356     albertel 8772: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8773: 	    $r->print('<option value="'.$sample.'"'.
                   8774:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8775:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8776: 	}
1.594     raeburn  8777: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8778: 	$i++;
                   8779:     }
1.594     raeburn  8780:     $r->print(&end_data_table());
1.31      albertel 8781:     $i--;
                   8782:     return $i;
                   8783: }
1.56      matthew  8784: 
1.144     matthew  8785: ######################################################
                   8786: ######################################################
                   8787: 
1.56      matthew  8788: =pod
1.31      albertel 8789: 
1.648     raeburn  8790: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8791: 
                   8792: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8793: 
                   8794: $r is an Apache Request ref,
                   8795: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8796: $d is an array of 2 element arrays (internal name, displayed name)
                   8797: 
                   8798: =cut
                   8799: 
1.144     matthew  8800: ######################################################
                   8801: ######################################################
1.31      albertel 8802: sub csv_samples_select_table {
                   8803:     my ($r,$records,$d) = @_;
                   8804:     my $i=0;
1.144     matthew  8805:     #
1.662     bisitz   8806:     my $max_samples = 5;
                   8807:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8808:     $r->print(&start_data_table().
                   8809:               &start_data_table_header_row().'<th>'.
                   8810:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8811:               &end_data_table_header_row());
1.301     albertel 8812: 
                   8813:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8814: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8815: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8816: 	foreach my $option (@$d) {
                   8817: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8818: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8819:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8820:                       $display.'</option>');
1.31      albertel 8821: 	}
                   8822: 	$r->print('</select></td><td>');
1.662     bisitz   8823: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8824: 	    if (defined($samples->[$line]{$key})) { 
                   8825: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8826: 	    }
                   8827: 	}
1.594     raeburn  8828: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8829: 	$i++;
                   8830:     }
1.594     raeburn  8831:     $r->print(&end_data_table());
1.31      albertel 8832:     $i--;
                   8833:     return($i);
1.115     matthew  8834: }
                   8835: 
1.144     matthew  8836: ######################################################
                   8837: ######################################################
                   8838: 
1.115     matthew  8839: =pod
                   8840: 
1.648     raeburn  8841: =item * &clean_excel_name($name)
1.115     matthew  8842: 
                   8843: Returns a replacement for $name which does not contain any illegal characters.
                   8844: 
                   8845: =cut
                   8846: 
1.144     matthew  8847: ######################################################
                   8848: ######################################################
1.115     matthew  8849: sub clean_excel_name {
                   8850:     my ($name) = @_;
                   8851:     $name =~ s/[:\*\?\/\\]//g;
                   8852:     if (length($name) > 31) {
                   8853:         $name = substr($name,0,31);
                   8854:     }
                   8855:     return $name;
1.25      albertel 8856: }
1.84      albertel 8857: 
1.85      albertel 8858: =pod
                   8859: 
1.648     raeburn  8860: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8861: 
                   8862: Returns either 1 or undef
                   8863: 
                   8864: 1 if the part is to be hidden, undef if it is to be shown
                   8865: 
                   8866: Arguments are:
                   8867: 
                   8868: $id the id of the part to be checked
                   8869: $symb, optional the symb of the resource to check
                   8870: $udom, optional the domain of the user to check for
                   8871: $uname, optional the username of the user to check for
                   8872: 
                   8873: =cut
1.84      albertel 8874: 
                   8875: sub check_if_partid_hidden {
                   8876:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8877:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8878: 					 $symb,$udom,$uname);
1.141     albertel 8879:     my $truth=1;
                   8880:     #if the string starts with !, then the list is the list to show not hide
                   8881:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8882:     my @hiddenlist=split(/,/,$hiddenparts);
                   8883:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8884: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8885:     }
1.141     albertel 8886:     return !$truth;
1.84      albertel 8887: }
1.127     matthew  8888: 
1.138     matthew  8889: 
                   8890: ############################################################
                   8891: ############################################################
                   8892: 
                   8893: =pod
                   8894: 
1.157     matthew  8895: =back 
                   8896: 
1.138     matthew  8897: =head1 cgi-bin script and graphing routines
                   8898: 
1.157     matthew  8899: =over 4
                   8900: 
1.648     raeburn  8901: =item * &get_cgi_id()
1.138     matthew  8902: 
                   8903: Inputs: none
                   8904: 
                   8905: Returns an id which can be used to pass environment variables
                   8906: to various cgi-bin scripts.  These environment variables will
                   8907: be removed from the users environment after a given time by
                   8908: the routine &Apache::lonnet::transfer_profile_to_env.
                   8909: 
                   8910: =cut
                   8911: 
                   8912: ############################################################
                   8913: ############################################################
1.152     albertel 8914: my $uniq=0;
1.136     matthew  8915: sub get_cgi_id {
1.154     albertel 8916:     $uniq=($uniq+1)%100000;
1.280     albertel 8917:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8918: }
                   8919: 
1.127     matthew  8920: ############################################################
                   8921: ############################################################
                   8922: 
                   8923: =pod
                   8924: 
1.648     raeburn  8925: =item * &DrawBarGraph()
1.127     matthew  8926: 
1.138     matthew  8927: Facilitates the plotting of data in a (stacked) bar graph.
                   8928: Puts plot definition data into the users environment in order for 
                   8929: graph.png to plot it.  Returns an <img> tag for the plot.
                   8930: The bars on the plot are labeled '1','2',...,'n'.
                   8931: 
                   8932: Inputs:
                   8933: 
                   8934: =over 4
                   8935: 
                   8936: =item $Title: string, the title of the plot
                   8937: 
                   8938: =item $xlabel: string, text describing the X-axis of the plot
                   8939: 
                   8940: =item $ylabel: string, text describing the Y-axis of the plot
                   8941: 
                   8942: =item $Max: scalar, the maximum Y value to use in the plot
                   8943: If $Max is < any data point, the graph will not be rendered.
                   8944: 
1.140     matthew  8945: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8946: they are plotted.  If undefined, default values will be used.
                   8947: 
1.178     matthew  8948: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8949: 
1.138     matthew  8950: =item @Values: An array of array references.  Each array reference holds data
                   8951: to be plotted in a stacked bar chart.
                   8952: 
1.239     matthew  8953: =item If the final element of @Values is a hash reference the key/value
                   8954: pairs will be added to the graph definition.
                   8955: 
1.138     matthew  8956: =back
                   8957: 
                   8958: Returns:
                   8959: 
                   8960: An <img> tag which references graph.png and the appropriate identifying
                   8961: information for the plot.
                   8962: 
1.127     matthew  8963: =cut
                   8964: 
                   8965: ############################################################
                   8966: ############################################################
1.134     matthew  8967: sub DrawBarGraph {
1.178     matthew  8968:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8969:     #
                   8970:     if (! defined($colors)) {
                   8971:         $colors = ['#33ff00', 
                   8972:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8973:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8974:                   ]; 
                   8975:     }
1.228     matthew  8976:     my $extra_settings = {};
                   8977:     if (ref($Values[-1]) eq 'HASH') {
                   8978:         $extra_settings = pop(@Values);
                   8979:     }
1.127     matthew  8980:     #
1.136     matthew  8981:     my $identifier = &get_cgi_id();
                   8982:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8983:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  8984:         return '';
                   8985:     }
1.225     matthew  8986:     #
                   8987:     my @Labels;
                   8988:     if (defined($labels)) {
                   8989:         @Labels = @$labels;
                   8990:     } else {
                   8991:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   8992:             push (@Labels,$i+1);
                   8993:         }
                   8994:     }
                   8995:     #
1.129     matthew  8996:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  8997:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  8998:     my %ValuesHash;
                   8999:     my $NumSets=1;
                   9000:     foreach my $array (@Values) {
                   9001:         next if (! ref($array));
1.136     matthew  9002:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9003:             join(',',@$array);
1.129     matthew  9004:     }
1.127     matthew  9005:     #
1.136     matthew  9006:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9007:     if ($NumBars < 3) {
                   9008:         $width = 120+$NumBars*32;
1.220     matthew  9009:         $xskip = 1;
1.225     matthew  9010:         $bar_width = 30;
                   9011:     } elsif ($NumBars < 5) {
                   9012:         $width = 120+$NumBars*20;
                   9013:         $xskip = 1;
                   9014:         $bar_width = 20;
1.220     matthew  9015:     } elsif ($NumBars < 10) {
1.136     matthew  9016:         $width = 120+$NumBars*15;
                   9017:         $xskip = 1;
                   9018:         $bar_width = 15;
                   9019:     } elsif ($NumBars <= 25) {
                   9020:         $width = 120+$NumBars*11;
                   9021:         $xskip = 5;
                   9022:         $bar_width = 8;
                   9023:     } elsif ($NumBars <= 50) {
                   9024:         $width = 120+$NumBars*8;
                   9025:         $xskip = 5;
                   9026:         $bar_width = 4;
                   9027:     } else {
                   9028:         $width = 120+$NumBars*8;
                   9029:         $xskip = 5;
                   9030:         $bar_width = 4;
                   9031:     }
                   9032:     #
1.137     matthew  9033:     $Max = 1 if ($Max < 1);
                   9034:     if ( int($Max) < $Max ) {
                   9035:         $Max++;
                   9036:         $Max = int($Max);
                   9037:     }
1.127     matthew  9038:     $Title  = '' if (! defined($Title));
                   9039:     $xlabel = '' if (! defined($xlabel));
                   9040:     $ylabel = '' if (! defined($ylabel));
1.369     www      9041:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9042:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9043:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9044:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9045:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9046:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9047:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9048:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9049:     $ValuesHash{$id.'.height'}   = $height;
                   9050:     $ValuesHash{$id.'.width'}    = $width;
                   9051:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9052:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9053:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9054:     #
1.228     matthew  9055:     # Deal with other parameters
                   9056:     while (my ($key,$value) = each(%$extra_settings)) {
                   9057:         $ValuesHash{$id.'.'.$key} = $value;
                   9058:     }
                   9059:     #
1.646     raeburn  9060:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9061:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9062: }
                   9063: 
                   9064: ############################################################
                   9065: ############################################################
                   9066: 
                   9067: =pod
                   9068: 
1.648     raeburn  9069: =item * &DrawXYGraph()
1.137     matthew  9070: 
1.138     matthew  9071: Facilitates the plotting of data in an XY graph.
                   9072: Puts plot definition data into the users environment in order for 
                   9073: graph.png to plot it.  Returns an <img> tag for the plot.
                   9074: 
                   9075: Inputs:
                   9076: 
                   9077: =over 4
                   9078: 
                   9079: =item $Title: string, the title of the plot
                   9080: 
                   9081: =item $xlabel: string, text describing the X-axis of the plot
                   9082: 
                   9083: =item $ylabel: string, text describing the Y-axis of the plot
                   9084: 
                   9085: =item $Max: scalar, the maximum Y value to use in the plot
                   9086: If $Max is < any data point, the graph will not be rendered.
                   9087: 
                   9088: =item $colors: Array ref containing the hex color codes for the data to be 
                   9089: plotted in.  If undefined, default values will be used.
                   9090: 
                   9091: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9092: 
                   9093: =item $Ydata: Array ref containing Array refs.  
1.185     www      9094: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9095: 
                   9096: =item %Values: hash indicating or overriding any default values which are 
                   9097: passed to graph.png.  
                   9098: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9099: 
                   9100: =back
                   9101: 
                   9102: Returns:
                   9103: 
                   9104: An <img> tag which references graph.png and the appropriate identifying
                   9105: information for the plot.
                   9106: 
1.137     matthew  9107: =cut
                   9108: 
                   9109: ############################################################
                   9110: ############################################################
                   9111: sub DrawXYGraph {
                   9112:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9113:     #
                   9114:     # Create the identifier for the graph
                   9115:     my $identifier = &get_cgi_id();
                   9116:     my $id = 'cgi.'.$identifier;
                   9117:     #
                   9118:     $Title  = '' if (! defined($Title));
                   9119:     $xlabel = '' if (! defined($xlabel));
                   9120:     $ylabel = '' if (! defined($ylabel));
                   9121:     my %ValuesHash = 
                   9122:         (
1.369     www      9123:          $id.'.title'  => &escape($Title),
                   9124:          $id.'.xlabel' => &escape($xlabel),
                   9125:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9126:          $id.'.y_max_value'=> $Max,
                   9127:          $id.'.labels'     => join(',',@$Xlabels),
                   9128:          $id.'.PlotType'   => 'XY',
                   9129:          );
                   9130:     #
                   9131:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9132:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9133:     }
                   9134:     #
                   9135:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9136:         return '';
                   9137:     }
                   9138:     my $NumSets=1;
1.138     matthew  9139:     foreach my $array (@{$Ydata}){
1.137     matthew  9140:         next if (! ref($array));
                   9141:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9142:     }
1.138     matthew  9143:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9144:     #
                   9145:     # Deal with other parameters
                   9146:     while (my ($key,$value) = each(%Values)) {
                   9147:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9148:     }
                   9149:     #
1.646     raeburn  9150:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9151:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9152: }
                   9153: 
                   9154: ############################################################
                   9155: ############################################################
                   9156: 
                   9157: =pod
                   9158: 
1.648     raeburn  9159: =item * &DrawXYYGraph()
1.138     matthew  9160: 
                   9161: Facilitates the plotting of data in an XY graph with two Y axes.
                   9162: Puts plot definition data into the users environment in order for 
                   9163: graph.png to plot it.  Returns an <img> tag for the plot.
                   9164: 
                   9165: Inputs:
                   9166: 
                   9167: =over 4
                   9168: 
                   9169: =item $Title: string, the title of the plot
                   9170: 
                   9171: =item $xlabel: string, text describing the X-axis of the plot
                   9172: 
                   9173: =item $ylabel: string, text describing the Y-axis of the plot
                   9174: 
                   9175: =item $colors: Array ref containing the hex color codes for the data to be 
                   9176: plotted in.  If undefined, default values will be used.
                   9177: 
                   9178: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9179: 
                   9180: =item $Ydata1: The first data set
                   9181: 
                   9182: =item $Min1: The minimum value of the left Y-axis
                   9183: 
                   9184: =item $Max1: The maximum value of the left Y-axis
                   9185: 
                   9186: =item $Ydata2: The second data set
                   9187: 
                   9188: =item $Min2: The minimum value of the right Y-axis
                   9189: 
                   9190: =item $Max2: The maximum value of the left Y-axis
                   9191: 
                   9192: =item %Values: hash indicating or overriding any default values which are 
                   9193: passed to graph.png.  
                   9194: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9195: 
                   9196: =back
                   9197: 
                   9198: Returns:
                   9199: 
                   9200: An <img> tag which references graph.png and the appropriate identifying
                   9201: information for the plot.
1.136     matthew  9202: 
                   9203: =cut
                   9204: 
                   9205: ############################################################
                   9206: ############################################################
1.137     matthew  9207: sub DrawXYYGraph {
                   9208:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9209:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9210:     #
                   9211:     # Create the identifier for the graph
                   9212:     my $identifier = &get_cgi_id();
                   9213:     my $id = 'cgi.'.$identifier;
                   9214:     #
                   9215:     $Title  = '' if (! defined($Title));
                   9216:     $xlabel = '' if (! defined($xlabel));
                   9217:     $ylabel = '' if (! defined($ylabel));
                   9218:     my %ValuesHash = 
                   9219:         (
1.369     www      9220:          $id.'.title'  => &escape($Title),
                   9221:          $id.'.xlabel' => &escape($xlabel),
                   9222:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9223:          $id.'.labels' => join(',',@$Xlabels),
                   9224:          $id.'.PlotType' => 'XY',
                   9225:          $id.'.NumSets' => 2,
1.137     matthew  9226:          $id.'.two_axes' => 1,
                   9227:          $id.'.y1_max_value' => $Max1,
                   9228:          $id.'.y1_min_value' => $Min1,
                   9229:          $id.'.y2_max_value' => $Max2,
                   9230:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9231:          );
                   9232:     #
1.137     matthew  9233:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9234:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9235:     }
                   9236:     #
                   9237:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9238:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9239:         return '';
                   9240:     }
                   9241:     my $NumSets=1;
1.137     matthew  9242:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9243:         next if (! ref($array));
                   9244:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9245:     }
                   9246:     #
                   9247:     # Deal with other parameters
                   9248:     while (my ($key,$value) = each(%Values)) {
                   9249:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9250:     }
                   9251:     #
1.646     raeburn  9252:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9253:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9254: }
                   9255: 
                   9256: ############################################################
                   9257: ############################################################
                   9258: 
                   9259: =pod
                   9260: 
1.157     matthew  9261: =back 
                   9262: 
1.139     matthew  9263: =head1 Statistics helper routines?  
                   9264: 
                   9265: Bad place for them but what the hell.
                   9266: 
1.157     matthew  9267: =over 4
                   9268: 
1.648     raeburn  9269: =item * &chartlink()
1.139     matthew  9270: 
                   9271: Returns a link to the chart for a specific student.  
                   9272: 
                   9273: Inputs:
                   9274: 
                   9275: =over 4
                   9276: 
                   9277: =item $linktext: The text of the link
                   9278: 
                   9279: =item $sname: The students username
                   9280: 
                   9281: =item $sdomain: The students domain
                   9282: 
                   9283: =back
                   9284: 
1.157     matthew  9285: =back
                   9286: 
1.139     matthew  9287: =cut
                   9288: 
                   9289: ############################################################
                   9290: ############################################################
                   9291: sub chartlink {
                   9292:     my ($linktext, $sname, $sdomain) = @_;
                   9293:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9294:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9295:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9296:        '">'.$linktext.'</a>';
1.153     matthew  9297: }
                   9298: 
                   9299: #######################################################
                   9300: #######################################################
                   9301: 
                   9302: =pod
                   9303: 
                   9304: =head1 Course Environment Routines
1.157     matthew  9305: 
                   9306: =over 4
1.153     matthew  9307: 
1.648     raeburn  9308: =item * &restore_course_settings()
1.153     matthew  9309: 
1.648     raeburn  9310: =item * &store_course_settings()
1.153     matthew  9311: 
                   9312: Restores/Store indicated form parameters from the course environment.
                   9313: Will not overwrite existing values of the form parameters.
                   9314: 
                   9315: Inputs: 
                   9316: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9317: 
                   9318: a hash ref describing the data to be stored.  For example:
                   9319:    
                   9320: %Save_Parameters = ('Status' => 'scalar',
                   9321:     'chartoutputmode' => 'scalar',
                   9322:     'chartoutputdata' => 'scalar',
                   9323:     'Section' => 'array',
1.373     raeburn  9324:     'Group' => 'array',
1.153     matthew  9325:     'StudentData' => 'array',
                   9326:     'Maps' => 'array');
                   9327: 
                   9328: Returns: both routines return nothing
                   9329: 
1.631     raeburn  9330: =back
                   9331: 
1.153     matthew  9332: =cut
                   9333: 
                   9334: #######################################################
                   9335: #######################################################
                   9336: sub store_course_settings {
1.496     albertel 9337:     return &store_settings($env{'request.course.id'},@_);
                   9338: }
                   9339: 
                   9340: sub store_settings {
1.153     matthew  9341:     # save to the environment
                   9342:     # appenv the same items, just to be safe
1.300     albertel 9343:     my $udom  = $env{'user.domain'};
                   9344:     my $uname = $env{'user.name'};
1.496     albertel 9345:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9346:     my %SaveHash;
                   9347:     my %AppHash;
                   9348:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9349:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9350:         my $envname = 'environment.'.$basename;
1.258     albertel 9351:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9352:             # Save this value away
                   9353:             if ($type eq 'scalar' &&
1.258     albertel 9354:                 (! exists($env{$envname}) || 
                   9355:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9356:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9357:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9358:             } elsif ($type eq 'array') {
                   9359:                 my $stored_form;
1.258     albertel 9360:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9361:                     $stored_form = join(',',
                   9362:                                         map {
1.369     www      9363:                                             &escape($_);
1.258     albertel 9364:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9365:                 } else {
                   9366:                     $stored_form = 
1.369     www      9367:                         &escape($env{'form.'.$setting});
1.153     matthew  9368:                 }
                   9369:                 # Determine if the array contents are the same.
1.258     albertel 9370:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9371:                     $SaveHash{$basename} = $stored_form;
                   9372:                     $AppHash{$envname}   = $stored_form;
                   9373:                 }
                   9374:             }
                   9375:         }
                   9376:     }
                   9377:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9378:                                           $udom,$uname);
1.153     matthew  9379:     if ($put_result !~ /^(ok|delayed)/) {
                   9380:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9381:                                  'got error:'.$put_result);
                   9382:     }
                   9383:     # Make sure these settings stick around in this session, too
1.646     raeburn  9384:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9385:     return;
                   9386: }
                   9387: 
                   9388: sub restore_course_settings {
1.499     albertel 9389:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9390: }
                   9391: 
                   9392: sub restore_settings {
                   9393:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9394:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9395:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9396:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9397:             '.'.$setting;
1.258     albertel 9398:         if (exists($env{$envname})) {
1.153     matthew  9399:             if ($type eq 'scalar') {
1.258     albertel 9400:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9401:             } elsif ($type eq 'array') {
1.258     albertel 9402:                 $env{'form.'.$setting} = [ 
1.153     matthew  9403:                                            map { 
1.369     www      9404:                                                &unescape($_); 
1.258     albertel 9405:                                            } split(',',$env{$envname})
1.153     matthew  9406:                                            ];
                   9407:             }
                   9408:         }
                   9409:     }
1.127     matthew  9410: }
                   9411: 
1.618     raeburn  9412: #######################################################
                   9413: #######################################################
                   9414: 
                   9415: =pod
                   9416: 
                   9417: =head1 Domain E-mail Routines  
                   9418: 
                   9419: =over 4
                   9420: 
1.648     raeburn  9421: =item * &build_recipient_list()
1.618     raeburn  9422: 
1.884     raeburn  9423: Build recipient lists for five types of e-mail:
1.766     raeburn  9424: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9425: (d) Help requests, (e) Course requests needing approval,  generated by
                   9426: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9427: loncoursequeueadmin.pm respectively.
1.618     raeburn  9428: 
                   9429: Inputs:
1.619     raeburn  9430: defmail (scalar - email address of default recipient), 
1.618     raeburn  9431: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9432: defdom (domain for which to retrieve configuration settings),
                   9433: origmail (scalar - email address of recipient from loncapa.conf, 
                   9434: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9435: 
1.655     raeburn  9436: Returns: comma separated list of addresses to which to send e-mail.
                   9437: 
                   9438: =back
1.618     raeburn  9439: 
                   9440: =cut
                   9441: 
                   9442: ############################################################
                   9443: ############################################################
                   9444: sub build_recipient_list {
1.619     raeburn  9445:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9446:     my @recipients;
                   9447:     my $otheremails;
                   9448:     my %domconfig =
                   9449:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9450:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9451:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9452:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9453:                 my @contacts = ('adminemail','supportemail');
                   9454:                 foreach my $item (@contacts) {
                   9455:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9456:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9457:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9458:                             push(@recipients,$addr);
                   9459:                         }
1.619     raeburn  9460:                     }
1.766     raeburn  9461:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9462:                 }
                   9463:             }
1.766     raeburn  9464:         } elsif ($origmail ne '') {
                   9465:             push(@recipients,$origmail);
1.618     raeburn  9466:         }
1.619     raeburn  9467:     } elsif ($origmail ne '') {
                   9468:         push(@recipients,$origmail);
1.618     raeburn  9469:     }
1.688     raeburn  9470:     if (defined($defmail)) {
                   9471:         if ($defmail ne '') {
                   9472:             push(@recipients,$defmail);
                   9473:         }
1.618     raeburn  9474:     }
                   9475:     if ($otheremails) {
1.619     raeburn  9476:         my @others;
                   9477:         if ($otheremails =~ /,/) {
                   9478:             @others = split(/,/,$otheremails);
1.618     raeburn  9479:         } else {
1.619     raeburn  9480:             push(@others,$otheremails);
                   9481:         }
                   9482:         foreach my $addr (@others) {
                   9483:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9484:                 push(@recipients,$addr);
                   9485:             }
1.618     raeburn  9486:         }
                   9487:     }
1.619     raeburn  9488:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9489:     return $recipientlist;
                   9490: }
                   9491: 
1.127     matthew  9492: ############################################################
                   9493: ############################################################
1.154     albertel 9494: 
1.655     raeburn  9495: =pod
                   9496: 
                   9497: =head1 Course Catalog Routines
                   9498: 
                   9499: =over 4
                   9500: 
                   9501: =item * &gather_categories()
                   9502: 
                   9503: Converts category definitions - keys of categories hash stored in  
                   9504: coursecategories in configuration.db on the primary library server in a 
                   9505: domain - to an array.  Also generates javascript and idx hash used to 
                   9506: generate Domain Coordinator interface for editing Course Categories.
                   9507: 
                   9508: Inputs:
1.663     raeburn  9509: 
1.655     raeburn  9510: categories (reference to hash of category definitions).
1.663     raeburn  9511: 
1.655     raeburn  9512: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9513:       categories and subcategories).
1.663     raeburn  9514: 
1.655     raeburn  9515: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9516:       editing Course Categories).
1.663     raeburn  9517: 
1.655     raeburn  9518: jsarray (reference to array of categories used to create Javascript arrays for
                   9519:          Domain Coordinator interface for editing Course Categories).
                   9520: 
                   9521: Returns: nothing
                   9522: 
                   9523: Side effects: populates cats, idx and jsarray. 
                   9524: 
                   9525: =cut
                   9526: 
                   9527: sub gather_categories {
                   9528:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9529:     my %counters;
                   9530:     my $num = 0;
                   9531:     foreach my $item (keys(%{$categories})) {
                   9532:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9533:         if ($container eq '' && $depth == 0) {
                   9534:             $cats->[$depth][$categories->{$item}] = $cat;
                   9535:         } else {
                   9536:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9537:         }
                   9538:         my ($escitem,$tail) = split(/:/,$item,2);
                   9539:         if ($counters{$tail} eq '') {
                   9540:             $counters{$tail} = $num;
                   9541:             $num ++;
                   9542:         }
                   9543:         if (ref($idx) eq 'HASH') {
                   9544:             $idx->{$item} = $counters{$tail};
                   9545:         }
                   9546:         if (ref($jsarray) eq 'ARRAY') {
                   9547:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9548:         }
                   9549:     }
                   9550:     return;
                   9551: }
                   9552: 
                   9553: =pod
                   9554: 
                   9555: =item * &extract_categories()
                   9556: 
                   9557: Used to generate breadcrumb trails for course categories.
                   9558: 
                   9559: Inputs:
1.663     raeburn  9560: 
1.655     raeburn  9561: categories (reference to hash of category definitions).
1.663     raeburn  9562: 
1.655     raeburn  9563: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9564:       categories and subcategories).
1.663     raeburn  9565: 
1.655     raeburn  9566: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9567: 
1.655     raeburn  9568: allitems (reference to hash - key is category key 
                   9569:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9570: 
1.655     raeburn  9571: idx (reference to hash of counters used in Domain Coordinator interface for
                   9572:       editing Course Categories).
1.663     raeburn  9573: 
1.655     raeburn  9574: jsarray (reference to array of categories used to create Javascript arrays for
                   9575:          Domain Coordinator interface for editing Course Categories).
                   9576: 
1.665     raeburn  9577: subcats (reference to hash of arrays containing all subcategories within each 
                   9578:          category, -recursive)
                   9579: 
1.655     raeburn  9580: Returns: nothing
                   9581: 
                   9582: Side effects: populates trails and allitems hash references.
                   9583: 
                   9584: =cut
                   9585: 
                   9586: sub extract_categories {
1.665     raeburn  9587:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9588:     if (ref($categories) eq 'HASH') {
                   9589:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9590:         if (ref($cats->[0]) eq 'ARRAY') {
                   9591:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9592:                 my $name = $cats->[0][$i];
                   9593:                 my $item = &escape($name).'::0';
                   9594:                 my $trailstr;
                   9595:                 if ($name eq 'instcode') {
                   9596:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9597:                 } else {
                   9598:                     $trailstr = $name;
                   9599:                 }
                   9600:                 if ($allitems->{$item} eq '') {
                   9601:                     push(@{$trails},$trailstr);
                   9602:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9603:                 }
                   9604:                 my @parents = ($name);
                   9605:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9606:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9607:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9608:                         if (ref($subcats) eq 'HASH') {
                   9609:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9610:                         }
                   9611:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9612:                     }
                   9613:                 } else {
                   9614:                     if (ref($subcats) eq 'HASH') {
                   9615:                         $subcats->{$item} = [];
1.655     raeburn  9616:                     }
                   9617:                 }
                   9618:             }
                   9619:         }
                   9620:     }
                   9621:     return;
                   9622: }
                   9623: 
                   9624: =pod
                   9625: 
                   9626: =item *&recurse_categories()
                   9627: 
                   9628: Recursively used to generate breadcrumb trails for course categories.
                   9629: 
                   9630: Inputs:
1.663     raeburn  9631: 
1.655     raeburn  9632: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9633:       categories and subcategories).
1.663     raeburn  9634: 
1.655     raeburn  9635: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9636: 
                   9637: category (current course category, for which breadcrumb trail is being generated).
                   9638: 
                   9639: trails (reference to array of breadcrumb trails for each category).
                   9640: 
1.655     raeburn  9641: allitems (reference to hash - key is category key
                   9642:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9643: 
1.655     raeburn  9644: parents (array containing containers directories for current category, 
                   9645:          back to top level). 
                   9646: 
                   9647: Returns: nothing
                   9648: 
                   9649: Side effects: populates trails and allitems hash references
                   9650: 
                   9651: =cut
                   9652: 
                   9653: sub recurse_categories {
1.665     raeburn  9654:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9655:     my $shallower = $depth - 1;
                   9656:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9657:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9658:             my $name = $cats->[$depth]{$category}[$k];
                   9659:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9660:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9661:             if ($allitems->{$item} eq '') {
                   9662:                 push(@{$trails},$trailstr);
                   9663:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9664:             }
                   9665:             my $deeper = $depth+1;
                   9666:             push(@{$parents},$category);
1.665     raeburn  9667:             if (ref($subcats) eq 'HASH') {
                   9668:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9669:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9670:                     my $higher;
                   9671:                     if ($j > 0) {
                   9672:                         $higher = &escape($parents->[$j]).':'.
                   9673:                                   &escape($parents->[$j-1]).':'.$j;
                   9674:                     } else {
                   9675:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9676:                     }
                   9677:                     push(@{$subcats->{$higher}},$subcat);
                   9678:                 }
                   9679:             }
                   9680:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9681:                                 $subcats);
1.655     raeburn  9682:             pop(@{$parents});
                   9683:         }
                   9684:     } else {
                   9685:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9686:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9687:         if ($allitems->{$item} eq '') {
                   9688:             push(@{$trails},$trailstr);
                   9689:             $allitems->{$item} = scalar(@{$trails})-1;
                   9690:         }
                   9691:     }
                   9692:     return;
                   9693: }
                   9694: 
1.663     raeburn  9695: =pod
                   9696: 
                   9697: =item *&assign_categories_table()
                   9698: 
                   9699: Create a datatable for display of hierarchical categories in a domain,
                   9700: with checkboxes to allow a course to be categorized. 
                   9701: 
                   9702: Inputs:
                   9703: 
                   9704: cathash - reference to hash of categories defined for the domain (from
                   9705:           configuration.db)
                   9706: 
                   9707: currcat - scalar with an & separated list of categories assigned to a course. 
                   9708: 
                   9709: Returns: $output (markup to be displayed) 
                   9710: 
                   9711: =cut
                   9712: 
                   9713: sub assign_categories_table {
                   9714:     my ($cathash,$currcat) = @_;
                   9715:     my $output;
                   9716:     if (ref($cathash) eq 'HASH') {
                   9717:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9718:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9719:         $maxdepth = scalar(@cats);
                   9720:         if (@cats > 0) {
                   9721:             my $itemcount = 0;
                   9722:             if (ref($cats[0]) eq 'ARRAY') {
                   9723:                 $output = &Apache::loncommon::start_data_table();
                   9724:                 my @currcategories;
                   9725:                 if ($currcat ne '') {
                   9726:                     @currcategories = split('&',$currcat);
                   9727:                 }
                   9728:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9729:                     my $parent = $cats[0][$i];
                   9730:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9731:                     next if ($parent eq 'instcode');
                   9732:                     my $item = &escape($parent).'::0';
                   9733:                     my $checked = '';
                   9734:                     if (@currcategories > 0) {
                   9735:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9736:                             $checked = ' checked="checked"';
1.663     raeburn  9737:                         }
                   9738:                     }
1.675     raeburn  9739:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9740:                                '<input type="checkbox" name="usecategory" value="'.
                   9741:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9742:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9743:                     my $depth = 1;
                   9744:                     push(@path,$parent);
                   9745:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9746:                     pop(@path);
                   9747:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9748:                     $itemcount ++;
                   9749:                 }
                   9750:                 $output .= &Apache::loncommon::end_data_table();
                   9751:             }
                   9752:         }
                   9753:     }
                   9754:     return $output;
                   9755: }
                   9756: 
                   9757: =pod
                   9758: 
                   9759: =item *&assign_category_rows()
                   9760: 
                   9761: Create a datatable row for display of nested categories in a domain,
                   9762: with checkboxes to allow a course to be categorized,called recursively.
                   9763: 
                   9764: Inputs:
                   9765: 
                   9766: itemcount - track row number for alternating colors
                   9767: 
                   9768: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9769:       categories and subcategories.
                   9770: 
                   9771: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9772: 
                   9773: parent - parent of current category item
                   9774: 
                   9775: path - Array containing all categories back up through the hierarchy from the
                   9776:        current category to the top level.
                   9777: 
                   9778: currcategories - reference to array of current categories assigned to the course
                   9779: 
                   9780: Returns: $output (markup to be displayed).
                   9781: 
                   9782: =cut
                   9783: 
                   9784: sub assign_category_rows {
                   9785:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9786:     my ($text,$name,$item,$chgstr);
                   9787:     if (ref($cats) eq 'ARRAY') {
                   9788:         my $maxdepth = scalar(@{$cats});
                   9789:         if (ref($cats->[$depth]) eq 'HASH') {
                   9790:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9791:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9792:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9793:                 $text .= '<td><table class="LC_datatable">';
                   9794:                 for (my $j=0; $j<$numchildren; $j++) {
                   9795:                     $name = $cats->[$depth]{$parent}[$j];
                   9796:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9797:                     my $deeper = $depth+1;
                   9798:                     my $checked = '';
                   9799:                     if (ref($currcategories) eq 'ARRAY') {
                   9800:                         if (@{$currcategories} > 0) {
                   9801:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9802:                                 $checked = ' checked="checked"';
1.663     raeburn  9803:                             }
                   9804:                         }
                   9805:                     }
1.664     raeburn  9806:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9807:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9808:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9809:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9810:                              '</td><td>';
1.663     raeburn  9811:                     if (ref($path) eq 'ARRAY') {
                   9812:                         push(@{$path},$name);
                   9813:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9814:                         pop(@{$path});
                   9815:                     }
                   9816:                     $text .= '</td></tr>';
                   9817:                 }
                   9818:                 $text .= '</table></td>';
                   9819:             }
                   9820:         }
                   9821:     }
                   9822:     return $text;
                   9823: }
                   9824: 
1.655     raeburn  9825: ############################################################
                   9826: ############################################################
                   9827: 
                   9828: 
1.443     albertel 9829: sub commit_customrole {
1.664     raeburn  9830:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9831:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9832:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9833:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9834:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9835:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9836:                  '</b><br />';
                   9837:     return $output;
                   9838: }
                   9839: 
                   9840: sub commit_standardrole {
1.541     raeburn  9841:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9842:     my ($output,$logmsg,$linefeed);
                   9843:     if ($context eq 'auto') {
                   9844:         $linefeed = "\n";
                   9845:     } else {
                   9846:         $linefeed = "<br />\n";
                   9847:     }  
1.443     albertel 9848:     if ($three eq 'st') {
1.541     raeburn  9849:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9850:                                          $one,$two,$sec,$context);
                   9851:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9852:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9853:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9854:         } else {
1.541     raeburn  9855:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9856:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9857:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9858:             if ($context eq 'auto') {
                   9859:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9860:             } else {
                   9861:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9862:                &mt('Add to classlist').': <b>ok</b>';
                   9863:             }
                   9864:             $output .= $linefeed;
1.443     albertel 9865:         }
                   9866:     } else {
                   9867:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9868:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9869:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9870:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9871:         if ($context eq 'auto') {
                   9872:             $output .= $result.$linefeed;
                   9873:         } else {
                   9874:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9875:         }
1.443     albertel 9876:     }
                   9877:     return $output;
                   9878: }
                   9879: 
                   9880: sub commit_studentrole {
1.541     raeburn  9881:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9882:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9883:     if ($context eq 'auto') {
                   9884:         $linefeed = "\n";
                   9885:     } else {
                   9886:         $linefeed = '<br />'."\n";
                   9887:     }
1.443     albertel 9888:     if (defined($one) && defined($two)) {
                   9889:         my $cid=$one.'_'.$two;
                   9890:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9891:         my $secchange = 0;
                   9892:         my $expire_role_result;
                   9893:         my $modify_section_result;
1.628     raeburn  9894:         if ($oldsec ne '-1') { 
                   9895:             if ($oldsec ne $sec) {
1.443     albertel 9896:                 $secchange = 1;
1.628     raeburn  9897:                 my $now = time;
1.443     albertel 9898:                 my $uurl='/'.$cid;
                   9899:                 $uurl=~s/\_/\//g;
                   9900:                 if ($oldsec) {
                   9901:                     $uurl.='/'.$oldsec;
                   9902:                 }
1.626     raeburn  9903:                 $oldsecurl = $uurl;
1.628     raeburn  9904:                 $expire_role_result = 
1.652     raeburn  9905:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9906:                 if ($env{'request.course.sec'} ne '') { 
                   9907:                     if ($expire_role_result eq 'refused') {
                   9908:                         my @roles = ('st');
                   9909:                         my @statuses = ('previous');
                   9910:                         my @roledoms = ($one);
                   9911:                         my $withsec = 1;
                   9912:                         my %roleshash = 
                   9913:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9914:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9915:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9916:                             my ($oldstart,$oldend) = 
                   9917:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9918:                             if ($oldend > 0 && $oldend <= $now) {
                   9919:                                 $expire_role_result = 'ok';
                   9920:                             }
                   9921:                         }
                   9922:                     }
                   9923:                 }
1.443     albertel 9924:                 $result = $expire_role_result;
                   9925:             }
                   9926:         }
                   9927:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9928:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9929:             if ($modify_section_result =~ /^ok/) {
                   9930:                 if ($secchange == 1) {
1.628     raeburn  9931:                     if ($sec eq '') {
                   9932:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9933:                     } else {
                   9934:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9935:                     }
1.443     albertel 9936:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9937:                     if ($sec eq '') {
                   9938:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9939:                     } else {
                   9940:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9941:                     }
1.443     albertel 9942:                 } else {
1.628     raeburn  9943:                     if ($sec eq '') {
                   9944:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9945:                     } else {
                   9946:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9947:                     }
1.443     albertel 9948:                 }
                   9949:             } else {
1.628     raeburn  9950:                 if ($secchange) {       
                   9951:                     $$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;
                   9952:                 } else {
                   9953:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9954:                 }
1.443     albertel 9955:             }
                   9956:             $result = $modify_section_result;
                   9957:         } elsif ($secchange == 1) {
1.628     raeburn  9958:             if ($oldsec eq '') {
                   9959:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9960:             } else {
                   9961:                 $$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;
                   9962:             }
1.626     raeburn  9963:             if ($expire_role_result eq 'refused') {
                   9964:                 my $newsecurl = '/'.$cid;
                   9965:                 $newsecurl =~ s/\_/\//g;
                   9966:                 if ($sec ne '') {
                   9967:                     $newsecurl.='/'.$sec;
                   9968:                 }
                   9969:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9970:                     if ($sec eq '') {
                   9971:                         $$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;
                   9972:                     } else {
                   9973:                         $$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;
                   9974:                     }
                   9975:                 }
                   9976:             }
1.443     albertel 9977:         }
                   9978:     } else {
1.626     raeburn  9979:         $$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 9980:         $result = "error: incomplete course id\n";
                   9981:     }
                   9982:     return $result;
                   9983: }
                   9984: 
                   9985: ############################################################
                   9986: ############################################################
                   9987: 
1.566     albertel 9988: sub check_clone {
1.578     raeburn  9989:     my ($args,$linefeed) = @_;
1.566     albertel 9990:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   9991:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   9992:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   9993:     my $clonemsg;
                   9994:     my $can_clone = 0;
1.908     raeburn  9995:     my $lctype = lc($args->{'type'});
                   9996:     if ($lctype ne 'community') {
                   9997:         $lctype = 'course';
                   9998:     }
1.566     albertel 9999:     if ($clonehome eq 'no_host') {
1.908     raeburn  10000:         if ($args->{'type'} eq 'Community') {
                   10001:             $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'});
                   10002:         } else {
                   10003:             $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'});
                   10004:         }     
1.566     albertel 10005:     } else {
                   10006: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908     raeburn  10007:         if ($args->{'type'} eq 'Community') {
                   10008:             if ($clonedesc{'type'} ne 'Community') {
                   10009:                  $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'});
                   10010:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10011:             }
                   10012:         }
1.882     raeburn  10013: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10014:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10015: 	    $can_clone = 1;
                   10016: 	} else {
                   10017: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10018: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10019: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10020:             if (grep(/^\*$/,@cloners)) {
                   10021:                 $can_clone = 1;
                   10022:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10023:                 $can_clone = 1;
                   10024:             } else {
1.908     raeburn  10025:                 my $ccrole = 'cc';
                   10026:                 if ($args->{'type'} eq 'Community') {
                   10027:                     $ccrole = 'co';
                   10028:                 }
1.578     raeburn  10029: 	        my %roleshash =
                   10030: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10031: 					 $args->{'ccdomain'},
1.908     raeburn  10032:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10033: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10034: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10035: 		    $can_clone = 1;
                   10036: 	        } else {
1.908     raeburn  10037:                     if ($args->{'type'} eq 'Community') {
                   10038:                         $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'});
                   10039:                     } else {
                   10040:                         $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'});
                   10041:                     }
1.578     raeburn  10042: 	        }
1.566     albertel 10043: 	    }
1.578     raeburn  10044:         }
1.566     albertel 10045:     }
                   10046:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10047: }
                   10048: 
1.444     albertel 10049: sub construct_course {
1.885     raeburn  10050:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10051:     my $outcome;
1.541     raeburn  10052:     my $linefeed =  '<br />'."\n";
                   10053:     if ($context eq 'auto') {
                   10054:         $linefeed = "\n";
                   10055:     }
1.566     albertel 10056: 
                   10057: #
                   10058: # Are we cloning?
                   10059: #
                   10060:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10061:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10062: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10063: 	if ($context ne 'auto') {
1.578     raeburn  10064:             if ($clonemsg ne '') {
                   10065: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10066:             }
1.566     albertel 10067: 	}
                   10068: 	$outcome .= $clonemsg.$linefeed;
                   10069: 
                   10070:         if (!$can_clone) {
                   10071: 	    return (0,$outcome);
                   10072: 	}
                   10073:     }
                   10074: 
1.444     albertel 10075: #
                   10076: # Open course
                   10077: #
                   10078:     my $crstype = lc($args->{'crstype'});
                   10079:     my %cenv=();
                   10080:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10081:                                              $args->{'cdescr'},
                   10082:                                              $args->{'curl'},
                   10083:                                              $args->{'course_home'},
                   10084:                                              $args->{'nonstandard'},
                   10085:                                              $args->{'crscode'},
                   10086:                                              $args->{'ccuname'}.':'.
                   10087:                                              $args->{'ccdomain'},
1.882     raeburn  10088:                                              $args->{'crstype'},
1.885     raeburn  10089:                                              $cnum,$context,$category);
1.444     albertel 10090: 
                   10091:     # Note: The testing routines depend on this being output; see 
                   10092:     # Utils::Course. This needs to at least be output as a comment
                   10093:     # if anyone ever decides to not show this, and Utils::Course::new
                   10094:     # will need to be suitably modified.
1.541     raeburn  10095:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10096: #
                   10097: # Check if created correctly
                   10098: #
1.479     albertel 10099:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10100:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10101:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10102: 
1.444     albertel 10103: #
1.566     albertel 10104: # Do the cloning
                   10105: #   
                   10106:     if ($can_clone && $cloneid) {
                   10107: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10108: 	if ($context ne 'auto') {
                   10109: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10110: 	}
                   10111: 	$outcome .= $clonemsg.$linefeed;
                   10112: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10113: # Copy all files
1.637     www      10114: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10115: # Restore URL
1.566     albertel 10116: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10117: # Restore title
1.566     albertel 10118: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10119: # Mark as cloned
1.566     albertel 10120: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10121: # Need to clone grading mode
                   10122:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10123:         $cenv{'grading'}=$newenv{'grading'};
                   10124: # Do not clone these environment entries
                   10125:         &Apache::lonnet::del('environment',
                   10126:                   ['default_enrollment_start_date',
                   10127:                    'default_enrollment_end_date',
                   10128:                    'question.email',
                   10129:                    'policy.email',
                   10130:                    'comment.email',
                   10131:                    'pch.users.denied',
1.725     raeburn  10132:                    'plc.users.denied',
                   10133:                    'hidefromcat',
                   10134:                    'categories'],
1.638     www      10135:                    $$crsudom,$$crsunum);
1.444     albertel 10136:     }
1.566     albertel 10137: 
1.444     albertel 10138: #
                   10139: # Set environment (will override cloned, if existing)
                   10140: #
                   10141:     my @sections = ();
                   10142:     my @xlists = ();
                   10143:     if ($args->{'crstype'}) {
                   10144:         $cenv{'type'}=$args->{'crstype'};
                   10145:     }
                   10146:     if ($args->{'crsid'}) {
                   10147:         $cenv{'courseid'}=$args->{'crsid'};
                   10148:     }
                   10149:     if ($args->{'crscode'}) {
                   10150:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10151:     }
                   10152:     if ($args->{'crsquota'} ne '') {
                   10153:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10154:     } else {
                   10155:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10156:     }
                   10157:     if ($args->{'ccuname'}) {
                   10158:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10159:                                         ':'.$args->{'ccdomain'};
                   10160:     } else {
                   10161:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10162:     }
                   10163:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10164:     if ($args->{'crssections'}) {
                   10165:         $cenv{'internal.sectionnums'} = '';
                   10166:         if ($args->{'crssections'} =~ m/,/) {
                   10167:             @sections = split/,/,$args->{'crssections'};
                   10168:         } else {
                   10169:             $sections[0] = $args->{'crssections'};
                   10170:         }
                   10171:         if (@sections > 0) {
                   10172:             foreach my $item (@sections) {
                   10173:                 my ($sec,$gp) = split/:/,$item;
                   10174:                 my $class = $args->{'crscode'}.$sec;
                   10175:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10176:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10177:                 unless ($addcheck eq 'ok') {
                   10178:                     push @badclasses, $class;
                   10179:                 }
                   10180:             }
                   10181:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10182:         }
                   10183:     }
                   10184: # do not hide course coordinator from staff listing, 
                   10185: # even if privileged
                   10186:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10187: # add crosslistings
                   10188:     if ($args->{'crsxlist'}) {
                   10189:         $cenv{'internal.crosslistings'}='';
                   10190:         if ($args->{'crsxlist'} =~ m/,/) {
                   10191:             @xlists = split/,/,$args->{'crsxlist'};
                   10192:         } else {
                   10193:             $xlists[0] = $args->{'crsxlist'};
                   10194:         }
                   10195:         if (@xlists > 0) {
                   10196:             foreach my $item (@xlists) {
                   10197:                 my ($xl,$gp) = split/:/,$item;
                   10198:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10199:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10200:                 unless ($addcheck eq 'ok') {
                   10201:                     push @badclasses, $xl;
                   10202:                 }
                   10203:             }
                   10204:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10205:         }
                   10206:     }
                   10207:     if ($args->{'autoadds'}) {
                   10208:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10209:     }
                   10210:     if ($args->{'autodrops'}) {
                   10211:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10212:     }
                   10213: # check for notification of enrollment changes
                   10214:     my @notified = ();
                   10215:     if ($args->{'notify_owner'}) {
                   10216:         if ($args->{'ccuname'} ne '') {
                   10217:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10218:         }
                   10219:     }
                   10220:     if ($args->{'notify_dc'}) {
                   10221:         if ($uname ne '') { 
1.630     raeburn  10222:             push(@notified,$uname.':'.$udom);
1.444     albertel 10223:         }
                   10224:     }
                   10225:     if (@notified > 0) {
                   10226:         my $notifylist;
                   10227:         if (@notified > 1) {
                   10228:             $notifylist = join(',',@notified);
                   10229:         } else {
                   10230:             $notifylist = $notified[0];
                   10231:         }
                   10232:         $cenv{'internal.notifylist'} = $notifylist;
                   10233:     }
                   10234:     if (@badclasses > 0) {
                   10235:         my %lt=&Apache::lonlocal::texthash(
                   10236:                 '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',
                   10237:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10238:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10239:         );
1.541     raeburn  10240:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10241:                            ' ('.$lt{'adby'}.')';
                   10242:         if ($context eq 'auto') {
                   10243:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10244:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10245:             foreach my $item (@badclasses) {
                   10246:                 if ($context eq 'auto') {
                   10247:                     $outcome .= " - $item\n";
                   10248:                 } else {
                   10249:                     $outcome .= "<li>$item</li>\n";
                   10250:                 }
                   10251:             }
                   10252:             if ($context eq 'auto') {
                   10253:                 $outcome .= $linefeed;
                   10254:             } else {
1.566     albertel 10255:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10256:             }
                   10257:         } 
1.444     albertel 10258:     }
                   10259:     if ($args->{'no_end_date'}) {
                   10260:         $args->{'endaccess'} = 0;
                   10261:     }
                   10262:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10263:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10264:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10265:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10266:     if ($args->{'showphotos'}) {
                   10267:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10268:     }
                   10269:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10270:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10271:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10272:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10273:             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'); 
                   10274:             if ($context eq 'auto') {
                   10275:                 $outcome .= $krb_msg;
                   10276:             } else {
1.566     albertel 10277:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10278:             }
                   10279:             $outcome .= $linefeed;
1.444     albertel 10280:         }
                   10281:     }
                   10282:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10283:        if ($args->{'setpolicy'}) {
                   10284:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10285:        }
                   10286:        if ($args->{'setcontent'}) {
                   10287:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10288:        }
                   10289:     }
                   10290:     if ($args->{'reshome'}) {
                   10291: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10292: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10293:     }
                   10294: #
                   10295: # course has keyed access
                   10296: #
                   10297:     if ($args->{'setkeys'}) {
                   10298:        $cenv{'keyaccess'}='yes';
                   10299:     }
                   10300: # if specified, key authority is not course, but user
                   10301: # only active if keyaccess is yes
                   10302:     if ($args->{'keyauth'}) {
1.487     albertel 10303: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10304: 	$user = &LONCAPA::clean_username($user);
                   10305: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10306: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10307: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10308: 	}
                   10309:     }
                   10310: 
                   10311:     if ($args->{'disresdis'}) {
                   10312:         $cenv{'pch.roles.denied'}='st';
                   10313:     }
                   10314:     if ($args->{'disablechat'}) {
                   10315:         $cenv{'plc.roles.denied'}='st';
                   10316:     }
                   10317: 
                   10318:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10319:     # course
                   10320:     $cenv{'course.helper.not.run'} = 1;
                   10321:     #
                   10322:     # Use new Randomseed
                   10323:     #
                   10324:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10325:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10326:     #
                   10327:     # The encryption code and receipt prefix for this course
                   10328:     #
                   10329:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10330:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10331:     #
                   10332:     # By default, use standard grading
                   10333:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10334: 
1.541     raeburn  10335:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10336:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10337: #
                   10338: # Open all assignments
                   10339: #
                   10340:     if ($args->{'openall'}) {
                   10341:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10342:        my %storecontent = ($storeunder         => time,
                   10343:                            $storeunder.'.type' => 'date_start');
                   10344:        
                   10345:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10346:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10347:    }
                   10348: #
                   10349: # Set first page
                   10350: #
                   10351:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10352: 	    || ($cloneid)) {
1.445     albertel 10353: 	use LONCAPA::map;
1.444     albertel 10354: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10355: 
                   10356: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10357:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10358: 
1.444     albertel 10359:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10360:         my $title; my $url;
                   10361:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10362: 	    $title=&mt('Syllabus');
1.444     albertel 10363:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10364:         } else {
1.690     bisitz   10365:             $title=&mt('Navigate Contents');
1.444     albertel 10366:             $url='/adm/navmaps';
                   10367:         }
1.445     albertel 10368: 
                   10369:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10370: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10371: 
                   10372: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10373:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10374:     }
1.566     albertel 10375: 
                   10376:     return (1,$outcome);
1.444     albertel 10377: }
                   10378: 
                   10379: ############################################################
                   10380: ############################################################
                   10381: 
1.378     raeburn  10382: sub course_type {
                   10383:     my ($cid) = @_;
                   10384:     if (!defined($cid)) {
                   10385:         $cid = $env{'request.course.id'};
                   10386:     }
1.404     albertel 10387:     if (defined($env{'course.'.$cid.'.type'})) {
                   10388:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10389:     } else {
                   10390:         return 'Course';
1.377     raeburn  10391:     }
                   10392: }
1.156     albertel 10393: 
1.406     raeburn  10394: sub group_term {
                   10395:     my $crstype = &course_type();
                   10396:     my %names = (
                   10397:                   'Course' => 'group',
1.865     raeburn  10398:                   'Community' => 'group',
1.406     raeburn  10399:                 );
                   10400:     return $names{$crstype};
                   10401: }
                   10402: 
1.902     raeburn  10403: sub course_types {
                   10404:     my @types = ('official','unofficial','community');
                   10405:     my %typename = (
                   10406:                          official   => 'Official course',
                   10407:                          unofficial => 'Unofficial course',
                   10408:                          community  => 'Community',
                   10409:                    );
                   10410:     return (\@types,\%typename);
                   10411: }
                   10412: 
1.156     albertel 10413: sub icon {
                   10414:     my ($file)=@_;
1.505     albertel 10415:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10416:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10417:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10418:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10419: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10420: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10421: 	            $curfext.".gif") {
                   10422: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10423: 		$curfext.".gif";
                   10424: 	}
                   10425:     }
1.249     albertel 10426:     return &lonhttpdurl($iconname);
1.154     albertel 10427: } 
1.84      albertel 10428: 
1.575     albertel 10429: sub lonhttpdurl {
1.692     www      10430: #
                   10431: # Had been used for "small fry" static images on separate port 8080.
                   10432: # Modify here if lightweight http functionality desired again.
                   10433: # Currently eliminated due to increasing firewall issues.
                   10434: #
1.575     albertel 10435:     my ($url)=@_;
1.692     www      10436:     return $url;
1.215     albertel 10437: }
                   10438: 
1.213     albertel 10439: sub connection_aborted {
                   10440:     my ($r)=@_;
                   10441:     $r->print(" ");$r->rflush();
                   10442:     my $c = $r->connection;
                   10443:     return $c->aborted();
                   10444: }
                   10445: 
1.221     foxr     10446: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10447: #    strings as 'strings'.
                   10448: sub escape_single {
1.221     foxr     10449:     my ($input) = @_;
1.223     albertel 10450:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10451:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10452:     return $input;
                   10453: }
1.223     albertel 10454: 
1.222     foxr     10455: #  Same as escape_single, but escape's "'s  This 
                   10456: #  can be used for  "strings"
                   10457: sub escape_double {
                   10458:     my ($input) = @_;
                   10459:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10460:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10461:     return $input;
                   10462: }
1.223     albertel 10463:  
1.222     foxr     10464: #   Escapes the last element of a full URL.
                   10465: sub escape_url {
                   10466:     my ($url)   = @_;
1.238     raeburn  10467:     my @urlslices = split(/\//, $url,-1);
1.369     www      10468:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10469:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10470: }
1.462     albertel 10471: 
1.820     raeburn  10472: sub compare_arrays {
                   10473:     my ($arrayref1,$arrayref2) = @_;
                   10474:     my (@difference,%count);
                   10475:     @difference = ();
                   10476:     %count = ();
                   10477:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10478:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10479:         foreach my $element (keys(%count)) {
                   10480:             if ($count{$element} == 1) {
                   10481:                 push(@difference,$element);
                   10482:             }
                   10483:         }
                   10484:     }
                   10485:     return @difference;
                   10486: }
                   10487: 
1.817     bisitz   10488: # -------------------------------------------------------- Initialize user login
1.462     albertel 10489: sub init_user_environment {
1.463     albertel 10490:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10491:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10492: 
                   10493:     my $public=($username eq 'public' && $domain eq 'public');
                   10494: 
                   10495: # See if old ID present, if so, remove
                   10496: 
                   10497:     my ($filename,$cookie,$userroles);
                   10498:     my $now=time;
                   10499: 
                   10500:     if ($public) {
                   10501: 	my $max_public=100;
                   10502: 	my $oldest;
                   10503: 	my $oldest_time=0;
                   10504: 	for(my $next=1;$next<=$max_public;$next++) {
                   10505: 	    if (-e $lonids."/publicuser_$next.id") {
                   10506: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10507: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10508: 		    $oldest_time=$mtime;
                   10509: 		    $oldest=$next;
                   10510: 		}
                   10511: 	    } else {
                   10512: 		$cookie="publicuser_$next";
                   10513: 		last;
                   10514: 	    }
                   10515: 	}
                   10516: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10517:     } else {
1.463     albertel 10518: 	# if this isn't a robot, kill any existing non-robot sessions
                   10519: 	if (!$args->{'robot'}) {
                   10520: 	    opendir(DIR,$lonids);
                   10521: 	    while ($filename=readdir(DIR)) {
                   10522: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10523: 		    unlink($lonids.'/'.$filename);
                   10524: 		}
1.462     albertel 10525: 	    }
1.463     albertel 10526: 	    closedir(DIR);
1.462     albertel 10527: 	}
                   10528: # Give them a new cookie
1.463     albertel 10529: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10530: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10531: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10532:     
                   10533: # Initialize roles
                   10534: 
                   10535: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10536:     }
                   10537: # ------------------------------------ Check browser type and MathML capability
                   10538: 
                   10539:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10540:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10541: 
                   10542: # ------------------------------------------------------------- Get environment
                   10543: 
                   10544:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10545:     my ($tmp) = keys(%userenv);
                   10546:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10547: 	# default remote control to off
                   10548: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10549:     } else {
                   10550: 	undef(%userenv);
                   10551:     }
                   10552:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10553: 	$form->{'interface'}=$userenv{'interface'};
                   10554:     }
                   10555:     $env{'environment.remote'}=$userenv{'remote'};
                   10556:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10557: 
                   10558: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10559:     foreach my $option ('interface','localpath','localres') {
                   10560:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10561:     }
                   10562: # --------------------------------------------------------- Write first profile
                   10563: 
                   10564:     {
                   10565: 	my %initial_env = 
                   10566: 	    ("user.name"          => $username,
                   10567: 	     "user.domain"        => $domain,
                   10568: 	     "user.home"          => $authhost,
                   10569: 	     "browser.type"       => $clientbrowser,
                   10570: 	     "browser.version"    => $clientversion,
                   10571: 	     "browser.mathml"     => $clientmathml,
                   10572: 	     "browser.unicode"    => $clientunicode,
                   10573: 	     "browser.os"         => $clientos,
                   10574: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10575: 	     "request.course.fn"  => '',
                   10576: 	     "request.course.uri" => '',
                   10577: 	     "request.course.sec" => '',
                   10578: 	     "request.role"       => 'cm',
                   10579: 	     "request.role.adv"   => $env{'user.adv'},
                   10580: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10581: 
                   10582:         if ($form->{'localpath'}) {
                   10583: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10584: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10585:         }
                   10586: 	
                   10587: 	if ($public) {
                   10588: 	    $initial_env{"environment.remote"} = "off";
                   10589: 	}
                   10590: 	if ($form->{'interface'}) {
                   10591: 	    $form->{'interface'}=~s/\W//gs;
                   10592: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10593: 	    $env{'browser.interface'}=$form->{'interface'};
                   10594: 	}
                   10595: 
1.724     raeburn  10596:         foreach my $tool ('aboutme','blog','portfolio') {
                   10597:             $userenv{'availabletools.'.$tool} = 
                   10598:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10599:         }
                   10600: 
1.864     raeburn  10601:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10602:             $userenv{'canrequest.'.$crstype} =
                   10603:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10604:                                                   'reload','requestcourses');
                   10605:         }
                   10606: 
1.462     albertel 10607: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10608: 	
                   10609: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10610: 		 &GDBM_WRCREAT(),0640)) {
                   10611: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10612: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10613: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10614: 	    if (ref($args->{'extra_env'})) {
                   10615: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10616: 	    }
1.462     albertel 10617: 	    untie(%disk_env);
                   10618: 	} else {
1.705     tempelho 10619: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10620: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10621: 	    return 'error: '.$!;
                   10622: 	}
                   10623:     }
                   10624:     $env{'request.role'}='cm';
                   10625:     $env{'request.role.adv'}=$env{'user.adv'};
                   10626:     $env{'browser.type'}=$clientbrowser;
                   10627: 
                   10628:     return $cookie;
                   10629: 
                   10630: }
                   10631: 
                   10632: sub _add_to_env {
                   10633:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10634:     if (ref($env_data) eq 'HASH') {
                   10635:         while (my ($key,$value) = each(%$env_data)) {
                   10636: 	    $idf->{$prefix.$key} = $value;
                   10637: 	    $env{$prefix.$key}   = $value;
                   10638:         }
1.462     albertel 10639:     }
                   10640: }
                   10641: 
1.685     tempelho 10642: # --- Get the symbolic name of a problem and the url
                   10643: sub get_symb {
                   10644:     my ($request,$silent) = @_;
1.726     raeburn  10645:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10646:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10647:     if ($symb eq '') {
                   10648:         if (!$silent) {
                   10649:             $request->print("Unable to handle ambiguous references:$url:.");
                   10650:             return ();
                   10651:         }
                   10652:     }
                   10653:     &Apache::lonenc::check_decrypt(\$symb);
                   10654:     return ($symb);
                   10655: }
                   10656: 
                   10657: # --------------------------------------------------------------Get annotation
                   10658: 
                   10659: sub get_annotation {
                   10660:     my ($symb,$enc) = @_;
                   10661: 
                   10662:     my $key = $symb;
                   10663:     if (!$enc) {
                   10664:         $key =
                   10665:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10666:     }
                   10667:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10668:     return $annotation{$key};
                   10669: }
                   10670: 
                   10671: sub clean_symb {
1.731     raeburn  10672:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10673: 
                   10674:     &Apache::lonenc::check_decrypt(\$symb);
                   10675:     my $enc = $env{'request.enc'};
1.731     raeburn  10676:     if ($delete_enc) {
1.730     raeburn  10677:         delete($env{'request.enc'});
                   10678:     }
1.685     tempelho 10679: 
                   10680:     return ($symb,$enc);
                   10681: }
1.462     albertel 10682: 
1.41      ng       10683: =pod
                   10684: 
                   10685: =back
                   10686: 
1.112     bowersj2 10687: =cut
1.41      ng       10688: 
1.112     bowersj2 10689: 1;
                   10690: __END__;
1.41      ng       10691: 

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