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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.918   ! wenzelju    4: # $Id: loncommon.pm,v 1.917 2009/11/20 04:12:43 raeburn Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
                    486:     my $wintitle = &mt('Course Browser');
                    487:     if ($crstype ne '') {
                    488:         $wintitle = &mt($crstype);
                    489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
                    903:     return &select_form($selected,$name,%langchoices);
                    904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.648     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
                   1093: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1094: 
                   1095: =cut
                   1096: 
                   1097: sub help_open_topic {
1.48      bowersj2 1098:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1099:     $text = "" if (not defined $text);
1.44      bowersj2 1100:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1101:     $width = 350 if (not defined $width);
                   1102:     $height = 400 if (not defined $height);
                   1103:     my $filename = $topic;
                   1104:     $filename =~ s/ /_/g;
                   1105: 
1.48      bowersj2 1106:     my $template = "";
                   1107:     my $link;
1.572     banghart 1108:     
1.159     www      1109:     $topic=~s/\W/\_/g;
1.44      bowersj2 1110: 
1.572     banghart 1111:     if (!$stayOnPage) {
1.72      bowersj2 1112: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1113:     } else {
1.48      bowersj2 1114: 	$link = "/adm/help/${filename}.hlp";
                   1115:     }
                   1116: 
                   1117:     # Add the text
1.755     neumanie 1118:     if ($text ne "") {	
1.763     bisitz   1119: 	$template.='<span class="LC_help_open_topic">'
                   1120:                   .'<a target="_top" href="'.$link.'">'
                   1121:                   .$text.'</a>';
1.48      bowersj2 1122:     }
                   1123: 
1.763     bisitz   1124:     # (Always) Add the graphic
1.179     matthew  1125:     my $title = &mt('Online Help');
1.667     raeburn  1126:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1127:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1128:               .'<img src="'.$helpicon.'" border="0"'
                   1129:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1130:               .' title="'.$title.'"' 
1.763     bisitz   1131:               .' /></a>';
                   1132:     if ($text ne "") {	
                   1133:         $template.='</span>';
                   1134:     }
1.44      bowersj2 1135:     return $template;
                   1136: 
1.106     bowersj2 1137: }
                   1138: 
                   1139: # This is a quicky function for Latex cheatsheet editing, since it 
                   1140: # appears in at least four places
                   1141: sub helpLatexCheatsheet {
1.732     raeburn  1142:     my ($topic,$text,$not_author) = @_;
                   1143:     my $out;
1.106     bowersj2 1144:     my $addOther = '';
1.732     raeburn  1145:     if ($topic) {
1.763     bisitz   1146: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1147: 							       undef, undef, 600).
                   1148: 								   '</span> ';
                   1149:     }
                   1150:     $out = '<span>' # Start cheatsheet
                   1151: 	  .$addOther
                   1152:           .'<span>'
                   1153: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1154: 					       undef,undef,600)
                   1155: 	  .'</span> <span>'
                   1156: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1157: 					       undef,undef,600)
                   1158: 	  .'</span>';
1.732     raeburn  1159:     unless ($not_author) {
1.763     bisitz   1160:         $out .= ' <span>'
                   1161: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1162: 	                                            undef,undef,600)
                   1163: 	       .'</span>';
1.732     raeburn  1164:     }
1.763     bisitz   1165:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1166:     return $out;
1.172     www      1167: }
                   1168: 
1.430     albertel 1169: sub general_help {
                   1170:     my $helptopic='Student_Intro';
                   1171:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1172: 	$helptopic='Authoring_Intro';
1.907     raeburn  1173:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1174: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1175:     } elsif ($env{'request.role'}=~/^dc/) {
                   1176:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1177:     }
                   1178:     return $helptopic;
                   1179: }
                   1180: 
                   1181: sub update_help_link {
                   1182:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1183:     my $origurl = $ENV{'REQUEST_URI'};
                   1184:     $origurl=~s|^/~|/priv/|;
                   1185:     my $timestamp = time;
                   1186:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1187:         $$datum = &escape($$datum);
                   1188:     }
                   1189: 
                   1190:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1191:     my $output .= <<"ENDOUTPUT";
                   1192: <script type="text/javascript">
1.824     bisitz   1193: // <![CDATA[
1.430     albertel 1194: banner_link = '$banner_link';
1.824     bisitz   1195: // ]]>
1.430     albertel 1196: </script>
                   1197: ENDOUTPUT
                   1198:     return $output;
                   1199: }
                   1200: 
                   1201: # now just updates the help link and generates a blue icon
1.193     raeburn  1202: sub help_open_menu {
1.430     albertel 1203:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1204: 	= @_;    
1.430     albertel 1205:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1206:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1207:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1208:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1209:         $stayOnPage=1;
1.430     albertel 1210:     }
                   1211:     my $output;
                   1212:     if ($component_help) {
                   1213: 	if (!$text) {
                   1214: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1215: 				       $width,$height);
                   1216: 	} else {
                   1217: 	    my $help_text;
                   1218: 	    $help_text=&unescape($topic);
                   1219: 	    $output='<table><tr><td>'.
                   1220: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1221: 				 $width,$height).'</td></tr></table>';
                   1222: 	}
                   1223:     }
                   1224:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1225:     return $output.$banner_link;
                   1226: }
                   1227: 
                   1228: sub top_nav_help {
                   1229:     my ($text) = @_;
1.436     albertel 1230:     $text = &mt($text);
1.572     banghart 1231:     my $stay_on_page = 
1.798     tempelho 1232: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1233:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1234: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1235:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1236: 
1.201     raeburn  1237:     my $title = &mt('Get help');
1.436     albertel 1238: 
                   1239:     return <<"END";
                   1240: $banner_link
                   1241:  <a href="$link" title="$title">$text</a>
                   1242: END
                   1243: }
                   1244: 
                   1245: sub help_menu_js {
                   1246:     my ($text) = @_;
                   1247: 
                   1248:     my $stayOnPage = 
1.798     tempelho 1249: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1250: 
                   1251:     my $width = 620;
                   1252:     my $height = 600;
1.430     albertel 1253:     my $helptopic=&general_help();
                   1254:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1255:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1256:     my $start_page =
                   1257:         &Apache::loncommon::start_page('Help Menu', undef,
                   1258: 				       {'frameset'    => 1,
                   1259: 					'js_ready'    => 1,
                   1260: 					'add_entries' => {
                   1261: 					    'border' => '0',
1.579     raeburn  1262: 					    'rows'   => "110,*",},});
1.331     albertel 1263:     my $end_page =
                   1264:         &Apache::loncommon::end_page({'frameset' => 1,
                   1265: 				      'js_ready' => 1,});
                   1266: 
1.436     albertel 1267:     my $template .= <<"ENDTEMPLATE";
                   1268: <script type="text/javascript">
1.877     bisitz   1269: // <![CDATA[
1.253     albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1271: var banner_link = '';
1.243     raeburn  1272: function helpMenu(target) {
                   1273:     var caller = this;
                   1274:     if (target == 'open') {
                   1275:         var newWindow = null;
                   1276:         try {
1.262     albertel 1277:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1278:         }
                   1279:         catch(error) {
                   1280:             writeHelp(caller);
                   1281:             return;
                   1282:         }
                   1283:         if (newWindow) {
                   1284:             caller = newWindow;
                   1285:         }
1.193     raeburn  1286:     }
1.243     raeburn  1287:     writeHelp(caller);
                   1288:     return;
                   1289: }
                   1290: function writeHelp(caller) {
1.430     albertel 1291:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1292:     caller.document.close()
                   1293:     caller.focus()
1.193     raeburn  1294: }
1.877     bisitz   1295: // END LON-CAPA Internal -->
1.253     albertel 1296: // ]]>
1.436     albertel 1297: </script>
1.193     raeburn  1298: ENDTEMPLATE
                   1299:     return $template;
                   1300: }
                   1301: 
1.172     www      1302: sub help_open_bug {
                   1303:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1304:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1305:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1306:     $text = "" if (not defined $text);
                   1307:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1308:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1309: 	$stayOnPage=1;
                   1310:     }
1.184     albertel 1311:     $width = 600 if (not defined $width);
                   1312:     $height = 600 if (not defined $height);
1.172     www      1313: 
                   1314:     $topic=~s/\W+/\+/g;
                   1315:     my $link='';
                   1316:     my $template='';
1.379     albertel 1317:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1318: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1319:     if (!$stayOnPage)
                   1320:     {
                   1321: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1322:     }
                   1323:     else
                   1324:     {
                   1325: 	$link = $url;
                   1326:     }
                   1327:     # Add the text
                   1328:     if ($text ne "")
                   1329:     {
                   1330: 	$template .= 
                   1331:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1332:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1333:     }
                   1334: 
                   1335:     # Add the graphic
1.179     matthew  1336:     my $title = &mt('Report a Bug');
1.215     albertel 1337:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1338:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1339:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1340: ENDTEMPLATE
                   1341:     if ($text ne '') { $template.='</td></tr></table>' };
                   1342:     return $template;
                   1343: 
                   1344: }
                   1345: 
                   1346: sub help_open_faq {
                   1347:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1348:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1349:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1350:     $text = "" if (not defined $text);
                   1351:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1352:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1353: 	$stayOnPage=1;
                   1354:     }
                   1355:     $width = 350 if (not defined $width);
                   1356:     $height = 400 if (not defined $height);
                   1357: 
                   1358:     $topic=~s/\W+/\+/g;
                   1359:     my $link='';
                   1360:     my $template='';
                   1361:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1362:     if (!$stayOnPage)
                   1363:     {
                   1364: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1365:     }
                   1366:     else
                   1367:     {
                   1368: 	$link = $url;
                   1369:     }
                   1370: 
                   1371:     # Add the text
                   1372:     if ($text ne "")
                   1373:     {
                   1374: 	$template .= 
1.173     www      1375:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1376:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1377:     }
                   1378: 
                   1379:     # Add the graphic
1.179     matthew  1380:     my $title = &mt('View the FAQ');
1.215     albertel 1381:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1382:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1383:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1384: ENDTEMPLATE
                   1385:     if ($text ne '') { $template.='</td></tr></table>' };
                   1386:     return $template;
                   1387: 
1.44      bowersj2 1388: }
1.37      matthew  1389: 
1.180     matthew  1390: ###############################################################
                   1391: ###############################################################
                   1392: 
1.45      matthew  1393: =pod
                   1394: 
1.648     raeburn  1395: =item * &change_content_javascript():
1.256     matthew  1396: 
                   1397: This and the next function allow you to create small sections of an
                   1398: otherwise static HTML page that you can update on the fly with
                   1399: Javascript, even in Netscape 4.
                   1400: 
                   1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1402: must be written to the HTML page once. It will prove the Javascript
                   1403: function "change(name, content)". Calling the change function with the
                   1404: name of the section 
                   1405: you want to update, matching the name passed to C<changable_area>, and
                   1406: the new content you want to put in there, will put the content into
                   1407: that area.
                   1408: 
                   1409: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1410: to contain room for the original contents. You need to "make space"
                   1411: for whatever changes you wish to make, and be B<sure> to check your
                   1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1413: it's adequate for updating a one-line status display, but little more.
                   1414: This script will set the space to 100% width, so you only need to
                   1415: worry about height in Netscape 4.
                   1416: 
                   1417: Modern browsers are much less limiting, and if you can commit to the
                   1418: user not using Netscape 4, this feature may be used freely with
                   1419: pretty much any HTML.
                   1420: 
                   1421: =cut
                   1422: 
                   1423: sub change_content_javascript {
                   1424:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1425:     if ($env{'browser.type'} eq 'netscape' &&
                   1426: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1427: 	return (<<NETSCAPE4);
                   1428: 	function change(name, content) {
                   1429: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1430: 	    doc.open();
                   1431: 	    doc.write(content);
                   1432: 	    doc.close();
                   1433: 	}
                   1434: NETSCAPE4
                   1435:     } else {
                   1436: 	# Otherwise, we need to use semi-standards-compliant code
                   1437: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1438: 	# is really scary, and every useful browser supports it
                   1439: 	return (<<DOMBASED);
                   1440: 	function change(name, content) {
                   1441: 	    element = document.getElementById(name);
                   1442: 	    element.innerHTML = content;
                   1443: 	}
                   1444: DOMBASED
                   1445:     }
                   1446: }
                   1447: 
                   1448: =pod
                   1449: 
1.648     raeburn  1450: =item * &changable_area($name,$origContent):
1.256     matthew  1451: 
                   1452: This provides a "changable area" that can be modified on the fly via
                   1453: the Javascript code provided in C<change_content_javascript>. $name is
                   1454: the name you will use to reference the area later; do not repeat the
                   1455: same name on a given HTML page more then once. $origContent is what
                   1456: the area will originally contain, which can be left blank.
                   1457: 
                   1458: =cut
                   1459: 
                   1460: sub changable_area {
                   1461:     my ($name, $origContent) = @_;
                   1462: 
1.258     albertel 1463:     if ($env{'browser.type'} eq 'netscape' &&
                   1464: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1465: 	# If this is netscape 4, we need to use the Layer tag
                   1466: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1467:     } else {
                   1468: 	return "<span id='$name'>$origContent</span>";
                   1469:     }
                   1470: }
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &viewport_geometry_js 
1.590     raeburn  1475: 
                   1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1477: 
                   1478: =cut
                   1479: 
                   1480: 
                   1481: sub viewport_geometry_js { 
                   1482:     return <<"GEOMETRY";
                   1483: var Geometry = {};
                   1484: function init_geometry() {
                   1485:     if (Geometry.init) { return };
                   1486:     Geometry.init=1;
                   1487:     if (window.innerHeight) {
                   1488:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1489:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1490:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1491:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1492:     }
                   1493:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1494:         Geometry.getViewportHeight =
                   1495:             function() { return document.documentElement.clientHeight; };
                   1496:         Geometry.getViewportWidth =
                   1497:             function() { return document.documentElement.clientWidth; };
                   1498: 
                   1499:         Geometry.getHorizontalScroll =
                   1500:             function() { return document.documentElement.scrollLeft; };
                   1501:         Geometry.getVerticalScroll =
                   1502:             function() { return document.documentElement.scrollTop; };
                   1503:     }
                   1504:     else if (document.body.clientHeight) {
                   1505:         Geometry.getViewportHeight =
                   1506:             function() { return document.body.clientHeight; };
                   1507:         Geometry.getViewportWidth =
                   1508:             function() { return document.body.clientWidth; };
                   1509:         Geometry.getHorizontalScroll =
                   1510:             function() { return document.body.scrollLeft; };
                   1511:         Geometry.getVerticalScroll =
                   1512:             function() { return document.body.scrollTop; };
                   1513:     }
                   1514: }
                   1515: 
                   1516: GEOMETRY
                   1517: }
                   1518: 
                   1519: =pod
                   1520: 
1.648     raeburn  1521: =item * &viewport_size_js()
1.590     raeburn  1522: 
                   1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1524: 
                   1525: =cut
                   1526: 
                   1527: sub viewport_size_js {
                   1528:     my $geometry = &viewport_geometry_js();
                   1529:     return <<"DIMS";
                   1530: 
                   1531: $geometry
                   1532: 
                   1533: function getViewportDims(width,height) {
                   1534:     init_geometry();
                   1535:     width.value = Geometry.getViewportWidth();
                   1536:     height.value = Geometry.getViewportHeight();
                   1537:     return;
                   1538: }
                   1539: 
                   1540: DIMS
                   1541: }
                   1542: 
                   1543: =pod
                   1544: 
1.648     raeburn  1545: =item * &resize_textarea_js()
1.565     albertel 1546: 
                   1547: emits the needed javascript to resize a textarea to be as big as possible
                   1548: 
                   1549: creates a function resize_textrea that takes two IDs first should be
                   1550: the id of the element to resize, second should be the id of a div that
                   1551: surrounds everything that comes after the textarea, this routine needs
                   1552: to be attached to the <body> for the onload and onresize events.
                   1553: 
1.648     raeburn  1554: =back
1.565     albertel 1555: 
                   1556: =cut
                   1557: 
                   1558: sub resize_textarea_js {
1.590     raeburn  1559:     my $geometry = &viewport_geometry_js();
1.565     albertel 1560:     return <<"RESIZE";
                   1561:     <script type="text/javascript">
1.824     bisitz   1562: // <![CDATA[
1.590     raeburn  1563: $geometry
1.565     albertel 1564: 
1.588     albertel 1565: function getX(element) {
                   1566:     var x = 0;
                   1567:     while (element) {
                   1568: 	x += element.offsetLeft;
                   1569: 	element = element.offsetParent;
                   1570:     }
                   1571:     return x;
                   1572: }
                   1573: function getY(element) {
                   1574:     var y = 0;
                   1575:     while (element) {
                   1576: 	y += element.offsetTop;
                   1577: 	element = element.offsetParent;
                   1578:     }
                   1579:     return y;
                   1580: }
                   1581: 
                   1582: 
1.565     albertel 1583: function resize_textarea(textarea_id,bottom_id) {
                   1584:     init_geometry();
                   1585:     var textarea        = document.getElementById(textarea_id);
                   1586:     //alert(textarea);
                   1587: 
1.588     albertel 1588:     var textarea_top    = getY(textarea);
1.565     albertel 1589:     var textarea_height = textarea.offsetHeight;
                   1590:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1591:     var bottom_top      = getY(bottom);
1.565     albertel 1592:     var bottom_height   = bottom.offsetHeight;
                   1593:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1594:     var fudge           = 23;
1.565     albertel 1595:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1596:     if (new_height < 300) {
                   1597: 	new_height = 300;
                   1598:     }
                   1599:     textarea.style.height=new_height+'px';
                   1600: }
1.824     bisitz   1601: // ]]>
1.565     albertel 1602: </script>
                   1603: RESIZE
                   1604: 
                   1605: }
                   1606: 
                   1607: =pod
                   1608: 
1.256     matthew  1609: =head1 Excel and CSV file utility routines
                   1610: 
                   1611: =over 4
                   1612: 
                   1613: =cut
                   1614: 
                   1615: ###############################################################
                   1616: ###############################################################
                   1617: 
                   1618: =pod
                   1619: 
1.648     raeburn  1620: =item * &csv_translate($text) 
1.37      matthew  1621: 
1.185     www      1622: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1623: format.
                   1624: 
                   1625: =cut
                   1626: 
1.180     matthew  1627: ###############################################################
                   1628: ###############################################################
1.37      matthew  1629: sub csv_translate {
                   1630:     my $text = shift;
                   1631:     $text =~ s/\"/\"\"/g;
1.209     albertel 1632:     $text =~ s/\n/ /g;
1.37      matthew  1633:     return $text;
                   1634: }
1.180     matthew  1635: 
                   1636: ###############################################################
                   1637: ###############################################################
                   1638: 
                   1639: =pod
                   1640: 
1.648     raeburn  1641: =item * &define_excel_formats()
1.180     matthew  1642: 
                   1643: Define some commonly used Excel cell formats.
                   1644: 
                   1645: Currently supported formats:
                   1646: 
                   1647: =over 4
                   1648: 
                   1649: =item header
                   1650: 
                   1651: =item bold
                   1652: 
                   1653: =item h1
                   1654: 
                   1655: =item h2
                   1656: 
                   1657: =item h3
                   1658: 
1.256     matthew  1659: =item h4
                   1660: 
                   1661: =item i
                   1662: 
1.180     matthew  1663: =item date
                   1664: 
                   1665: =back
                   1666: 
                   1667: Inputs: $workbook
                   1668: 
                   1669: Returns: $format, a hash reference.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: sub define_excel_formats {
                   1676:     my ($workbook) = @_;
                   1677:     my $format;
                   1678:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1679:                                                 bottom    => 1,
                   1680:                                                 align     => 'center');
                   1681:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1682:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1683:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1684:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1685:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1686:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1687:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1688:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1689:     return $format;
                   1690: }
                   1691: 
                   1692: ###############################################################
                   1693: ###############################################################
1.113     bowersj2 1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &create_workbook()
1.255     matthew  1698: 
                   1699: Create an Excel worksheet.  If it fails, output message on the
                   1700: request object and return undefs.
                   1701: 
                   1702: Inputs: Apache request object
                   1703: 
                   1704: Returns (undef) on failure, 
                   1705:     Excel worksheet object, scalar with filename, and formats 
                   1706:     from &Apache::loncommon::define_excel_formats on success
                   1707: 
                   1708: =cut
                   1709: 
                   1710: ###############################################################
                   1711: ###############################################################
                   1712: sub create_workbook {
                   1713:     my ($r) = @_;
                   1714:         #
                   1715:     # Create the excel spreadsheet
                   1716:     my $filename = '/prtspool/'.
1.258     albertel 1717:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1718:         time.'_'.rand(1000000000).'.xls';
                   1719:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1720:     if (! defined($workbook)) {
                   1721:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1722:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1723:                             "This error has been logged.  ".
                   1724:                             "Please alert your LON-CAPA administrator").
                   1725:                   '</p>');
                   1726:         return (undef);
                   1727:     }
                   1728:     #
                   1729:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1730:     #
                   1731:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1732:     return ($workbook,$filename,$format);
                   1733: }
                   1734: 
                   1735: ###############################################################
                   1736: ###############################################################
                   1737: 
                   1738: =pod
                   1739: 
1.648     raeburn  1740: =item * &create_text_file()
1.113     bowersj2 1741: 
1.542     raeburn  1742: Create a file to write to and eventually make available to the user.
1.256     matthew  1743: If file creation fails, outputs an error message on the request object and 
                   1744: return undefs.
1.113     bowersj2 1745: 
1.256     matthew  1746: Inputs: Apache request object, and file suffix
1.113     bowersj2 1747: 
1.256     matthew  1748: Returns (undef) on failure, 
                   1749:     Filehandle and filename on success.
1.113     bowersj2 1750: 
                   1751: =cut
                   1752: 
1.256     matthew  1753: ###############################################################
                   1754: ###############################################################
                   1755: sub create_text_file {
                   1756:     my ($r,$suffix) = @_;
                   1757:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1758:     my $fh;
                   1759:     my $filename = '/prtspool/'.
1.258     albertel 1760:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1761:         time.'_'.rand(1000000000).'.'.$suffix;
                   1762:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1763:     if (! defined($fh)) {
                   1764:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1765:         $r->print(&mt('Problems occurred in creating the output file. '
                   1766:                      .'This error has been logged. '
                   1767:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1796: 	return &select_form($name,$value,%domains);
                   1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.648     raeburn  1858: =item * &select_form($defdom,$name,%hash)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
                   1861: allow a user to select options from a hash option_name => displayed text.  
                   1862: See lonrights.pm for an example invocation and use.
                   1863: 
                   1864: =cut
                   1865: 
                   1866: #-------------------------------------------
                   1867: sub select_form {
                   1868:     my ($def,$name,%hash) = @_;
                   1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1870:     my @keys;
                   1871:     if (exists($hash{'select_form_order'})) {
                   1872: 	@keys=@{$hash{'select_form_order'}};
                   1873:     } else {
                   1874: 	@keys=sort(keys(%hash));
                   1875:     }
1.356     albertel 1876:     foreach my $key (@keys) {
                   1877:         $selectform.=
                   1878: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1879:             ($key eq $def ? 'selected="selected" ' : '').
                   1880:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1881:     }
                   1882:     $selectform.="</select>";
                   1883:     return $selectform;
                   1884: }
                   1885: 
1.475     www      1886: # For display filters
                   1887: 
                   1888: sub display_filter {
                   1889:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1890:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1891:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1892: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1893: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1894: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1895:            &mt('Filter [_1]',
1.477     www      1896: 	   &select_form($env{'form.displayfilter'},
                   1897: 			'displayfilter',
                   1898: 			('currentfolder' => 'Current folder/page',
                   1899: 			 'containing' => 'Containing phrase',
                   1900: 			 'none' => 'None'))).
1.714     bisitz   1901: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1902: }
                   1903: 
1.167     www      1904: sub gradeleveldescription {
                   1905:     my $gradelevel=shift;
                   1906:     my %gradelevels=(0 => 'Not specified',
                   1907: 		     1 => 'Grade 1',
                   1908: 		     2 => 'Grade 2',
                   1909: 		     3 => 'Grade 3',
                   1910: 		     4 => 'Grade 4',
                   1911: 		     5 => 'Grade 5',
                   1912: 		     6 => 'Grade 6',
                   1913: 		     7 => 'Grade 7',
                   1914: 		     8 => 'Grade 8',
                   1915: 		     9 => 'Grade 9',
                   1916: 		     10 => 'Grade 10',
                   1917: 		     11 => 'Grade 11',
                   1918: 		     12 => 'Grade 12',
                   1919: 		     13 => 'Grade 13',
                   1920: 		     14 => '100 Level',
                   1921: 		     15 => '200 Level',
                   1922: 		     16 => '300 Level',
                   1923: 		     17 => '400 Level',
                   1924: 		     18 => 'Graduate Level');
                   1925:     return &mt($gradelevels{$gradelevel});
                   1926: }
                   1927: 
1.163     www      1928: sub select_level_form {
                   1929:     my ($deflevel,$name)=@_;
                   1930:     unless ($deflevel) { $deflevel=0; }
1.167     www      1931:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1932:     for (my $i=0; $i<=18; $i++) {
                   1933:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1934:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1935:                 ">".&gradeleveldescription($i)."</option>\n";
                   1936:     }
                   1937:     $selectform.="</select>";
                   1938:     return $selectform;
1.163     www      1939: }
1.167     www      1940: 
1.35      matthew  1941: #-------------------------------------------
                   1942: 
1.45      matthew  1943: =pod
                   1944: 
1.910     raeburn  1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1946: 
                   1947: Returns a string containing a <select name='$name' size='1'> form to 
                   1948: allow a user to select the domain to preform an operation in.  
                   1949: See loncreateuser.pm for an example invocation and use.
                   1950: 
1.90      www      1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1952: selected");
                   1953: 
1.743     raeburn  1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1955: 
1.910     raeburn  1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   1957: 
                   1958: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1959: 
1.35      matthew  1960: =cut
                   1961: 
                   1962: #-------------------------------------------
1.34      matthew  1963: sub select_dom_form {
1.910     raeburn  1964:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1965:     if ($onchange) {
1.874     raeburn  1966:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1967:     }
1.910     raeburn  1968:     my @domains;
                   1969:     if (ref($incdoms) eq 'ARRAY') {
                   1970:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   1971:     } else {
                   1972:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   1973:     }
1.90      www      1974:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1975:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1976:     foreach my $dom (@domains) {
                   1977:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1978:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1979:         if ($showdomdesc) {
                   1980:             if ($dom ne '') {
                   1981:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1982:                 if ($domdesc ne '') {
                   1983:                     $selectdomain .= ' ('.$domdesc.')';
                   1984:                 }
                   1985:             } 
                   1986:         }
                   1987:         $selectdomain .= "</option>\n";
1.34      matthew  1988:     }
                   1989:     $selectdomain.="</select>";
                   1990:     return $selectdomain;
                   1991: }
                   1992: 
1.35      matthew  1993: #-------------------------------------------
                   1994: 
1.45      matthew  1995: =pod
                   1996: 
1.648     raeburn  1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1998: 
1.586     raeburn  1999: input: 4 arguments (two required, two optional) - 
                   2000:     $domain - domain of new user
                   2001:     $name - name of form element
                   2002:     $default - Value of 'default' causes a default item to be first 
                   2003:                             option, and selected by default. 
                   2004:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2005:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2006: output: returns 2 items: 
1.586     raeburn  2007: (a) form element which contains either:
                   2008:    (i) <select name="$name">
                   2009:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2010:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2011:        </select>
                   2012:        form item if there are multiple library servers in $domain, or
                   2013:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2014:        if there is only one library server in $domain.
                   2015: 
                   2016: (b) number of library servers found.
                   2017: 
                   2018: See loncreateuser.pm for example of use.
1.35      matthew  2019: 
                   2020: =cut
                   2021: 
                   2022: #-------------------------------------------
1.586     raeburn  2023: sub home_server_form_item {
                   2024:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2025:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2026:     my $result;
                   2027:     my $numlib = keys(%servers);
                   2028:     if ($numlib > 1) {
                   2029:         $result .= '<select name="'.$name.'" />'."\n";
                   2030:         if ($default) {
1.804     bisitz   2031:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2032:                        '</option>'."\n";
                   2033:         }
                   2034:         foreach my $hostid (sort(keys(%servers))) {
                   2035:             $result.= '<option value="'.$hostid.'">'.
                   2036: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2037:         }
                   2038:         $result .= '</select>'."\n";
                   2039:     } elsif ($numlib == 1) {
                   2040:         my $hostid;
                   2041:         foreach my $item (keys(%servers)) {
                   2042:             $hostid = $item;
                   2043:         }
                   2044:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2045:                    $hostid.'" />';
                   2046:                    if (!$hide) {
                   2047:                        $result .= $hostid.' '.$servers{$hostid};
                   2048:                    }
                   2049:                    $result .= "\n";
                   2050:     } elsif ($default) {
                   2051:         $result .= '<input type="hidden" name="'.$name.
                   2052:                    '" value="default" />';
                   2053:                    if (!$hide) {
                   2054:                        $result .= &mt('default');
                   2055:                    }
                   2056:                    $result .= "\n";
1.33      matthew  2057:     }
1.586     raeburn  2058:     return ($result,$numlib);
1.33      matthew  2059: }
1.112     bowersj2 2060: 
                   2061: =pod
                   2062: 
1.534     albertel 2063: =back 
                   2064: 
1.112     bowersj2 2065: =cut
1.87      matthew  2066: 
                   2067: ###############################################################
1.112     bowersj2 2068: ##                  Decoding User Agent                      ##
1.87      matthew  2069: ###############################################################
                   2070: 
                   2071: =pod
                   2072: 
1.112     bowersj2 2073: =head1 Decoding the User Agent
                   2074: 
                   2075: =over 4
                   2076: 
                   2077: =item * &decode_user_agent()
1.87      matthew  2078: 
                   2079: Inputs: $r
                   2080: 
                   2081: Outputs:
                   2082: 
                   2083: =over 4
                   2084: 
1.112     bowersj2 2085: =item * $httpbrowser
1.87      matthew  2086: 
1.112     bowersj2 2087: =item * $clientbrowser
1.87      matthew  2088: 
1.112     bowersj2 2089: =item * $clientversion
1.87      matthew  2090: 
1.112     bowersj2 2091: =item * $clientmathml
1.87      matthew  2092: 
1.112     bowersj2 2093: =item * $clientunicode
1.87      matthew  2094: 
1.112     bowersj2 2095: =item * $clientos
1.87      matthew  2096: 
                   2097: =back
                   2098: 
1.157     matthew  2099: =back 
                   2100: 
1.87      matthew  2101: =cut
                   2102: 
                   2103: ###############################################################
                   2104: ###############################################################
                   2105: sub decode_user_agent {
1.247     albertel 2106:     my ($r)=@_;
1.87      matthew  2107:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2108:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2109:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2110:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2111:     my $clientbrowser='unknown';
                   2112:     my $clientversion='0';
                   2113:     my $clientmathml='';
                   2114:     my $clientunicode='0';
                   2115:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2116:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2117: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2118: 	    $clientbrowser=$bname;
                   2119:             $httpbrowser=~/$vreg/i;
                   2120: 	    $clientversion=$1;
                   2121:             $clientmathml=($clientversion>=$minv);
                   2122:             $clientunicode=($clientversion>=$univ);
                   2123: 	}
                   2124:     }
                   2125:     my $clientos='unknown';
                   2126:     if (($httpbrowser=~/linux/i) ||
                   2127:         ($httpbrowser=~/unix/i) ||
                   2128:         ($httpbrowser=~/ux/i) ||
                   2129:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2130:     if (($httpbrowser=~/vax/i) ||
                   2131:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2132:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2133:     if (($httpbrowser=~/mac/i) ||
                   2134:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2135:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2136:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2137:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2138:             $clientunicode,$clientos,);
                   2139: }
                   2140: 
1.32      matthew  2141: ###############################################################
                   2142: ##    Authentication changing form generation subroutines    ##
                   2143: ###############################################################
                   2144: ##
                   2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2146: ## hash, and have reasonable default values.
                   2147: ##
                   2148: ##    formname = the name given in the <form> tag.
1.35      matthew  2149: #-------------------------------------------
                   2150: 
1.45      matthew  2151: =pod
                   2152: 
1.112     bowersj2 2153: =head1 Authentication Routines
                   2154: 
                   2155: =over 4
                   2156: 
1.648     raeburn  2157: =item * &authform_xxxxxx()
1.35      matthew  2158: 
                   2159: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2160: handle some of the conveniences required for authentication forms.  
                   2161: This is not an optimal method, but it works.  
                   2162: 
                   2163: =over 4
                   2164: 
1.112     bowersj2 2165: =item * authform_header
1.35      matthew  2166: 
1.112     bowersj2 2167: =item * authform_authorwarning
1.35      matthew  2168: 
1.112     bowersj2 2169: =item * authform_nochange
1.35      matthew  2170: 
1.112     bowersj2 2171: =item * authform_kerberos
1.35      matthew  2172: 
1.112     bowersj2 2173: =item * authform_internal
1.35      matthew  2174: 
1.112     bowersj2 2175: =item * authform_filesystem
1.35      matthew  2176: 
                   2177: =back
                   2178: 
1.648     raeburn  2179: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2180: 
1.35      matthew  2181: =cut
                   2182: 
                   2183: #-------------------------------------------
1.32      matthew  2184: sub authform_header{  
                   2185:     my %in = (
                   2186:         formname => 'cu',
1.80      albertel 2187:         kerb_def_dom => '',
1.32      matthew  2188:         @_,
                   2189:     );
                   2190:     $in{'formname'} = 'document.' . $in{'formname'};
                   2191:     my $result='';
1.80      albertel 2192: 
                   2193: #---------------------------------------------- Code for upper case translation
                   2194:     my $Javascript_toUpperCase;
                   2195:     unless ($in{kerb_def_dom}) {
                   2196:         $Javascript_toUpperCase =<<"END";
                   2197:         switch (choice) {
                   2198:            case 'krb': currentform.elements[choicearg].value =
                   2199:                currentform.elements[choicearg].value.toUpperCase();
                   2200:                break;
                   2201:            default:
                   2202:         }
                   2203: END
                   2204:     } else {
                   2205:         $Javascript_toUpperCase = "";
                   2206:     }
                   2207: 
1.165     raeburn  2208:     my $radioval = "'nochange'";
1.591     raeburn  2209:     if (defined($in{'curr_authtype'})) {
                   2210:         if ($in{'curr_authtype'} ne '') {
                   2211:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2212:         }
1.174     matthew  2213:     }
1.165     raeburn  2214:     my $argfield = 'null';
1.591     raeburn  2215:     if (defined($in{'mode'})) {
1.165     raeburn  2216:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2217:             if (defined($in{'curr_autharg'})) {
                   2218:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2219:                     $argfield = "'$in{'curr_autharg'}'";
                   2220:                 }
                   2221:             }
                   2222:         }
                   2223:     }
                   2224: 
1.32      matthew  2225:     $result.=<<"END";
                   2226: var current = new Object();
1.165     raeburn  2227: current.radiovalue = $radioval;
                   2228: current.argfield = $argfield;
1.32      matthew  2229: 
                   2230: function changed_radio(choice,currentform) {
                   2231:     var choicearg = choice + 'arg';
                   2232:     // If a radio button in changed, we need to change the argfield
                   2233:     if (current.radiovalue != choice) {
                   2234:         current.radiovalue = choice;
                   2235:         if (current.argfield != null) {
                   2236:             currentform.elements[current.argfield].value = '';
                   2237:         }
                   2238:         if (choice == 'nochange') {
                   2239:             current.argfield = null;
                   2240:         } else {
                   2241:             current.argfield = choicearg;
                   2242:             switch(choice) {
                   2243:                 case 'krb': 
                   2244:                     currentform.elements[current.argfield].value = 
                   2245:                         "$in{'kerb_def_dom'}";
                   2246:                 break;
                   2247:               default:
                   2248:                 break;
                   2249:             }
                   2250:         }
                   2251:     }
                   2252:     return;
                   2253: }
1.22      www      2254: 
1.32      matthew  2255: function changed_text(choice,currentform) {
                   2256:     var choicearg = choice + 'arg';
                   2257:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2258:         $Javascript_toUpperCase
1.32      matthew  2259:         // clear old field
                   2260:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2261:             currentform.elements[current.argfield].value = '';
                   2262:         }
                   2263:         current.argfield = choicearg;
                   2264:     }
                   2265:     set_auth_radio_buttons(choice,currentform);
                   2266:     return;
1.20      www      2267: }
1.32      matthew  2268: 
                   2269: function set_auth_radio_buttons(newvalue,currentform) {
                   2270:     var i=0;
                   2271:     while (i < currentform.login.length) {
                   2272:         if (currentform.login[i].value == newvalue) { break; }
                   2273:         i++;
                   2274:     }
                   2275:     if (i == currentform.login.length) {
                   2276:         return;
                   2277:     }
                   2278:     current.radiovalue = newvalue;
                   2279:     currentform.login[i].checked = true;
                   2280:     return;
                   2281: }
                   2282: END
                   2283:     return $result;
                   2284: }
                   2285: 
                   2286: sub authform_authorwarning{
                   2287:     my $result='';
1.144     matthew  2288:     $result='<i>'.
                   2289:         &mt('As a general rule, only authors or co-authors should be '.
                   2290:             'filesystem authenticated '.
                   2291:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_nochange{  
                   2296:     my %in = (
                   2297:               formname => 'document.cu',
                   2298:               kerb_def_dom => 'MSU.EDU',
                   2299:               @_,
                   2300:           );
1.586     raeburn  2301:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2302:     my $result;
                   2303:     if (keys(%can_assign) == 0) {
                   2304:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2305:     } else {
                   2306:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2307:                   '<input type="radio" name="login" value="nochange" '.
                   2308:                   'checked="checked" onclick="'.
1.281     albertel 2309:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2310: 	    '</label>';
1.586     raeburn  2311:     }
1.32      matthew  2312:     return $result;
                   2313: }
                   2314: 
1.591     raeburn  2315: sub authform_kerberos {
1.32      matthew  2316:     my %in = (
                   2317:               formname => 'document.cu',
                   2318:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2319:               kerb_def_auth => 'krb4',
1.32      matthew  2320:               @_,
                   2321:               );
1.586     raeburn  2322:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2323:         $autharg,$jscall);
                   2324:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2325:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2326:        $check5 = ' checked="checked"';
1.80      albertel 2327:     } else {
1.772     bisitz   2328:        $check4 = ' checked="checked"';
1.80      albertel 2329:     }
1.165     raeburn  2330:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2331:     if (defined($in{'curr_authtype'})) {
                   2332:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2333:             $krbcheck = ' checked="checked"';
1.623     raeburn  2334:             if (defined($in{'mode'})) {
                   2335:                 if ($in{'mode'} eq 'modifyuser') {
                   2336:                     $krbcheck = '';
                   2337:                 }
                   2338:             }
1.591     raeburn  2339:             if (defined($in{'curr_kerb_ver'})) {
                   2340:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2341:                     $check5 = ' checked="checked"';
1.591     raeburn  2342:                     $check4 = '';
                   2343:                 } else {
1.772     bisitz   2344:                     $check4 = ' checked="checked"';
1.591     raeburn  2345:                     $check5 = '';
                   2346:                 }
1.586     raeburn  2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2349:                 $krbarg = $in{'curr_autharg'};
                   2350:             }
1.586     raeburn  2351:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2352:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2353:                     $result = 
                   2354:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2355:         $in{'curr_autharg'},$krbver);
                   2356:                 } else {
                   2357:                     $result =
                   2358:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2359:                 }
                   2360:                 return $result; 
                   2361:             }
                   2362:         }
                   2363:     } else {
                   2364:         if ($authnum == 1) {
1.784     bisitz   2365:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2366:         }
                   2367:     }
1.586     raeburn  2368:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2369:         return;
1.587     raeburn  2370:     } elsif ($authtype eq '') {
1.591     raeburn  2371:         if (defined($in{'mode'})) {
1.587     raeburn  2372:             if ($in{'mode'} eq 'modifycourse') {
                   2373:                 if ($authnum == 1) {
1.784     bisitz   2374:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2375:                 }
                   2376:             }
                   2377:         }
1.586     raeburn  2378:     }
                   2379:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2380:     if ($authtype eq '') {
                   2381:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2382:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2383:                     $krbcheck.' />';
                   2384:     }
                   2385:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2386:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2387:          $in{'curr_authtype'} eq 'krb5') ||
                   2388:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2389:          $in{'curr_authtype'} eq 'krb4')) {
                   2390:         $result .= &mt
1.144     matthew  2391:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2392:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2393:          '<label>'.$authtype,
1.281     albertel 2394:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2395:              'value="'.$krbarg.'" '.
1.144     matthew  2396:              'onchange="'.$jscall.'" />',
1.281     albertel 2397:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2398:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2399: 	 '</label>');
1.586     raeburn  2400:     } elsif ($can_assign{'krb4'}) {
                   2401:         $result .= &mt
                   2402:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2403:          '[_3] Version 4 [_4]',
                   2404:          '<label>'.$authtype,
                   2405:          '</label><input type="text" size="10" name="krbarg" '.
                   2406:              'value="'.$krbarg.'" '.
                   2407:              'onchange="'.$jscall.'" />',
                   2408:          '<label><input type="hidden" name="krbver" value="4" />',
                   2409:          '</label>');
                   2410:     } elsif ($can_assign{'krb5'}) {
                   2411:         $result .= &mt
                   2412:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2413:          '[_3] Version 5 [_4]',
                   2414:          '<label>'.$authtype,
                   2415:          '</label><input type="text" size="10" name="krbarg" '.
                   2416:              'value="'.$krbarg.'" '.
                   2417:              'onchange="'.$jscall.'" />',
                   2418:          '<label><input type="hidden" name="krbver" value="5" />',
                   2419:          '</label>');
                   2420:     }
1.32      matthew  2421:     return $result;
                   2422: }
                   2423: 
                   2424: sub authform_internal{  
1.586     raeburn  2425:     my %in = (
1.32      matthew  2426:                 formname => 'document.cu',
                   2427:                 kerb_def_dom => 'MSU.EDU',
                   2428:                 @_,
                   2429:                 );
1.586     raeburn  2430:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2431:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2432:     if (defined($in{'curr_authtype'})) {
                   2433:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2434:             if ($can_assign{'int'}) {
1.772     bisitz   2435:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2436:                 if (defined($in{'mode'})) {
                   2437:                     if ($in{'mode'} eq 'modifyuser') {
                   2438:                         $intcheck = '';
                   2439:                     }
                   2440:                 }
1.591     raeburn  2441:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2442:                     $intarg = $in{'curr_autharg'};
                   2443:                 }
                   2444:             } else {
                   2445:                 $result = &mt('Currently internally authenticated.');
                   2446:                 return $result;
1.165     raeburn  2447:             }
                   2448:         }
1.586     raeburn  2449:     } else {
                   2450:         if ($authnum == 1) {
1.784     bisitz   2451:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2452:         }
                   2453:     }
                   2454:     if (!$can_assign{'int'}) {
                   2455:         return;
1.587     raeburn  2456:     } elsif ($authtype eq '') {
1.591     raeburn  2457:         if (defined($in{'mode'})) {
1.587     raeburn  2458:             if ($in{'mode'} eq 'modifycourse') {
                   2459:                 if ($authnum == 1) {
1.784     bisitz   2460:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2461:                 }
                   2462:             }
                   2463:         }
1.165     raeburn  2464:     }
1.586     raeburn  2465:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2466:     if ($authtype eq '') {
                   2467:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2468:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2469:     }
1.605     bisitz   2470:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2471:                $intarg.'" onchange="'.$jscall.'" />';
                   2472:     $result = &mt
1.144     matthew  2473:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2474:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2475:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2476:     return $result;
                   2477: }
                   2478: 
                   2479: sub authform_local{  
                   2480:     my %in = (
                   2481:               formname => 'document.cu',
                   2482:               kerb_def_dom => 'MSU.EDU',
                   2483:               @_,
                   2484:               );
1.586     raeburn  2485:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2486:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2487:     if (defined($in{'curr_authtype'})) {
                   2488:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2489:             if ($can_assign{'loc'}) {
1.772     bisitz   2490:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2491:                 if (defined($in{'mode'})) {
                   2492:                     if ($in{'mode'} eq 'modifyuser') {
                   2493:                         $loccheck = '';
                   2494:                     }
                   2495:                 }
1.591     raeburn  2496:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2497:                     $locarg = $in{'curr_autharg'};
                   2498:                 }
                   2499:             } else {
                   2500:                 $result = &mt('Currently using local (institutional) authentication.');
                   2501:                 return $result;
1.165     raeburn  2502:             }
                   2503:         }
1.586     raeburn  2504:     } else {
                   2505:         if ($authnum == 1) {
1.784     bisitz   2506:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2507:         }
                   2508:     }
                   2509:     if (!$can_assign{'loc'}) {
                   2510:         return;
1.587     raeburn  2511:     } elsif ($authtype eq '') {
1.591     raeburn  2512:         if (defined($in{'mode'})) {
1.587     raeburn  2513:             if ($in{'mode'} eq 'modifycourse') {
                   2514:                 if ($authnum == 1) {
1.784     bisitz   2515:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2516:                 }
                   2517:             }
                   2518:         }
1.165     raeburn  2519:     }
1.586     raeburn  2520:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2521:     if ($authtype eq '') {
                   2522:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2523:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2524:                     $jscall.'" />';
                   2525:     }
                   2526:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2527:                $locarg.'" onchange="'.$jscall.'" />';
                   2528:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2529:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2530:     return $result;
                   2531: }
                   2532: 
                   2533: sub authform_filesystem{  
                   2534:     my %in = (
                   2535:               formname => 'document.cu',
                   2536:               kerb_def_dom => 'MSU.EDU',
                   2537:               @_,
                   2538:               );
1.586     raeburn  2539:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2540:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2541:     if (defined($in{'curr_authtype'})) {
                   2542:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2543:             if ($can_assign{'fsys'}) {
1.772     bisitz   2544:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2545:                 if (defined($in{'mode'})) {
                   2546:                     if ($in{'mode'} eq 'modifyuser') {
                   2547:                         $fsyscheck = '';
                   2548:                     }
                   2549:                 }
1.586     raeburn  2550:             } else {
                   2551:                 $result = &mt('Currently Filesystem Authenticated.');
                   2552:                 return $result;
                   2553:             }           
                   2554:         }
                   2555:     } else {
                   2556:         if ($authnum == 1) {
1.784     bisitz   2557:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2558:         }
                   2559:     }
                   2560:     if (!$can_assign{'fsys'}) {
                   2561:         return;
1.587     raeburn  2562:     } elsif ($authtype eq '') {
1.591     raeburn  2563:         if (defined($in{'mode'})) {
1.587     raeburn  2564:             if ($in{'mode'} eq 'modifycourse') {
                   2565:                 if ($authnum == 1) {
1.784     bisitz   2566:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2567:                 }
                   2568:             }
                   2569:         }
1.586     raeburn  2570:     }
                   2571:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2572:     if ($authtype eq '') {
                   2573:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2574:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2575:                     $jscall.'" />';
                   2576:     }
                   2577:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2578:                ' onchange="'.$jscall.'" />';
                   2579:     $result = &mt
1.144     matthew  2580:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2581:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2582:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2583:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2584:                   'onchange="'.$jscall.'" />');
1.32      matthew  2585:     return $result;
                   2586: }
                   2587: 
1.586     raeburn  2588: sub get_assignable_auth {
                   2589:     my ($dom) = @_;
                   2590:     if ($dom eq '') {
                   2591:         $dom = $env{'request.role.domain'};
                   2592:     }
                   2593:     my %can_assign = (
                   2594:                           krb4 => 1,
                   2595:                           krb5 => 1,
                   2596:                           int  => 1,
                   2597:                           loc  => 1,
                   2598:                      );
                   2599:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2600:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2601:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2602:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2603:             my $context;
                   2604:             if ($env{'request.role'} =~ /^au/) {
                   2605:                 $context = 'author';
                   2606:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2607:                 $context = 'domain';
                   2608:             } elsif ($env{'request.course.id'}) {
                   2609:                 $context = 'course';
                   2610:             }
                   2611:             if ($context) {
                   2612:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2613:                    %can_assign = %{$authhash->{$context}}; 
                   2614:                 }
                   2615:             }
                   2616:         }
                   2617:     }
                   2618:     my $authnum = 0;
                   2619:     foreach my $key (keys(%can_assign)) {
                   2620:         if ($can_assign{$key}) {
                   2621:             $authnum ++;
                   2622:         }
                   2623:     }
                   2624:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2625:         $authnum --;
                   2626:     }
                   2627:     return ($authnum,%can_assign);
                   2628: }
                   2629: 
1.80      albertel 2630: ###############################################################
                   2631: ##    Get Kerberos Defaults for Domain                 ##
                   2632: ###############################################################
                   2633: ##
                   2634: ## Returns default kerberos version and an associated argument
                   2635: ## as listed in file domain.tab. If not listed, provides
                   2636: ## appropriate default domain and kerberos version.
                   2637: ##
                   2638: #-------------------------------------------
                   2639: 
                   2640: =pod
                   2641: 
1.648     raeburn  2642: =item * &get_kerberos_defaults()
1.80      albertel 2643: 
                   2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2645: version and domain. If not found, it defaults to version 4 and the 
                   2646: domain of the server.
1.80      albertel 2647: 
1.648     raeburn  2648: =over 4
                   2649: 
1.80      albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2651: 
1.648     raeburn  2652: =back
                   2653: 
                   2654: =back
                   2655: 
1.80      albertel 2656: =cut
                   2657: 
                   2658: #-------------------------------------------
                   2659: sub get_kerberos_defaults {
                   2660:     my $domain=shift;
1.641     raeburn  2661:     my ($krbdef,$krbdefdom);
                   2662:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2663:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2664:         $krbdef = $domdefaults{'auth_def'};
                   2665:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2666:     } else {
1.80      albertel 2667:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2668:         my $krbdefdom=$1;
                   2669:         $krbdefdom=~tr/a-z/A-Z/;
                   2670:         $krbdef = "krb4";
                   2671:     }
                   2672:     return ($krbdef,$krbdefdom);
                   2673: }
1.112     bowersj2 2674: 
1.32      matthew  2675: 
1.46      matthew  2676: ###############################################################
                   2677: ##                Thesaurus Functions                        ##
                   2678: ###############################################################
1.20      www      2679: 
1.46      matthew  2680: =pod
1.20      www      2681: 
1.112     bowersj2 2682: =head1 Thesaurus Functions
                   2683: 
                   2684: =over 4
                   2685: 
1.648     raeburn  2686: =item * &initialize_keywords()
1.46      matthew  2687: 
                   2688: Initializes the package variable %Keywords if it is empty.  Uses the
                   2689: package variable $thesaurus_db_file.
                   2690: 
                   2691: =cut
                   2692: 
                   2693: ###################################################
                   2694: 
                   2695: sub initialize_keywords {
                   2696:     return 1 if (scalar keys(%Keywords));
                   2697:     # If we are here, %Keywords is empty, so fill it up
                   2698:     #   Make sure the file we need exists...
                   2699:     if (! -e $thesaurus_db_file) {
                   2700:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2701:                                  " failed because it does not exist");
                   2702:         return 0;
                   2703:     }
                   2704:     #   Set up the hash as a database
                   2705:     my %thesaurus_db;
                   2706:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2707:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2708:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2709:                                  $thesaurus_db_file);
                   2710:         return 0;
                   2711:     } 
                   2712:     #  Get the average number of appearances of a word.
                   2713:     my $avecount = $thesaurus_db{'average.count'};
                   2714:     #  Put keywords (those that appear > average) into %Keywords
                   2715:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2716:         my ($count,undef) = split /:/,$data;
                   2717:         $Keywords{$word}++ if ($count > $avecount);
                   2718:     }
                   2719:     untie %thesaurus_db;
                   2720:     # Remove special values from %Keywords.
1.356     albertel 2721:     foreach my $value ('total.count','average.count') {
                   2722:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2723:   }
1.46      matthew  2724:     return 1;
                   2725: }
                   2726: 
                   2727: ###################################################
                   2728: 
                   2729: =pod
                   2730: 
1.648     raeburn  2731: =item * &keyword($word)
1.46      matthew  2732: 
                   2733: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2734: than the average number of times in the thesaurus database.  Calls 
                   2735: &initialize_keywords
                   2736: 
                   2737: =cut
                   2738: 
                   2739: ###################################################
1.20      www      2740: 
                   2741: sub keyword {
1.46      matthew  2742:     return if (!&initialize_keywords());
                   2743:     my $word=lc(shift());
                   2744:     $word=~s/\W//g;
                   2745:     return exists($Keywords{$word});
1.20      www      2746: }
1.46      matthew  2747: 
                   2748: ###############################################################
                   2749: 
                   2750: =pod 
1.20      www      2751: 
1.648     raeburn  2752: =item * &get_related_words()
1.46      matthew  2753: 
1.160     matthew  2754: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2755: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2756: will be returned.  The order of the words returned is determined by the
                   2757: database which holds them.
                   2758: 
                   2759: Uses global $thesaurus_db_file.
                   2760: 
                   2761: =cut
                   2762: 
                   2763: ###############################################################
                   2764: sub get_related_words {
                   2765:     my $keyword = shift;
                   2766:     my %thesaurus_db;
                   2767:     if (! -e $thesaurus_db_file) {
                   2768:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2769:                                  "failed because the file does not exist");
                   2770:         return ();
                   2771:     }
                   2772:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2773:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2774:         return ();
                   2775:     } 
                   2776:     my @Words=();
1.429     www      2777:     my $count=0;
1.46      matthew  2778:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2779: 	# The first element is the number of times
                   2780: 	# the word appears.  We do not need it now.
1.429     www      2781: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2782: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2783: 	my $threshold=$mostfrequentcount/10;
                   2784:         foreach my $possibleword (@RelatedWords) {
                   2785:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2786:             if ($wordcount>$threshold) {
                   2787: 		push(@Words,$word);
                   2788:                 $count++;
                   2789:                 if ($count>10) { last; }
                   2790: 	    }
1.20      www      2791:         }
                   2792:     }
1.46      matthew  2793:     untie %thesaurus_db;
                   2794:     return @Words;
1.14      harris41 2795: }
1.46      matthew  2796: 
1.112     bowersj2 2797: =pod
                   2798: 
                   2799: =back
                   2800: 
                   2801: =cut
1.61      www      2802: 
                   2803: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2804: =pod
                   2805: 
1.112     bowersj2 2806: =head1 User Name Functions
                   2807: 
                   2808: =over 4
                   2809: 
1.648     raeburn  2810: =item * &plainname($uname,$udom,$first)
1.81      albertel 2811: 
1.112     bowersj2 2812: Takes a users logon name and returns it as a string in
1.226     albertel 2813: "first middle last generation" form 
                   2814: if $first is set to 'lastname' then it returns it as
                   2815: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2816: 
                   2817: =cut
1.61      www      2818: 
1.295     www      2819: 
1.81      albertel 2820: ###############################################################
1.61      www      2821: sub plainname {
1.226     albertel 2822:     my ($uname,$udom,$first)=@_;
1.537     albertel 2823:     return if (!defined($uname) || !defined($udom));
1.295     www      2824:     my %names=&getnames($uname,$udom);
1.226     albertel 2825:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2826: 					  $names{'middlename'},
                   2827: 					  $names{'lastname'},
                   2828: 					  $names{'generation'},$first);
                   2829:     $name=~s/^\s+//;
1.62      www      2830:     $name=~s/\s+$//;
                   2831:     $name=~s/\s+/ /g;
1.353     albertel 2832:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2833:     return $name;
1.61      www      2834: }
1.66      www      2835: 
                   2836: # -------------------------------------------------------------------- Nickname
1.81      albertel 2837: =pod
                   2838: 
1.648     raeburn  2839: =item * &nickname($uname,$udom)
1.81      albertel 2840: 
                   2841: Gets a users name and returns it as a string as
                   2842: 
                   2843: "&quot;nickname&quot;"
1.66      www      2844: 
1.81      albertel 2845: if the user has a nickname or
                   2846: 
                   2847: "first middle last generation"
                   2848: 
                   2849: if the user does not
                   2850: 
                   2851: =cut
1.66      www      2852: 
                   2853: sub nickname {
                   2854:     my ($uname,$udom)=@_;
1.537     albertel 2855:     return if (!defined($uname) || !defined($udom));
1.295     www      2856:     my %names=&getnames($uname,$udom);
1.68      albertel 2857:     my $name=$names{'nickname'};
1.66      www      2858:     if ($name) {
                   2859:        $name='&quot;'.$name.'&quot;'; 
                   2860:     } else {
                   2861:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2862: 	     $names{'lastname'}.' '.$names{'generation'};
                   2863:        $name=~s/\s+$//;
                   2864:        $name=~s/\s+/ /g;
                   2865:     }
                   2866:     return $name;
                   2867: }
                   2868: 
1.295     www      2869: sub getnames {
                   2870:     my ($uname,$udom)=@_;
1.537     albertel 2871:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2872:     if ($udom eq 'public' && $uname eq 'public') {
                   2873: 	return ('lastname' => &mt('Public'));
                   2874:     }
1.295     www      2875:     my $id=$uname.':'.$udom;
                   2876:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2877:     if ($cached) {
                   2878: 	return %{$names};
                   2879:     } else {
                   2880: 	my %loadnames=&Apache::lonnet::get('environment',
                   2881:                     ['firstname','middlename','lastname','generation','nickname'],
                   2882: 					 $udom,$uname);
                   2883: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2884: 	return %loadnames;
                   2885:     }
                   2886: }
1.61      www      2887: 
1.542     raeburn  2888: # -------------------------------------------------------------------- getemails
1.648     raeburn  2889: 
1.542     raeburn  2890: =pod
                   2891: 
1.648     raeburn  2892: =item * &getemails($uname,$udom)
1.542     raeburn  2893: 
                   2894: Gets a user's email information and returns it as a hash with keys:
                   2895: notification, critnotification, permanentemail
                   2896: 
                   2897: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2899:  
1.648     raeburn  2900: 
1.542     raeburn  2901: =cut
                   2902: 
1.648     raeburn  2903: 
1.466     albertel 2904: sub getemails {
                   2905:     my ($uname,$udom)=@_;
                   2906:     if ($udom eq 'public' && $uname eq 'public') {
                   2907: 	return;
                   2908:     }
1.467     www      2909:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2910:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2911:     my $id=$uname.':'.$udom;
                   2912:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2913:     if ($cached) {
                   2914: 	return %{$names};
                   2915:     } else {
                   2916: 	my %loadnames=&Apache::lonnet::get('environment',
                   2917:                     			   ['notification','critnotification',
                   2918: 					    'permanentemail'],
                   2919: 					   $udom,$uname);
                   2920: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2921: 	return %loadnames;
                   2922:     }
                   2923: }
                   2924: 
1.551     albertel 2925: sub flush_email_cache {
                   2926:     my ($uname,$udom)=@_;
                   2927:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2928:     if (!$uname) { $uname=$env{'user.name'};   }
                   2929:     return if ($udom eq 'public' && $uname eq 'public');
                   2930:     my $id=$uname.':'.$udom;
                   2931:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2932: }
                   2933: 
1.728     raeburn  2934: # -------------------------------------------------------------------- getlangs
                   2935: 
                   2936: =pod
                   2937: 
                   2938: =item * &getlangs($uname,$udom)
                   2939: 
                   2940: Gets a user's language preference and returns it as a hash with key:
                   2941: language.
                   2942: 
                   2943: =cut
                   2944: 
                   2945: 
                   2946: sub getlangs {
                   2947:     my ($uname,$udom) = @_;
                   2948:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2949:     if (!$uname) { $uname=$env{'user.name'};   }
                   2950:     my $id=$uname.':'.$udom;
                   2951:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2952:     if ($cached) {
                   2953:         return %{$langs};
                   2954:     } else {
                   2955:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2956:                                            $udom,$uname);
                   2957:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2958:         return %loadlangs;
                   2959:     }
                   2960: }
                   2961: 
                   2962: sub flush_langs_cache {
                   2963:     my ($uname,$udom)=@_;
                   2964:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2965:     if (!$uname) { $uname=$env{'user.name'};   }
                   2966:     return if ($udom eq 'public' && $uname eq 'public');
                   2967:     my $id=$uname.':'.$udom;
                   2968:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2969: }
                   2970: 
1.61      www      2971: # ------------------------------------------------------------------ Screenname
1.81      albertel 2972: 
                   2973: =pod
                   2974: 
1.648     raeburn  2975: =item * &screenname($uname,$udom)
1.81      albertel 2976: 
                   2977: Gets a users screenname and returns it as a string
                   2978: 
                   2979: =cut
1.61      www      2980: 
                   2981: sub screenname {
                   2982:     my ($uname,$udom)=@_;
1.258     albertel 2983:     if ($uname eq $env{'user.name'} &&
                   2984: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2985:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2986:     return $names{'screenname'};
1.62      www      2987: }
                   2988: 
1.212     albertel 2989: 
1.802     bisitz   2990: # ------------------------------------------------------------- Confirm Wrapper
                   2991: =pod
                   2992: 
                   2993: =item confirmwrapper
                   2994: 
                   2995: Wrap messages about completion of operation in box
                   2996: 
                   2997: =cut
                   2998: 
                   2999: sub confirmwrapper {
                   3000:     my ($message)=@_;
                   3001:     if ($message) {
                   3002:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3003:                .$message."\n"
                   3004:                .'</div>'."\n";
                   3005:     } else {
                   3006:         return $message;
                   3007:     }
                   3008: }
                   3009: 
1.62      www      3010: # ------------------------------------------------------------- Message Wrapper
                   3011: 
                   3012: sub messagewrapper {
1.369     www      3013:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3014:     return 
1.441     albertel 3015:         '<a href="/adm/email?compose=individual&amp;'.
                   3016:         'recname='.$username.'&amp;recdom='.$domain.
                   3017: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3018:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3019: }
1.802     bisitz   3020: 
1.74      www      3021: # --------------------------------------------------------------- Notes Wrapper
                   3022: 
                   3023: sub noteswrapper {
                   3024:     my ($link,$un,$do)=@_;
                   3025:     return 
1.896     amueller 3026: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3027: }
1.802     bisitz   3028: 
1.62      www      3029: # ------------------------------------------------------------- Aboutme Wrapper
                   3030: 
                   3031: sub aboutmewrapper {
1.166     www      3032:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3033:     if (!defined($username)  && !defined($domain)) {
                   3034:         return;
                   3035:     }
1.892     amueller 3036:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3037: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3038: }
                   3039: 
                   3040: # ------------------------------------------------------------ Syllabus Wrapper
                   3041: 
                   3042: sub syllabuswrapper {
1.707     bisitz   3043:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3044:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3045: }
1.14      harris41 3046: 
1.802     bisitz   3047: # -----------------------------------------------------------------------------
                   3048: 
1.208     matthew  3049: sub track_student_link {
1.887     raeburn  3050:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3051:     my $link ="/adm/trackstudent?";
1.208     matthew  3052:     my $title = 'View recent activity';
                   3053:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3054:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3055:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3056:         $title .= ' of this student';
1.268     albertel 3057:     } 
1.208     matthew  3058:     if (defined($target) && $target !~ /^\s*$/) {
                   3059:         $target = qq{target="$target"};
                   3060:     } else {
                   3061:         $target = '';
                   3062:     }
1.268     albertel 3063:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3064:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3065:     $title = &mt($title);
                   3066:     $linktext = &mt($linktext);
1.448     albertel 3067:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3068: 	&help_open_topic('View_recent_activity');
1.208     matthew  3069: }
                   3070: 
1.781     raeburn  3071: sub slot_reservations_link {
                   3072:     my ($linktext,$sname,$sdom,$target) = @_;
                   3073:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3074:     my $title = 'View slot reservation history';
                   3075:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3076:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3077:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3078:         $title .= ' of this student';
                   3079:     }
                   3080:     if (defined($target) && $target !~ /^\s*$/) {
                   3081:         $target = qq{target="$target"};
                   3082:     } else {
                   3083:         $target = '';
                   3084:     }
                   3085:     $title = &mt($title);
                   3086:     $linktext = &mt($linktext);
                   3087:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3089: 
                   3090: }
                   3091: 
1.508     www      3092: # ===================================================== Display a student photo
                   3093: 
                   3094: 
1.509     albertel 3095: sub student_image_tag {
1.508     www      3096:     my ($domain,$user)=@_;
                   3097:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3098:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3099: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3100:     } else {
                   3101: 	return '';
                   3102:     }
                   3103: }
                   3104: 
1.112     bowersj2 3105: =pod
                   3106: 
                   3107: =back
                   3108: 
                   3109: =head1 Access .tab File Data
                   3110: 
                   3111: =over 4
                   3112: 
1.648     raeburn  3113: =item * &languageids() 
1.112     bowersj2 3114: 
                   3115: returns list of all language ids
                   3116: 
                   3117: =cut
                   3118: 
1.14      harris41 3119: sub languageids {
1.16      harris41 3120:     return sort(keys(%language));
1.14      harris41 3121: }
                   3122: 
1.112     bowersj2 3123: =pod
                   3124: 
1.648     raeburn  3125: =item * &languagedescription() 
1.112     bowersj2 3126: 
                   3127: returns description of a specified language id
                   3128: 
                   3129: =cut
                   3130: 
1.14      harris41 3131: sub languagedescription {
1.125     www      3132:     my $code=shift;
                   3133:     return  ($supported_language{$code}?'* ':'').
                   3134:             $language{$code}.
1.126     www      3135: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3136: }
                   3137: 
                   3138: sub plainlanguagedescription {
                   3139:     my $code=shift;
                   3140:     return $language{$code};
                   3141: }
                   3142: 
                   3143: sub supportedlanguagecode {
                   3144:     my $code=shift;
                   3145:     return $supported_language{$code};
1.97      www      3146: }
                   3147: 
1.112     bowersj2 3148: =pod
                   3149: 
1.648     raeburn  3150: =item * &copyrightids() 
1.112     bowersj2 3151: 
                   3152: returns list of all copyrights
                   3153: 
                   3154: =cut
                   3155: 
                   3156: sub copyrightids {
                   3157:     return sort(keys(%cprtag));
                   3158: }
                   3159: 
                   3160: =pod
                   3161: 
1.648     raeburn  3162: =item * &copyrightdescription() 
1.112     bowersj2 3163: 
                   3164: returns description of a specified copyright id
                   3165: 
                   3166: =cut
                   3167: 
                   3168: sub copyrightdescription {
1.166     www      3169:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3170: }
1.197     matthew  3171: 
                   3172: =pod
                   3173: 
1.648     raeburn  3174: =item * &source_copyrightids() 
1.192     taceyjo1 3175: 
                   3176: returns list of all source copyrights
                   3177: 
                   3178: =cut
                   3179: 
                   3180: sub source_copyrightids {
                   3181:     return sort(keys(%scprtag));
                   3182: }
                   3183: 
                   3184: =pod
                   3185: 
1.648     raeburn  3186: =item * &source_copyrightdescription() 
1.192     taceyjo1 3187: 
                   3188: returns description of a specified source copyright id
                   3189: 
                   3190: =cut
                   3191: 
                   3192: sub source_copyrightdescription {
                   3193:     return &mt($scprtag{shift(@_)});
                   3194: }
1.112     bowersj2 3195: 
                   3196: =pod
                   3197: 
1.648     raeburn  3198: =item * &filecategories() 
1.112     bowersj2 3199: 
                   3200: returns list of all file categories
                   3201: 
                   3202: =cut
                   3203: 
                   3204: sub filecategories {
                   3205:     return sort(keys(%category_extensions));
                   3206: }
                   3207: 
                   3208: =pod
                   3209: 
1.648     raeburn  3210: =item * &filecategorytypes() 
1.112     bowersj2 3211: 
                   3212: returns list of file types belonging to a given file
                   3213: category
                   3214: 
                   3215: =cut
                   3216: 
                   3217: sub filecategorytypes {
1.356     albertel 3218:     my ($cat) = @_;
                   3219:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3220: }
                   3221: 
                   3222: =pod
                   3223: 
1.648     raeburn  3224: =item * &fileembstyle() 
1.112     bowersj2 3225: 
                   3226: returns embedding style for a specified file type
                   3227: 
                   3228: =cut
                   3229: 
                   3230: sub fileembstyle {
                   3231:     return $fe{lc(shift(@_))};
1.169     www      3232: }
                   3233: 
1.351     www      3234: sub filemimetype {
                   3235:     return $fm{lc(shift(@_))};
                   3236: }
                   3237: 
1.169     www      3238: 
                   3239: sub filecategoryselect {
                   3240:     my ($name,$value)=@_;
1.189     matthew  3241:     return &select_form($value,$name,
1.169     www      3242: 			'' => &mt('Any category'),
                   3243: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3244: }
                   3245: 
                   3246: =pod
                   3247: 
1.648     raeburn  3248: =item * &filedescription() 
1.112     bowersj2 3249: 
                   3250: returns description for a specified file type
                   3251: 
                   3252: =cut
                   3253: 
                   3254: sub filedescription {
1.188     matthew  3255:     my $file_description = $fd{lc(shift())};
                   3256:     $file_description =~ s:([\[\]]):~$1:g;
                   3257:     return &mt($file_description);
1.112     bowersj2 3258: }
                   3259: 
                   3260: =pod
                   3261: 
1.648     raeburn  3262: =item * &filedescriptionex() 
1.112     bowersj2 3263: 
                   3264: returns description for a specified file type with
                   3265: extra formatting
                   3266: 
                   3267: =cut
                   3268: 
                   3269: sub filedescriptionex {
                   3270:     my $ex=shift;
1.188     matthew  3271:     my $file_description = $fd{lc($ex)};
                   3272:     $file_description =~ s:([\[\]]):~$1:g;
                   3273:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3274: }
                   3275: 
                   3276: # End of .tab access
                   3277: =pod
                   3278: 
                   3279: =back
                   3280: 
                   3281: =cut
                   3282: 
                   3283: # ------------------------------------------------------------------ File Types
                   3284: sub fileextensions {
                   3285:     return sort(keys(%fe));
                   3286: }
                   3287: 
1.97      www      3288: # ----------------------------------------------------------- Display Languages
                   3289: # returns a hash with all desired display languages
                   3290: #
                   3291: 
                   3292: sub display_languages {
                   3293:     my %languages=();
1.695     raeburn  3294:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3295: 	$languages{$lang}=1;
1.97      www      3296:     }
                   3297:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3298:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3299: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3300: 	    $languages{$lang}=1;
1.97      www      3301:         }
                   3302:     }
                   3303:     return %languages;
1.14      harris41 3304: }
                   3305: 
1.582     albertel 3306: sub languages {
                   3307:     my ($possible_langs) = @_;
1.695     raeburn  3308:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3309:     if (!ref($possible_langs)) {
                   3310: 	if( wantarray ) {
                   3311: 	    return @preferred_langs;
                   3312: 	} else {
                   3313: 	    return $preferred_langs[0];
                   3314: 	}
                   3315:     }
                   3316:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3317:     my @preferred_possibilities;
                   3318:     foreach my $preferred_lang (@preferred_langs) {
                   3319: 	if (exists($possibilities{$preferred_lang})) {
                   3320: 	    push(@preferred_possibilities, $preferred_lang);
                   3321: 	}
                   3322:     }
                   3323:     if( wantarray ) {
                   3324: 	return @preferred_possibilities;
                   3325:     }
                   3326:     return $preferred_possibilities[0];
                   3327: }
                   3328: 
1.742     raeburn  3329: sub user_lang {
                   3330:     my ($touname,$toudom,$fromcid) = @_;
                   3331:     my @userlangs;
                   3332:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3333:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3334:                     $env{'course.'.$fromcid.'.languages'}));
                   3335:     } else {
                   3336:         my %langhash = &getlangs($touname,$toudom);
                   3337:         if ($langhash{'languages'} ne '') {
                   3338:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3339:         } else {
                   3340:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3341:             if ($domdefs{'lang_def'} ne '') {
                   3342:                 @userlangs = ($domdefs{'lang_def'});
                   3343:             }
                   3344:         }
                   3345:     }
                   3346:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3347:     my $user_lh = Apache::localize->get_handle(@languages);
                   3348:     return $user_lh;
                   3349: }
                   3350: 
                   3351: 
1.112     bowersj2 3352: ###############################################################
                   3353: ##               Student Answer Attempts                     ##
                   3354: ###############################################################
                   3355: 
                   3356: =pod
                   3357: 
                   3358: =head1 Alternate Problem Views
                   3359: 
                   3360: =over 4
                   3361: 
1.648     raeburn  3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3363:     $getattempt, $regexp, $gradesub)
                   3364: 
                   3365: Return string with previous attempt on problem. Arguments:
                   3366: 
                   3367: =over 4
                   3368: 
                   3369: =item * $symb: Problem, including path
                   3370: 
                   3371: =item * $username: username of the desired student
                   3372: 
                   3373: =item * $domain: domain of the desired student
1.14      harris41 3374: 
1.112     bowersj2 3375: =item * $course: Course ID
1.14      harris41 3376: 
1.112     bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3378:     something
1.14      harris41 3379: 
1.112     bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
                   3381:     sent to $gradesub
1.14      harris41 3382: 
1.112     bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3384: 
1.112     bowersj2 3385: =back
1.14      harris41 3386: 
1.112     bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16      harris41 3388: 
1.112     bowersj2 3389: =cut
1.1       albertel 3390: 
                   3391: sub get_previous_attempt {
1.43      ng       3392:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3393:   my $prevattempts='';
1.43      ng       3394:   no strict 'refs';
1.1       albertel 3395:   if ($symb) {
1.3       albertel 3396:     my (%returnhash)=
                   3397:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3398:     if ($returnhash{'version'}) {
                   3399:       my %lasthash=();
                   3400:       my $version;
                   3401:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3402:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3403: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3404:         }
1.1       albertel 3405:       }
1.596     albertel 3406:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3407:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3408:       foreach my $key (sort(keys(%lasthash))) {
                   3409: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3410: 	if ($#parts > 0) {
1.31      albertel 3411: 	  my $data=$parts[-1];
                   3412: 	  pop(@parts);
1.596     albertel 3413: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3414: 	} else {
1.41      ng       3415: 	  if ($#parts == 0) {
                   3416: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3417: 	  } else {
                   3418: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3419: 	  }
1.31      albertel 3420: 	}
1.16      harris41 3421:       }
1.596     albertel 3422:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3423:       if ($getattempt eq '') {
                   3424: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3425: 	  $prevattempts.=&start_data_table_row().
                   3426: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3427: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3428: 		my $value = &format_previous_attempt_value($key,
                   3429: 							   $returnhash{$version.':'.$key});
                   3430: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3431: 	    }
1.596     albertel 3432: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3433: 	 }
1.1       albertel 3434:       }
1.596     albertel 3435:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3436:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3437: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3438: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3439: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3440:       }
1.596     albertel 3441:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3442:     } else {
1.596     albertel 3443:       $prevattempts=
                   3444: 	  &start_data_table().&start_data_table_row().
                   3445: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3446: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3447:     }
                   3448:   } else {
1.596     albertel 3449:     $prevattempts=
                   3450: 	  &start_data_table().&start_data_table_row().
                   3451: 	  '<td>'.&mt('No data.').'</td>'.
                   3452: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3453:   }
1.10      albertel 3454: }
                   3455: 
1.581     albertel 3456: sub format_previous_attempt_value {
                   3457:     my ($key,$value) = @_;
                   3458:     if ($key =~ /timestamp/) {
                   3459: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3460:     } elsif (ref($value) eq 'ARRAY') {
                   3461: 	$value = '('.join(', ', @{ $value }).')';
                   3462:     } else {
                   3463: 	$value = &unescape($value);
                   3464:     }
                   3465:     return $value;
                   3466: }
                   3467: 
                   3468: 
1.107     albertel 3469: sub relative_to_absolute {
                   3470:     my ($url,$output)=@_;
                   3471:     my $parser=HTML::TokeParser->new(\$output);
                   3472:     my $token;
                   3473:     my $thisdir=$url;
                   3474:     my @rlinks=();
                   3475:     while ($token=$parser->get_token) {
                   3476: 	if ($token->[0] eq 'S') {
                   3477: 	    if ($token->[1] eq 'a') {
                   3478: 		if ($token->[2]->{'href'}) {
                   3479: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3480: 		}
                   3481: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3482: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3483: 	    } elsif ($token->[1] eq 'base') {
                   3484: 		$thisdir=$token->[2]->{'href'};
                   3485: 	    }
                   3486: 	}
                   3487:     }
                   3488:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3489:     foreach my $link (@rlinks) {
1.726     raeburn  3490: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3491: 		($link=~/^\//) ||
                   3492: 		($link=~/^javascript:/i) ||
                   3493: 		($link=~/^mailto:/i) ||
                   3494: 		($link=~/^\#/)) {
                   3495: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3496: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3497: 	}
                   3498:     }
                   3499: # -------------------------------------------------- Deal with Applet codebases
                   3500:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3501:     return $output;
                   3502: }
                   3503: 
1.112     bowersj2 3504: =pod
                   3505: 
1.648     raeburn  3506: =item * &get_student_view()
1.112     bowersj2 3507: 
                   3508: show a snapshot of what student was looking at
                   3509: 
                   3510: =cut
                   3511: 
1.10      albertel 3512: sub get_student_view {
1.186     albertel 3513:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3514:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3515:   my (%form);
1.10      albertel 3516:   my @elements=('symb','courseid','domain','username');
                   3517:   foreach my $element (@elements) {
1.186     albertel 3518:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3519:   }
1.186     albertel 3520:   if (defined($moreenv)) {
                   3521:       %form=(%form,%{$moreenv});
                   3522:   }
1.236     albertel 3523:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3524:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3525:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3526:   $userview=~s/\<body[^\>]*\>//gi;
                   3527:   $userview=~s/\<\/body\>//gi;
                   3528:   $userview=~s/\<html\>//gi;
                   3529:   $userview=~s/\<\/html\>//gi;
                   3530:   $userview=~s/\<head\>//gi;
                   3531:   $userview=~s/\<\/head\>//gi;
                   3532:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3533:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3534:   if (wantarray) {
                   3535:      return ($userview,$response);
                   3536:   } else {
                   3537:      return $userview;
                   3538:   }
                   3539: }
                   3540: 
                   3541: sub get_student_view_with_retries {
                   3542:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3543: 
                   3544:     my $ok = 0;                 # True if we got a good response.
                   3545:     my $content;
                   3546:     my $response;
                   3547: 
                   3548:     # Try to get the student_view done. within the retries count:
                   3549:     
                   3550:     do {
                   3551:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3552:          $ok      = $response->is_success;
                   3553:          if (!$ok) {
                   3554:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3555:          }
                   3556:          $retries--;
                   3557:     } while (!$ok && ($retries > 0));
                   3558:     
                   3559:     if (!$ok) {
                   3560:        $content = '';          # On error return an empty content.
                   3561:     }
1.651     www      3562:     if (wantarray) {
                   3563:        return ($content, $response);
                   3564:     } else {
                   3565:        return $content;
                   3566:     }
1.11      albertel 3567: }
                   3568: 
1.112     bowersj2 3569: =pod
                   3570: 
1.648     raeburn  3571: =item * &get_student_answers() 
1.112     bowersj2 3572: 
                   3573: show a snapshot of how student was answering problem
                   3574: 
                   3575: =cut
                   3576: 
1.11      albertel 3577: sub get_student_answers {
1.100     sakharuk 3578:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3579:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3580:   my (%moreenv);
1.11      albertel 3581:   my @elements=('symb','courseid','domain','username');
                   3582:   foreach my $element (@elements) {
1.186     albertel 3583:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3584:   }
1.186     albertel 3585:   $moreenv{'grade_target'}='answer';
                   3586:   %moreenv=(%form,%moreenv);
1.497     raeburn  3587:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3588:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3589:   return $userview;
1.1       albertel 3590: }
1.116     albertel 3591: 
                   3592: =pod
                   3593: 
                   3594: =item * &submlink()
                   3595: 
1.242     albertel 3596: Inputs: $text $uname $udom $symb $target
1.116     albertel 3597: 
                   3598: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3599: 
                   3600: =cut
                   3601: 
                   3602: ###############################################
                   3603: sub submlink {
1.242     albertel 3604:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3605:     if (!($uname && $udom)) {
                   3606: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3607: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3608: 	if (!$symb) { $symb=$cursymb; }
                   3609:     }
1.254     matthew  3610:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3611:     $symb=&escape($symb);
1.242     albertel 3612:     if ($target) { $target="target=\"$target\""; }
                   3613:     return '<a href="/adm/grades?&command=submission&'.
                   3614: 	'symb='.$symb.'&student='.$uname.
                   3615: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3616: }
                   3617: ##############################################
                   3618: 
                   3619: =pod
                   3620: 
                   3621: =item * &pgrdlink()
                   3622: 
                   3623: Inputs: $text $uname $udom $symb $target
                   3624: 
                   3625: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3626: 
                   3627: =cut
                   3628: 
                   3629: ###############################################
                   3630: sub pgrdlink {
                   3631:     my $link=&submlink(@_);
                   3632:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3633:     return $link;
                   3634: }
                   3635: ##############################################
                   3636: 
                   3637: =pod
                   3638: 
                   3639: =item * &pprmlink()
                   3640: 
                   3641: Inputs: $text $uname $udom $symb $target
                   3642: 
                   3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3644: student and a specific resource
1.242     albertel 3645: 
                   3646: =cut
                   3647: 
                   3648: ###############################################
                   3649: sub pprmlink {
                   3650:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3651:     if (!($uname && $udom)) {
                   3652: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3653: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3654: 	if (!$symb) { $symb=$cursymb; }
                   3655:     }
1.254     matthew  3656:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3657:     $symb=&escape($symb);
1.242     albertel 3658:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3659:     return '<a href="/adm/parmset?command=set&amp;'.
                   3660: 	'symb='.$symb.'&amp;uname='.$uname.
                   3661: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3662: }
                   3663: ##############################################
1.37      matthew  3664: 
1.112     bowersj2 3665: =pod
                   3666: 
                   3667: =back
                   3668: 
                   3669: =cut
                   3670: 
1.37      matthew  3671: ###############################################
1.51      www      3672: 
                   3673: 
                   3674: sub timehash {
1.687     raeburn  3675:     my ($thistime) = @_;
                   3676:     my $timezone = &Apache::lonlocal::gettimezone();
                   3677:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3678:                      ->set_time_zone($timezone);
                   3679:     my $wday = $dt->day_of_week();
                   3680:     if ($wday == 7) { $wday = 0; }
                   3681:     return ( 'second' => $dt->second(),
                   3682:              'minute' => $dt->minute(),
                   3683:              'hour'   => $dt->hour(),
                   3684:              'day'     => $dt->day_of_month(),
                   3685:              'month'   => $dt->month(),
                   3686:              'year'    => $dt->year(),
                   3687:              'weekday' => $wday,
                   3688:              'dayyear' => $dt->day_of_year(),
                   3689:              'dlsav'   => $dt->is_dst() );
1.51      www      3690: }
                   3691: 
1.370     www      3692: sub utc_string {
                   3693:     my ($date)=@_;
1.371     www      3694:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3695: }
                   3696: 
1.51      www      3697: sub maketime {
                   3698:     my %th=@_;
1.687     raeburn  3699:     my ($epoch_time,$timezone,$dt);
                   3700:     $timezone = &Apache::lonlocal::gettimezone();
                   3701:     eval {
                   3702:         $dt = DateTime->new( year   => $th{'year'},
                   3703:                              month  => $th{'month'},
                   3704:                              day    => $th{'day'},
                   3705:                              hour   => $th{'hour'},
                   3706:                              minute => $th{'minute'},
                   3707:                              second => $th{'second'},
                   3708:                              time_zone => $timezone,
                   3709:                          );
                   3710:     };
                   3711:     if (!$@) {
                   3712:         $epoch_time = $dt->epoch;
                   3713:         if ($epoch_time) {
                   3714:             return $epoch_time;
                   3715:         }
                   3716:     }
1.51      www      3717:     return POSIX::mktime(
                   3718:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3719:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3720: }
                   3721: 
                   3722: #########################################
1.51      www      3723: 
                   3724: sub findallcourses {
1.482     raeburn  3725:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3726:     my %roles;
                   3727:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3728:     my %courses;
1.51      www      3729:     my $now=time;
1.482     raeburn  3730:     if (!defined($uname)) {
                   3731:         $uname = $env{'user.name'};
                   3732:     }
                   3733:     if (!defined($udom)) {
                   3734:         $udom = $env{'user.domain'};
                   3735:     }
                   3736:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3737:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3738:         if (!%roles) {
                   3739:             %roles = (
                   3740:                        cc => 1,
1.907     raeburn  3741:                        co => 1,
1.482     raeburn  3742:                        in => 1,
                   3743:                        ep => 1,
                   3744:                        ta => 1,
                   3745:                        cr => 1,
                   3746:                        st => 1,
                   3747:              );
                   3748:         }
                   3749:         foreach my $entry (keys(%roleshash)) {
                   3750:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3751:             if ($trole =~ /^cr/) { 
                   3752:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3753:             } else {
                   3754:                 next if (!exists($roles{$trole}));
                   3755:             }
                   3756:             if ($tend) {
                   3757:                 next if ($tend < $now);
                   3758:             }
                   3759:             if ($tstart) {
                   3760:                 next if ($tstart > $now);
                   3761:             }
                   3762:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3763:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3764:             if ($secpart eq '') {
                   3765:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3766:                 $sec = 'none';
                   3767:                 $realsec = '';
                   3768:             } else {
                   3769:                 $cnum = $cnumpart;
                   3770:                 ($sec,$role) = split(/_/,$secpart);
                   3771:                 $realsec = $sec;
1.490     raeburn  3772:             }
1.482     raeburn  3773:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3774:         }
                   3775:     } else {
                   3776:         foreach my $key (keys(%env)) {
1.483     albertel 3777: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3778:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3779: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3780: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3781: 	        next if (%roles && !exists($roles{$role}));
                   3782: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3783:                 my $active=1;
                   3784:                 if ($starttime) {
                   3785: 		    if ($now<$starttime) { $active=0; }
                   3786:                 }
                   3787:                 if ($endtime) {
                   3788:                     if ($now>$endtime) { $active=0; }
                   3789:                 }
                   3790:                 if ($active) {
                   3791:                     if ($sec eq '') {
                   3792:                         $sec = 'none';
                   3793:                     }
                   3794:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3795:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3796:                 }
                   3797:             }
1.51      www      3798:         }
                   3799:     }
1.474     raeburn  3800:     return %courses;
1.51      www      3801: }
1.37      matthew  3802: 
1.54      www      3803: ###############################################
1.474     raeburn  3804: 
                   3805: sub blockcheck {
1.482     raeburn  3806:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3807: 
                   3808:     if (!defined($udom)) {
                   3809:         $udom = $env{'user.domain'};
                   3810:     }
                   3811:     if (!defined($uname)) {
                   3812:         $uname = $env{'user.name'};
                   3813:     }
                   3814: 
                   3815:     # If uname and udom are for a course, check for blocks in the course.
                   3816: 
                   3817:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3818:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3819:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3820:         return ($startblock,$endblock);
                   3821:     }
1.474     raeburn  3822: 
1.502     raeburn  3823:     my $startblock = 0;
                   3824:     my $endblock = 0;
1.482     raeburn  3825:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3826: 
1.490     raeburn  3827:     # If uname is for a user, and activity is course-specific, i.e.,
                   3828:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3829: 
1.490     raeburn  3830:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3831:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3832:         foreach my $key (keys(%live_courses)) {
                   3833:             if ($key ne $env{'request.course.id'}) {
                   3834:                 delete($live_courses{$key});
                   3835:             }
                   3836:         }
                   3837:     }
                   3838: 
                   3839:     my $otheruser = 0;
                   3840:     my %own_courses;
                   3841:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3842:         # Resource belongs to user other than current user.
                   3843:         $otheruser = 1;
                   3844:         # Gather courses for current user
                   3845:         %own_courses = 
                   3846:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3847:     }
                   3848: 
                   3849:     # Gather active course roles - course coordinator, instructor, 
                   3850:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3851: 
                   3852:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3853:         my ($cdom,$cnum);
                   3854:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3855:             $cdom = $env{'course.'.$course.'.domain'};
                   3856:             $cnum = $env{'course.'.$course.'.num'};
                   3857:         } else {
1.490     raeburn  3858:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3859:         }
                   3860:         my $no_ownblock = 0;
                   3861:         my $no_userblock = 0;
1.533     raeburn  3862:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3863:             # Check if current user has 'evb' priv for this
                   3864:             if (defined($own_courses{$course})) {
                   3865:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3866:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3867:                     if ($sec ne 'none') {
                   3868:                         $checkrole .= '/'.$sec;
                   3869:                     }
                   3870:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3871:                         $no_ownblock = 1;
                   3872:                         last;
                   3873:                     }
                   3874:                 }
                   3875:             }
                   3876:             # if they have 'evb' priv and are currently not playing student
                   3877:             next if (($no_ownblock) &&
                   3878:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3879:         }
1.474     raeburn  3880:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3881:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3882:             if ($sec ne 'none') {
1.482     raeburn  3883:                 $checkrole .= '/'.$sec;
1.474     raeburn  3884:             }
1.490     raeburn  3885:             if ($otheruser) {
                   3886:                 # Resource belongs to user other than current user.
                   3887:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3888:                 my ($trole,$tdom,$tnum,$tsec);
                   3889:                 my $entry = $live_courses{$course}{$sec};
                   3890:                 if ($entry =~ /^cr/) {
                   3891:                     ($trole,$tdom,$tnum,$tsec) = 
                   3892:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3893:                 } else {
                   3894:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3895:                 }
                   3896:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3897:                 $area = '/'.$tdom.'/'.$tnum;
                   3898:                 $trest = $tnum;
                   3899:                 if ($tsec ne '') {
                   3900:                     $area .= '/'.$tsec;
                   3901:                     $trest .= '/'.$tsec;
                   3902:                 }
                   3903:                 $spec = $trole.'.'.$area;
                   3904:                 if ($trole =~ /^cr/) {
                   3905:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3906:                                                       $tdom,$spec,$trest,$area);
                   3907:                 } else {
                   3908:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3909:                                                        $tdom,$spec,$trest,$area);
                   3910:                 }
                   3911:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3912:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3913:                     if ($1) {
                   3914:                         $no_userblock = 1;
                   3915:                         last;
                   3916:                     }
                   3917:                 }
1.490     raeburn  3918:             } else {
                   3919:                 # Resource belongs to current user
                   3920:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3921:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3922:                     $no_ownblock = 1;
                   3923:                     last;
                   3924:                 }
1.474     raeburn  3925:             }
                   3926:         }
                   3927:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3928:         next if (($no_ownblock) &&
1.491     albertel 3929:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3930:         next if ($no_userblock);
1.474     raeburn  3931: 
1.866     kalberla 3932:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3933:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3934:         
                   3935:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3936:         if (($start != 0) && 
                   3937:             (($startblock == 0) || ($startblock > $start))) {
                   3938:             $startblock = $start;
                   3939:         }
                   3940:         if (($end != 0)  &&
                   3941:             (($endblock == 0) || ($endblock < $end))) {
                   3942:             $endblock = $end;
                   3943:         }
1.490     raeburn  3944:     }
                   3945:     return ($startblock,$endblock);
                   3946: }
                   3947: 
                   3948: sub get_blocks {
                   3949:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3950:     my $startblock = 0;
                   3951:     my $endblock = 0;
                   3952:     my $course = $cdom.'_'.$cnum;
                   3953:     $setters->{$course} = {};
                   3954:     $setters->{$course}{'staff'} = [];
                   3955:     $setters->{$course}{'times'} = [];
                   3956:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3957:     foreach my $record (keys(%records)) {
                   3958:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3959:         if ($start <= time && $end >= time) {
                   3960:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3961:                 &parse_block_record($records{$record});
                   3962:             if ($blocks->{$activity} eq 'on') {
                   3963:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3964:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3965:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3966:                     $startblock = $start;
1.490     raeburn  3967:                 }
1.491     albertel 3968:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3969:                     $endblock = $end;
1.474     raeburn  3970:                 }
                   3971:             }
                   3972:         }
                   3973:     }
                   3974:     return ($startblock,$endblock);
                   3975: }
                   3976: 
                   3977: sub parse_block_record {
                   3978:     my ($record) = @_;
                   3979:     my ($setuname,$setudom,$title,$blocks);
                   3980:     if (ref($record) eq 'HASH') {
                   3981:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3982:         $title = &unescape($record->{'event'});
                   3983:         $blocks = $record->{'blocks'};
                   3984:     } else {
                   3985:         my @data = split(/:/,$record,3);
                   3986:         if (scalar(@data) eq 2) {
                   3987:             $title = $data[1];
                   3988:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3989:         } else {
                   3990:             ($setuname,$setudom,$title) = @data;
                   3991:         }
                   3992:         $blocks = { 'com' => 'on' };
                   3993:     }
                   3994:     return ($setuname,$setudom,$title,$blocks);
                   3995: }
                   3996: 
1.854     kalberla 3997: sub blocking_status {
                   3998:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3999:   my %setters;
1.890     droeschl 4000: 
                   4001:   # check for active blocking
1.867     kalberla 4002:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4003: 
1.890     droeschl 4004:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4005: 
                   4006:   # caller just wants to know whether a block is active
                   4007:   if (!wantarray) { return $blocked; }
                   4008: 
                   4009:   # build a link to a popup window containing the details
                   4010:   my $querystring  = "?activity=$activity";
                   4011:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4012:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4013:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4014: 
                   4015:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4016:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4017:         var options = "width=" + w + ",height=" + h + ",";
                   4018:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4019:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4020:         var newWin = window.open(url, wdwName, options);
                   4021:         newWin.focus();
                   4022:     }
1.890     droeschl 4023: END_MYBLOCK
1.854     kalberla 4024: 
1.890     droeschl 4025:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4026:   
1.854     kalberla 4027:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4028:   my $text = mt('Communication Blocked');
                   4029: 
1.867     kalberla 4030:   $output .= <<"END_BLOCK";
                   4031: <div class='LC_comblock'>
1.869     kalberla 4032:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4033:   title='$text'>
                   4034:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4035:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4036:   title='$text'>$text</a>
1.867     kalberla 4037: </div>
                   4038: 
                   4039: END_BLOCK
1.474     raeburn  4040: 
1.854     kalberla 4041:   return ($blocked, $output);
                   4042: }
1.490     raeburn  4043: 
1.60      matthew  4044: ###############################################
                   4045: 
1.682     raeburn  4046: sub check_ip_acc {
                   4047:     my ($acc)=@_;
                   4048:     &Apache::lonxml::debug("acc is $acc");
                   4049:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4050:         return 1;
                   4051:     }
                   4052:     my $allowed=0;
                   4053:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4054: 
                   4055:     my $name;
                   4056:     foreach my $pattern (split(',',$acc)) {
                   4057:         $pattern =~ s/^\s*//;
                   4058:         $pattern =~ s/\s*$//;
                   4059:         if ($pattern =~ /\*$/) {
                   4060:             #35.8.*
                   4061:             $pattern=~s/\*//;
                   4062:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4063:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4064:             #35.8.3.[34-56]
                   4065:             my $low=$2;
                   4066:             my $high=$3;
                   4067:             $pattern=$1;
                   4068:             if ($ip =~ /^\Q$pattern\E/) {
                   4069:                 my $last=(split(/\./,$ip))[3];
                   4070:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4071:             }
                   4072:         } elsif ($pattern =~ /^\*/) {
                   4073:             #*.msu.edu
                   4074:             $pattern=~s/\*//;
                   4075:             if (!defined($name)) {
                   4076:                 use Socket;
                   4077:                 my $netaddr=inet_aton($ip);
                   4078:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4079:             }
                   4080:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4081:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4082:             #127.0.0.1
                   4083:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4084:         } else {
                   4085:             #some.name.com
                   4086:             if (!defined($name)) {
                   4087:                 use Socket;
                   4088:                 my $netaddr=inet_aton($ip);
                   4089:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4090:             }
                   4091:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4092:         }
                   4093:         if ($allowed) { last; }
                   4094:     }
                   4095:     return $allowed;
                   4096: }
                   4097: 
                   4098: ###############################################
                   4099: 
1.60      matthew  4100: =pod
                   4101: 
1.112     bowersj2 4102: =head1 Domain Template Functions
                   4103: 
                   4104: =over 4
                   4105: 
                   4106: =item * &determinedomain()
1.60      matthew  4107: 
                   4108: Inputs: $domain (usually will be undef)
                   4109: 
1.63      www      4110: Returns: Determines which domain should be used for designs
1.60      matthew  4111: 
                   4112: =cut
1.54      www      4113: 
1.60      matthew  4114: ###############################################
1.63      www      4115: sub determinedomain {
                   4116:     my $domain=shift;
1.531     albertel 4117:     if (! $domain) {
1.60      matthew  4118:         # Determine domain if we have not been given one
1.893     raeburn  4119:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4120:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4121:         if ($env{'request.role.domain'}) { 
                   4122:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4123:         }
                   4124:     }
1.63      www      4125:     return $domain;
                   4126: }
                   4127: ###############################################
1.517     raeburn  4128: 
1.518     albertel 4129: sub devalidate_domconfig_cache {
                   4130:     my ($udom)=@_;
                   4131:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4132: }
                   4133: 
                   4134: # ---------------------- Get domain configuration for a domain
                   4135: sub get_domainconf {
                   4136:     my ($udom) = @_;
                   4137:     my $cachetime=1800;
                   4138:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4139:     if (defined($cached)) { return %{$result}; }
                   4140: 
                   4141:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4142: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4143:     my (%designhash,%legacy);
1.518     albertel 4144:     if (keys(%domconfig) > 0) {
                   4145:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4146:             if (keys(%{$domconfig{'login'}})) {
                   4147:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4148:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4149:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4150:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4151:                                 $domconfig{'login'}{$key}{$img};
                   4152:                         }
                   4153:                     } else {
                   4154:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4155:                     }
1.632     raeburn  4156:                 }
                   4157:             } else {
                   4158:                 $legacy{'login'} = 1;
1.518     albertel 4159:             }
1.632     raeburn  4160:         } else {
                   4161:             $legacy{'login'} = 1;
1.518     albertel 4162:         }
                   4163:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4164:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4165:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4166:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4167:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4168:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4169:                         }
1.518     albertel 4170:                     }
                   4171:                 }
1.632     raeburn  4172:             } else {
                   4173:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4174:             }
1.632     raeburn  4175:         } else {
                   4176:             $legacy{'rolecolors'} = 1;
1.518     albertel 4177:         }
1.632     raeburn  4178:         if (keys(%legacy) > 0) {
                   4179:             my %legacyhash = &get_legacy_domconf($udom);
                   4180:             foreach my $item (keys(%legacyhash)) {
                   4181:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4182:                     if ($legacy{'login'}) { 
                   4183:                         $designhash{$item} = $legacyhash{$item};
                   4184:                     }
                   4185:                 } else {
                   4186:                     if ($legacy{'rolecolors'}) {
                   4187:                         $designhash{$item} = $legacyhash{$item};
                   4188:                     }
1.518     albertel 4189:                 }
                   4190:             }
                   4191:         }
1.632     raeburn  4192:     } else {
                   4193:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4194:     }
                   4195:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4196: 				  $cachetime);
                   4197:     return %designhash;
                   4198: }
                   4199: 
1.632     raeburn  4200: sub get_legacy_domconf {
                   4201:     my ($udom) = @_;
                   4202:     my %legacyhash;
                   4203:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4204:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4205:     if (-e $designfile) {
                   4206:         if ( open (my $fh,"<$designfile") ) {
                   4207:             while (my $line = <$fh>) {
                   4208:                 next if ($line =~ /^\#/);
                   4209:                 chomp($line);
                   4210:                 my ($key,$val)=(split(/\=/,$line));
                   4211:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4212:             }
                   4213:             close($fh);
                   4214:         }
                   4215:     }
                   4216:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4217:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4218:     }
                   4219:     return %legacyhash;
                   4220: }
                   4221: 
1.63      www      4222: =pod
                   4223: 
1.112     bowersj2 4224: =item * &domainlogo()
1.63      www      4225: 
                   4226: Inputs: $domain (usually will be undef)
                   4227: 
                   4228: Returns: A link to a domain logo, if the domain logo exists.
                   4229: If the domain logo does not exist, a description of the domain.
                   4230: 
                   4231: =cut
1.112     bowersj2 4232: 
1.63      www      4233: ###############################################
                   4234: sub domainlogo {
1.517     raeburn  4235:     my $domain = &determinedomain(shift);
1.518     albertel 4236:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4237:     # See if there is a logo
                   4238:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4239:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4240:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4241: 	    if ($imgsrc =~ m{^/res/}) {
                   4242: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4243: 		&Apache::lonnet::repcopy($local_name);
                   4244: 	    }
                   4245: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4246:         } 
                   4247:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4248:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4249:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4250:     } else {
1.60      matthew  4251:         return '';
1.59      www      4252:     }
                   4253: }
1.63      www      4254: ##############################################
                   4255: 
                   4256: =pod
                   4257: 
1.112     bowersj2 4258: =item * &designparm()
1.63      www      4259: 
                   4260: Inputs: $which parameter; $domain (usually will be undef)
                   4261: 
                   4262: Returns: value of designparamter $which
                   4263: 
                   4264: =cut
1.112     bowersj2 4265: 
1.397     albertel 4266: 
1.400     albertel 4267: ##############################################
1.397     albertel 4268: sub designparm {
                   4269:     my ($which,$domain)=@_;
                   4270:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4271:         return $env{'environment.color.'.$which};
1.96      www      4272:     }
1.63      www      4273:     $domain=&determinedomain($domain);
1.518     albertel 4274:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4275:     my $output;
1.517     raeburn  4276:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4277:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4278:     } else {
1.520     raeburn  4279:         $output = $defaultdesign{$which};
                   4280:     }
                   4281:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4282:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4283:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4284:             if ($output =~ m{^/res/}) {
                   4285:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4286:                 &Apache::lonnet::repcopy($local_name);
                   4287:             }
1.520     raeburn  4288:             $output = &lonhttpdurl($output);
                   4289:         }
1.63      www      4290:     }
1.520     raeburn  4291:     return $output;
1.63      www      4292: }
1.59      www      4293: 
1.822     bisitz   4294: ##############################################
                   4295: =pod
                   4296: 
1.832     bisitz   4297: =item * &authorspace()
                   4298: 
                   4299: Inputs: ./.
                   4300: 
                   4301: Returns: Path to the Construction Space of the current user's
                   4302:          accessed author space
                   4303:          The author space will be that of the current user
                   4304:          when accessing the own author space
                   4305:          and that of the co-author/assistent co-author
                   4306:          when accessing the co-author's/assistent co-author's
                   4307:          space
                   4308: 
                   4309: =cut
                   4310: 
                   4311: sub authorspace {
                   4312:     my $caname = '';
                   4313:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4314:         (undef,$caname) =
                   4315:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4316:     } else {
                   4317:         $caname = $env{'user.name'};
                   4318:     }
                   4319:     return '/priv/'.$caname.'/';
                   4320: }
                   4321: 
                   4322: ##############################################
                   4323: =pod
                   4324: 
1.822     bisitz   4325: =item * &head_subbox()
                   4326: 
                   4327: Inputs: $content (contains HTML code with page functions, etc.)
                   4328: 
                   4329: Returns: HTML div with $content
                   4330:          To be included in page header
                   4331: 
                   4332: =cut
                   4333: 
                   4334: sub head_subbox {
                   4335:     my ($content)=@_;
                   4336:     my $output =
1.844     bisitz   4337:         '<div id="LC_head_subbox">'
1.822     bisitz   4338:        .$content
                   4339:        .'</div>'
                   4340: }
                   4341: 
                   4342: ##############################################
                   4343: =pod
                   4344: 
                   4345: =item * &CSTR_pageheader()
                   4346: 
                   4347: Inputs: ./.
                   4348: 
                   4349: Returns: HTML div with CSTR path and recent box
                   4350:          To be included on Construction Space pages
                   4351: 
                   4352: =cut
                   4353: 
                   4354: sub CSTR_pageheader {
                   4355:     # this is for resources; directories have customtitle, and crumbs
                   4356:             # and select recent are created in lonpubdir.pm  
                   4357:     my ($uname,$thisdisfn)=
                   4358:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4359:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4360:     $formaction=~s/\/+/\//g;
                   4361: 
                   4362:     my $parentpath = '';
                   4363:     my $lastitem = '';
                   4364:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4365:         $parentpath = $1;
                   4366:         $lastitem = $2;
                   4367:     } else {
                   4368:         $lastitem = $thisdisfn;
                   4369:     }
                   4370:     return
                   4371:          '<div>'
                   4372:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4373:         .'<b>'.&mt('Construction Space:').'</b> '
                   4374:         .'<form name="dirs" method="post" action="'.$formaction
                   4375:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4376:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4377:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4378:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4379:         .'</form>'
                   4380:         .&Apache::lonmenu::constspaceform()
                   4381:         .'</div>';
                   4382: }
                   4383: 
1.60      matthew  4384: ###############################################
                   4385: ###############################################
                   4386: 
                   4387: =pod
                   4388: 
1.112     bowersj2 4389: =back
                   4390: 
1.549     albertel 4391: =head1 HTML Helpers
1.112     bowersj2 4392: 
                   4393: =over 4
                   4394: 
                   4395: =item * &bodytag()
1.60      matthew  4396: 
                   4397: Returns a uniform header for LON-CAPA web pages.
                   4398: 
                   4399: Inputs: 
                   4400: 
1.112     bowersj2 4401: =over 4
                   4402: 
                   4403: =item * $title, A title to be displayed on the page.
                   4404: 
                   4405: =item * $function, the current role (can be undef).
                   4406: 
                   4407: =item * $addentries, extra parameters for the <body> tag.
                   4408: 
                   4409: =item * $bodyonly, if defined, only return the <body> tag.
                   4410: 
                   4411: =item * $domain, if defined, force a given domain.
                   4412: 
                   4413: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4414:             text interface only)
1.60      matthew  4415: 
1.814     bisitz   4416: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4417:                      navigational links
1.317     albertel 4418: 
1.338     albertel 4419: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4420: 
1.361     albertel 4421: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4422:          'Switch To Inline Menu' link
                   4423: 
1.460     albertel 4424: =item * $args, optional argument valid values are
                   4425:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4426:             inherit_jsmath -> when creating popup window in a page,
                   4427:                               should it have jsmath forced on by the
                   4428:                               current page
1.460     albertel 4429: 
1.112     bowersj2 4430: =back
                   4431: 
1.60      matthew  4432: Returns: A uniform header for LON-CAPA web pages.  
                   4433: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4434: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4435: other decorations will be returned.
                   4436: 
                   4437: =cut
                   4438: 
1.54      www      4439: sub bodytag {
1.831     bisitz   4440:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4441:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4442: 
1.460     albertel 4443:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4444: 
1.183     matthew  4445:     $function = &get_users_function() if (!$function);
1.339     albertel 4446:     my $img =    &designparm($function.'.img',$domain);
                   4447:     my $font =   &designparm($function.'.font',$domain);
                   4448:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4449: 
1.803     bisitz   4450:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4451: 		   'bgcolor' => $pgbg,
1.339     albertel 4452: 		   'text'    => $font,
                   4453:                    'alink'   => &designparm($function.'.alink',$domain),
                   4454: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4455: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4456:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4457: 
1.63      www      4458:  # role and realm
1.378     raeburn  4459:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4460:     if ($role  eq 'ca') {
1.479     albertel 4461:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4462:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4463:     } 
1.55      www      4464: # realm
1.258     albertel 4465:     if ($env{'request.course.id'}) {
1.378     raeburn  4466:         if ($env{'request.role'} !~ /^cr/) {
                   4467:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4468:         }
1.898     raeburn  4469:         if ($env{'request.course.sec'}) {
                   4470:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4471:         }   
1.359     albertel 4472: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4473:     } else {
                   4474:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4475:     }
1.433     albertel 4476: 
1.359     albertel 4477:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4478: # Set messages
1.60      matthew  4479:     my $messages=&domainlogo($domain);
1.330     albertel 4480: 
1.438     albertel 4481:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4482: 
1.101     www      4483: # construct main body tag
1.359     albertel 4484:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4485: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4486: 
1.530     albertel 4487:     if ($bodyonly) {
1.60      matthew  4488:         return $bodytag;
1.798     tempelho 4489:     } 
1.359     albertel 4490: 
1.410     albertel 4491:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4492:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4493: 	undef($role);
1.434     albertel 4494:     } else {
                   4495: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4496:     }
1.359     albertel 4497:     
1.762     bisitz   4498:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4499:     #
                   4500:     # Extra info if you are the DC
                   4501:     my $dc_info = '';
                   4502:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4503:                         $env{'course.'.$env{'request.course.id'}.
                   4504:                                  '.domain'}.'/'})) {
                   4505:         my $cid = $env{'request.course.id'};
1.917     raeburn  4506:         $dc_info = $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4507:         $dc_info =~ s/\s+$//;
1.359     albertel 4508:     }
                   4509: 
1.898     raeburn  4510:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4511:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4512: 
1.837     bisitz   4513:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4514:         # No Remote
1.916     droeschl 4515:         if ($no_nav_bar || $env{'form.inhibitmenu'} eq 'yes') { 
                   4516:             return $bodytag; 
                   4517:         } 
1.903     droeschl 4518: 
                   4519:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4520: 
                   4521:         #    if ($env{'request.state'} eq 'construct') {
                   4522:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4523:         #    }
                   4524: 
1.359     albertel 4525: 
                   4526: 
1.916     droeschl 4527:         if ($env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.917     raeburn  4528:              if ($dc_info) {
                   4529:                  $dc_info = qq|<span class="LC_cusr_subheading">$dc_info</span>|;
                   4530:              }
1.916     droeschl 4531:              $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4532:                 <em>$realm</em> $dc_info</div>|;
1.903     droeschl 4533:             return $bodytag;
                   4534:         }
1.894     droeschl 4535: 
1.916     droeschl 4536:         $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>|;
                   4537: 
1.903     droeschl 4538:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4539:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4540: 
1.903     droeschl 4541:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4542: 
1.917     raeburn  4543:         if ($dc_info) {
                   4544:             $dc_info = &dc_courseid_toggle($dc_info);
                   4545:         }
                   4546:         $bodytag .= qq|<div id="LC_realm">$realm $dc_info</div>|;
1.916     droeschl 4547: 
1.903     droeschl 4548:         #don't show menus for public users
                   4549:         if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
                   4550:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4551:             $bodytag .= Apache::lonmenu::serverform();
                   4552:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
                   4553:             $bodytag .= Apache::lonmenu::innerregister($forcereg) if $forcereg;
                   4554:         }else{
                   4555:             # this is to seperate menu from content when there's no secondary
                   4556:             # menu. Especially needed for public accessible ressources.
                   4557:             $bodytag .= '<hr style="clear:both" />';
                   4558:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4559:         }
1.903     droeschl 4560: 
                   4561:         #SD testing
                   4562:         #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235     raeburn  4563:         return $bodytag;
1.94      www      4564:     }
1.95      www      4565: 
1.93      www      4566: #
1.95      www      4567: # Top frame rendering, Remote is up
1.93      www      4568: #
1.359     albertel 4569: 
1.517     raeburn  4570:     my $imgsrc = $img;
                   4571:     if ($img =~ /^\/adm/) {
1.575     albertel 4572:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4573:     }
                   4574:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4575: 
1.305     www      4576:     # Explicit link to get inline menu
1.361     albertel 4577:     my $menu= ($no_inline_link?''
1.883     droeschl 4578: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.917     raeburn  4579: 
                   4580:     if ($dc_info) {
                   4581:         $dc_info = qq|<span class="LC_cusr_subheading">($dc_info)</span>|;
                   4582:     }
                   4583: 
1.916     droeschl 4584:     $bodytag .= qq|<div id="LC_nav_bar">$name $role</div>
1.897     wenzelju 4585:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4586:                 <li>$menu</li>
1.917     raeburn  4587:             </ol><div id="LC_realm"> $realm $dc_info</div>| unless $env{'form.inhibitmenu'};
1.94      www      4588:     return(<<ENDBODY);
1.60      matthew  4589: $bodytag
1.359     albertel 4590: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4591: <tr><td>$upperleft</td>
                   4592:     <td>$messages&nbsp;</td>
1.54      www      4593: </tr>
1.359     albertel 4594: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4595: </tr>
1.356     albertel 4596: </table>
1.54      www      4597: ENDBODY
1.182     matthew  4598: }
                   4599: 
1.917     raeburn  4600: sub dc_courseid_toggle {
                   4601:     my ($dc_info) = @_;
                   4602:     return ' <span id="dccidtext" class="LC_cusr_subheading">'.
                   4603:            '<a href="javascript:showCourseID();">'.
                   4604:            &mt('(More ...)').'</a></span>'.
                   4605:            '<div id="dccid" class="LC_dccid">'.$dc_info.'</div>';
                   4606: }
                   4607: 
1.330     albertel 4608: sub make_attr_string {
                   4609:     my ($register,$attr_ref) = @_;
                   4610: 
                   4611:     if ($attr_ref && !ref($attr_ref)) {
                   4612: 	die("addentries Must be a hash ref ".
                   4613: 	    join(':',caller(1))." ".
                   4614: 	    join(':',caller(0))." ");
                   4615:     }
                   4616: 
                   4617:     if ($register) {
1.339     albertel 4618: 	my ($on_load,$on_unload);
                   4619: 	foreach my $key (keys(%{$attr_ref})) {
                   4620: 	    if      (lc($key) eq 'onload') {
                   4621: 		$on_load.=$attr_ref->{$key}.';';
                   4622: 		delete($attr_ref->{$key});
                   4623: 
                   4624: 	    } elsif (lc($key) eq 'onunload') {
                   4625: 		$on_unload.=$attr_ref->{$key}.';';
                   4626: 		delete($attr_ref->{$key});
                   4627: 	    }
                   4628: 	}
                   4629: 	$attr_ref->{'onload'}  =
                   4630: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4631: 	$attr_ref->{'onunload'}=
                   4632: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4633:     }
                   4634: 
                   4635: # Accessibility font enhance
                   4636:     if ($env{'browser.fontenhance'} eq 'on') {
                   4637: 	my $style;
                   4638: 	foreach my $key (keys(%{$attr_ref})) {
                   4639: 	    if (lc($key) eq 'style') {
                   4640: 		$style.=$attr_ref->{$key}.';';
                   4641: 		delete($attr_ref->{$key});
                   4642: 	    }
                   4643: 	}
                   4644: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4645:     }
1.339     albertel 4646: 
1.330     albertel 4647:     my $attr_string;
                   4648:     foreach my $attr (keys(%$attr_ref)) {
                   4649: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4650:     }
                   4651:     return $attr_string;
                   4652: }
                   4653: 
                   4654: 
1.182     matthew  4655: ###############################################
1.251     albertel 4656: ###############################################
                   4657: 
                   4658: =pod
                   4659: 
                   4660: =item * &endbodytag()
                   4661: 
                   4662: Returns a uniform footer for LON-CAPA web pages.
                   4663: 
1.635     raeburn  4664: Inputs: 1 - optional reference to an args hash
                   4665: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4666: a 'Continue' link is not displayed if the page contains an
                   4667: internal redirect in the <head></head> section,
                   4668: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4669: 
                   4670: =cut
                   4671: 
                   4672: sub endbodytag {
1.635     raeburn  4673:     my ($args) = @_;
1.251     albertel 4674:     my $endbodytag='</body>';
1.269     albertel 4675:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4676:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4677:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4678: 	    $endbodytag=
                   4679: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4680: 	        &mt('Continue').'</a>'.
                   4681: 	        $endbodytag;
                   4682:         }
1.315     albertel 4683:     }
1.251     albertel 4684:     return $endbodytag;
                   4685: }
                   4686: 
1.352     albertel 4687: =pod
                   4688: 
                   4689: =item * &standard_css()
                   4690: 
                   4691: Returns a style sheet
                   4692: 
                   4693: Inputs: (all optional)
                   4694:             domain         -> force to color decorate a page for a specific
                   4695:                                domain
                   4696:             function       -> force usage of a specific rolish color scheme
                   4697:             bgcolor        -> override the default page bgcolor
                   4698: 
                   4699: =cut
                   4700: 
1.343     albertel 4701: sub standard_css {
1.345     albertel 4702:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4703:     $function  = &get_users_function() if (!$function);
                   4704:     my $img    = &designparm($function.'.img',   $domain);
                   4705:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4706:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4707:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4708: #second colour for later usage
1.345     albertel 4709:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4710:     my $pgbg_or_bgcolor =
                   4711: 	         $bgcolor ||
1.352     albertel 4712: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4713:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4714:     my $alink  = &designparm($function.'.alink', $domain);
                   4715:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4716:     my $link   = &designparm($function.'.link',  $domain);
                   4717: 
1.704     muellerd 4718:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4719:     my $bgcol = &designparm('login.bgcol',$domain);
                   4720:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4721: 
1.602     albertel 4722:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4723:     my $mono                 = 'monospace';
1.850     bisitz   4724:     my $data_table_head      = $sidebg;
                   4725:     my $data_table_light     = '#FAFAFA';
                   4726:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4727:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4728:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4729:     my $mail_new             = '#FFBB77';
                   4730:     my $mail_new_hover       = '#DD9955';
                   4731:     my $mail_read            = '#BBBB77';
                   4732:     my $mail_read_hover      = '#999944';
                   4733:     my $mail_replied         = '#AAAA88';
                   4734:     my $mail_replied_hover   = '#888855';
                   4735:     my $mail_other           = '#99BBBB';
                   4736:     my $mail_other_hover     = '#669999';
1.391     albertel 4737:     my $table_header         = '#DDDDDD';
1.489     raeburn  4738:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4739:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4740: 
1.608     albertel 4741:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4742:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4743:                                              : '0 3px 0 4px';
1.448     albertel 4744: 
1.523     albertel 4745: 
1.343     albertel 4746:     return <<END;
1.795     www      4747: body {
1.911     bisitz   4748:   font-family: $sans;
                   4749:   line-height:130%;
                   4750:   font-size:0.83em;
                   4751:   color:$font;
1.795     www      4752: }
                   4753: 
1.911     bisitz   4754: a:link,
                   4755: a:visited {
                   4756:   font-size:100%;
1.795     www      4757: }
                   4758: 
1.911     bisitz   4759: a:focus {
1.795     www      4760:   color: red;
1.911     bisitz   4761:   background: yellow;
1.795     www      4762: }
1.698     harmsja  4763: 
1.911     bisitz   4764: form, .inline {
                   4765:   display: inline;
1.795     www      4766: }
1.721     harmsja  4767: 
1.795     www      4768: .LC_right {
1.911     bisitz   4769:   text-align:right;
1.795     www      4770: }
                   4771: 
                   4772: .LC_middle {
1.911     bisitz   4773:   vertical-align:middle;
1.795     www      4774: }
1.721     harmsja  4775: 
                   4776: /* just for tests */
1.911     bisitz   4777: .LC_400Box {
                   4778:   width:400px;
                   4779: }
1.721     harmsja  4780: /* end */
                   4781: 
1.778     bisitz   4782: .LC_filename {
                   4783:   font-family: $mono;
                   4784:   white-space:pre;
                   4785: }
                   4786: 
                   4787: .LC_fileicon {
                   4788:   border: none;
                   4789:   height: 1.3em;
                   4790:   vertical-align: text-bottom;
                   4791:   margin-right: 0.3em;
                   4792:   text-decoration:none;
                   4793: }
                   4794: 
1.350     albertel 4795: .LC_error {
                   4796:   color: red;
                   4797:   font-size: larger;
                   4798: }
1.795     www      4799: 
1.457     albertel 4800: .LC_warning,
                   4801: .LC_diff_removed {
1.733     bisitz   4802:   color: red;
1.394     albertel 4803: }
1.532     albertel 4804: 
                   4805: .LC_info,
1.457     albertel 4806: .LC_success,
                   4807: .LC_diff_added {
1.350     albertel 4808:   color: green;
                   4809: }
1.795     www      4810: 
1.802     bisitz   4811: div.LC_confirm_box {
                   4812:   background-color: #FAFAFA;
                   4813:   border: 1px solid $lg_border_color;
                   4814:   margin-right: 0;
                   4815:   padding: 5px;
                   4816: }
                   4817: 
                   4818: div.LC_confirm_box .LC_error img,
                   4819: div.LC_confirm_box .LC_success img {
                   4820:   vertical-align: middle;
                   4821: }
                   4822: 
1.440     albertel 4823: .LC_icon {
1.771     droeschl 4824:   border: none;
1.790     droeschl 4825:   vertical-align: middle;
1.771     droeschl 4826: }
                   4827: 
1.543     albertel 4828: .LC_docs_spacer {
                   4829:   width: 25px;
                   4830:   height: 1px;
1.771     droeschl 4831:   border: none;
1.543     albertel 4832: }
1.346     albertel 4833: 
1.532     albertel 4834: .LC_internal_info {
1.735     bisitz   4835:   color: #999999;
1.532     albertel 4836: }
                   4837: 
1.794     www      4838: .LC_discussion {
1.911     bisitz   4839:   background: $tabbg;
                   4840:   border: 1px solid black;
                   4841:   margin: 2px;
1.794     www      4842: }
                   4843: 
                   4844: .LC_disc_action_links_bar {
1.911     bisitz   4845:   background: $tabbg;
                   4846:   border: none;
                   4847:   margin: 4px;
1.794     www      4848: }
                   4849: 
                   4850: .LC_disc_action_left {
1.911     bisitz   4851:   text-align: left;
1.794     www      4852: }
                   4853: 
                   4854: .LC_disc_action_right {
1.911     bisitz   4855:   text-align: right;
1.794     www      4856: }
                   4857: 
                   4858: .LC_disc_new_item {
1.911     bisitz   4859:   background: white;
                   4860:   border: 2px solid red;
                   4861:   margin: 2px;
1.794     www      4862: }
                   4863: 
                   4864: .LC_disc_old_item {
1.911     bisitz   4865:   background: white;
                   4866:   border: 1px solid black;
                   4867:   margin: 2px;
1.794     www      4868: }
                   4869: 
1.458     albertel 4870: table.LC_pastsubmission {
                   4871:   border: 1px solid black;
                   4872:   margin: 2px;
                   4873: }
                   4874: 
1.795     www      4875: table#LC_top_nav,
                   4876: table#LC_menubuttons,
                   4877: table#LC_nav_location {
1.345     albertel 4878:   width: 100%;
                   4879:   background: $pgbg;
1.392     albertel 4880:   border: 2px;
1.402     albertel 4881:   border-collapse: separate;
1.803     bisitz   4882:   padding: 0;
1.345     albertel 4883: }
1.392     albertel 4884: 
1.801     tempelho 4885: table#LC_title_bar a {
                   4886:   color: $fontmenu;
                   4887: }
1.836     bisitz   4888: 
1.807     droeschl 4889: table#LC_title_bar {
1.819     tempelho 4890:   clear: both;
1.836     bisitz   4891:   display: none;
1.807     droeschl 4892: }
                   4893: 
1.795     www      4894: table#LC_title_bar,
                   4895: table.LC_breadcrumbs,
1.393     albertel 4896: table#LC_title_bar.LC_with_remote {
1.359     albertel 4897:   width: 100%;
1.392     albertel 4898:   border-color: $pgbg;
                   4899:   border-style: solid;
                   4900:   border-width: $border;
1.379     albertel 4901:   background: $pgbg;
1.801     tempelho 4902:   color: $fontmenu;
1.392     albertel 4903:   border-collapse: collapse;
1.803     bisitz   4904:   padding: 0;
1.819     tempelho 4905:   margin: 0;
1.359     albertel 4906: }
1.795     www      4907: 
1.913     droeschl 4908: /* #SD START (work in progress)*/
                   4909: 
                   4910: ul.LC_bct {
                   4911:     margin: 0;
                   4912:     padding: 0;
                   4913: }
                   4914: ul.LC_bct ol {
                   4915:     display: inline;
                   4916: }
                   4917: ul.LC_bct ul {
                   4918:     display: inline;
                   4919:     padding: 0;
                   4920: }
                   4921: ul.LC_bct li {
                   4922:     list-style-type: none;
                   4923:     display: inline;
                   4924: }
                   4925: 
                   4926: 
                   4927: ul.LC_breadcrumb_tools {
                   4928: }
                   4929: 
                   4930: li.LC_breadcrumb_tools {
                   4931: }
                   4932: li.LC_breadcrumb_tools img{
                   4933:     vertical-align: middle;
                   4934: }
                   4935: 
                   4936: .LC_breadcrumb_tools_A {
                   4937:     margin: 0 0 0 1em;
                   4938: }
                   4939: .LC_breadcrumb_tools_B {
                   4940:     float: right;
                   4941:     margin-top: 0.4em;
                   4942: }
                   4943: .LC_breadcrumb_tools_C {
                   4944:     margin: 0 1em 0 0;
                   4945:     float: right;
                   4946: }
                   4947: /* #SD END */
                   4948: 
1.359     albertel 4949: table#LC_title_bar td {
                   4950:   background: $tabbg;
                   4951: }
1.795     www      4952: 
1.911     bisitz   4953: table#LC_menubuttons img {
1.803     bisitz   4954:   border: none;
1.346     albertel 4955: }
1.795     www      4956: 
1.345     albertel 4957: table#LC_top_nav td {
                   4958:   background: $tabbg;
1.803     bisitz   4959:   border: none;
1.407     albertel 4960:   font-size: small;
1.706     harmsja  4961:   vertical-align:top;
                   4962:   padding:2px 5px 2px 5px;
1.345     albertel 4963: }
1.795     www      4964: 
                   4965: table#LC_top_nav td a,
                   4966: div#LC_top_nav a {
1.345     albertel 4967:   color: $font;
                   4968: }
1.795     www      4969: 
1.364     albertel 4970: table#LC_top_nav td.LC_top_nav_logo {
                   4971:   background: $tabbg;
1.432     albertel 4972:   text-align: left;
1.408     albertel 4973:   white-space: nowrap;
1.432     albertel 4974:   width: 31px;
1.408     albertel 4975: }
1.795     www      4976: 
1.408     albertel 4977: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4978:   border: none;
1.408     albertel 4979:   vertical-align: bottom;
1.364     albertel 4980: }
1.795     www      4981: 
1.777     tempelho 4982: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4983: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4984:   width: 2.0em;
                   4985: }
1.795     www      4986: 
1.442     albertel 4987: table#LC_top_nav td.LC_top_nav_login {
                   4988:   width: 4.0em;
                   4989:   text-align: center;
                   4990: }
1.795     www      4991: 
1.842     droeschl 4992: .LC_breadcrumbs_component {
1.911     bisitz   4993:   float: right;
                   4994:   margin: 0 1em;
1.357     albertel 4995: }
1.842     droeschl 4996: .LC_breadcrumbs_component img {
1.911     bisitz   4997:   vertical-align: middle;
1.777     tempelho 4998: }
1.795     www      4999: 
1.383     albertel 5000: td.LC_table_cell_checkbox {
                   5001:   text-align: center;
                   5002: }
1.795     www      5003: 
1.779     bisitz   5004: table#LC_mainmenu td.LC_mainmenu_column {
1.911     bisitz   5005:   vertical-align: top;
1.777     tempelho 5006: }
1.522     albertel 5007: 
1.795     www      5008: .LC_fontsize_small {
1.911     bisitz   5009:   font-size: 70%;
1.705     tempelho 5010: }
                   5011: 
1.844     bisitz   5012: #LC_breadcrumbs {
1.911     bisitz   5013:   clear:both;
                   5014:   background: $sidebg;
                   5015:   border-bottom: 1px solid $lg_border_color;
                   5016:   line-height: 2.5em;
1.915     droeschl 5017:      /* SD working here 
                   5018:      height: 2.5em;
                   5019:      overflow: hidden; */
1.911     bisitz   5020:   margin: 0;
                   5021:   padding: 0;
1.819     tempelho 5022: }
1.862     bisitz   5023: 
1.839     droeschl 5024: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5025: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5026:   display:none;
1.839     droeschl 5027: }
1.819     tempelho 5028: 
1.844     bisitz   5029: #LC_head_subbox {
1.911     bisitz   5030:   clear:both;
                   5031:   background: #F8F8F8; /* $sidebg; */
1.915     droeschl 5032:   border: 1px solid $sidebg;
                   5033:   margin: 0 0 10px 0;      
1.822     bisitz   5034: }
                   5035: 
1.795     www      5036: .LC_fontsize_medium {
1.911     bisitz   5037:   font-size: 85%;
1.705     tempelho 5038: }
                   5039: 
1.795     www      5040: .LC_fontsize_large {
1.911     bisitz   5041:   font-size: 120%;
1.705     tempelho 5042: }
                   5043: 
1.346     albertel 5044: .LC_menubuttons_inline_text {
                   5045:   color: $font;
1.698     harmsja  5046:   font-size: 90%;
1.701     harmsja  5047:   padding-left:3px;
1.346     albertel 5048: }
                   5049: 
1.526     www      5050: .LC_menubuttons_link {
                   5051:   text-decoration: none;
                   5052: }
1.795     www      5053: 
1.522     albertel 5054: .LC_menubuttons_category {
1.521     www      5055:   color: $font;
1.526     www      5056:   background: $pgbg;
1.521     www      5057:   font-size: larger;
                   5058:   font-weight: bold;
                   5059: }
                   5060: 
1.346     albertel 5061: td.LC_menubuttons_text {
1.911     bisitz   5062:   color: $font;
1.346     albertel 5063: }
1.706     harmsja  5064: 
1.346     albertel 5065: .LC_current_location {
                   5066:   background: $tabbg;
                   5067: }
1.795     www      5068: 
1.346     albertel 5069: .LC_new_mail {
1.634     www      5070:   background: $tabbg;
1.346     albertel 5071:   font-weight: bold;
                   5072: }
1.347     albertel 5073: 
1.795     www      5074: table.LC_data_table,
                   5075: table.LC_mail_list {
1.347     albertel 5076:   border: 1px solid #000000;
1.402     albertel 5077:   border-collapse: separate;
1.426     albertel 5078:   border-spacing: 1px;
1.610     albertel 5079:   background: $pgbg;
1.347     albertel 5080: }
1.795     www      5081: 
1.422     albertel 5082: .LC_data_table_dense {
                   5083:   font-size: small;
                   5084: }
1.795     www      5085: 
1.507     raeburn  5086: table.LC_nested_outer {
                   5087:   border: 1px solid #000000;
1.589     raeburn  5088:   border-collapse: collapse;
1.803     bisitz   5089:   border-spacing: 0;
1.507     raeburn  5090:   width: 100%;
                   5091: }
1.795     www      5092: 
1.879     raeburn  5093: table.LC_innerpickbox,
1.507     raeburn  5094: table.LC_nested {
1.803     bisitz   5095:   border: none;
1.589     raeburn  5096:   border-collapse: collapse;
1.803     bisitz   5097:   border-spacing: 0;
1.507     raeburn  5098:   width: 100%;
                   5099: }
1.795     www      5100: 
1.911     bisitz   5101: table.LC_data_table tr th,
                   5102: table.LC_calendar tr th,
1.795     www      5103: table.LC_mail_list tr th,
1.879     raeburn  5104: table.LC_prior_tries tr th,
                   5105: table.LC_innerpickbox tr th {
1.349     albertel 5106:   font-weight: bold;
                   5107:   background-color: $data_table_head;
1.801     tempelho 5108:   color:$fontmenu;
1.701     harmsja  5109:   font-size:90%;
1.347     albertel 5110: }
1.795     www      5111: 
1.879     raeburn  5112: table.LC_innerpickbox tr th,
                   5113: table.LC_innerpickbox tr td {
                   5114:   vertical-align: top;
                   5115: }
                   5116: 
1.711     raeburn  5117: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5118:   background-color: #CCCCCC;
1.711     raeburn  5119:   font-weight: bold;
                   5120:   text-align: left;
                   5121: }
1.795     www      5122: 
1.912     bisitz   5123: table.LC_data_table tr.LC_odd_row > td {
                   5124:   background-color: $data_table_light;
                   5125:   padding: 2px;
                   5126:   vertical-align: top;
                   5127: }
                   5128: 
1.809     bisitz   5129: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5130:   background-color: $data_table_light;
1.912     bisitz   5131:   vertical-align: top;
                   5132: }
                   5133: 
                   5134: table.LC_data_table tr.LC_even_row > td {
                   5135:   background-color: $data_table_dark;
1.425     albertel 5136:   padding: 2px;
1.900     bisitz   5137:   vertical-align: top;
1.347     albertel 5138: }
1.795     www      5139: 
1.809     bisitz   5140: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5141:   background-color: $data_table_dark;
1.900     bisitz   5142:   vertical-align: top;
1.347     albertel 5143: }
1.795     www      5144: 
1.425     albertel 5145: table.LC_data_table tr.LC_data_table_highlight td {
                   5146:   background-color: $data_table_darker;
                   5147: }
1.795     www      5148: 
1.639     raeburn  5149: table.LC_data_table tr td.LC_leftcol_header {
                   5150:   background-color: $data_table_head;
                   5151:   font-weight: bold;
                   5152: }
1.795     www      5153: 
1.451     albertel 5154: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5155: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5156:   background-color: #FFFFFF;
1.421     albertel 5157:   font-weight: bold;
                   5158:   font-style: italic;
                   5159:   text-align: center;
                   5160:   padding: 8px;
1.347     albertel 5161: }
1.795     www      5162: 
1.890     droeschl 5163: table.LC_caption {
                   5164: }
                   5165: 
1.507     raeburn  5166: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5167:   padding: 4ex
                   5168: }
1.795     www      5169: 
1.507     raeburn  5170: table.LC_nested_outer tr th {
                   5171:   font-weight: bold;
1.801     tempelho 5172:   color:$fontmenu;
1.507     raeburn  5173:   background-color: $data_table_head;
1.701     harmsja  5174:   font-size: small;
1.507     raeburn  5175:   border-bottom: 1px solid #000000;
                   5176: }
1.795     www      5177: 
1.507     raeburn  5178: table.LC_nested_outer tr td.LC_subheader {
                   5179:   background-color: $data_table_head;
                   5180:   font-weight: bold;
                   5181:   font-size: small;
                   5182:   border-bottom: 1px solid #000000;
                   5183:   text-align: right;
1.451     albertel 5184: }
1.795     www      5185: 
1.507     raeburn  5186: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5187:   background-color: #CCCCCC;
1.451     albertel 5188:   font-weight: bold;
                   5189:   font-size: small;
1.507     raeburn  5190:   text-align: center;
                   5191: }
1.795     www      5192: 
1.589     raeburn  5193: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5194: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5195:   text-align: left;
1.451     albertel 5196: }
1.795     www      5197: 
1.507     raeburn  5198: table.LC_nested td {
1.735     bisitz   5199:   background-color: #FFFFFF;
1.451     albertel 5200:   font-size: small;
1.507     raeburn  5201: }
1.795     www      5202: 
1.507     raeburn  5203: table.LC_nested_outer tr th.LC_right_item,
                   5204: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5205: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5206: table.LC_nested tr td.LC_right_item {
1.451     albertel 5207:   text-align: right;
                   5208: }
                   5209: 
1.507     raeburn  5210: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5211:   background-color: #EEEEEE;
1.451     albertel 5212: }
                   5213: 
1.473     raeburn  5214: table.LC_createuser {
                   5215: }
                   5216: 
                   5217: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5218:   font-size: small;
1.473     raeburn  5219: }
                   5220: 
                   5221: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5222:   background-color: #CCCCCC;
1.473     raeburn  5223:   font-weight: bold;
                   5224:   text-align: center;
                   5225: }
                   5226: 
1.349     albertel 5227: table.LC_calendar {
                   5228:   border: 1px solid #000000;
                   5229:   border-collapse: collapse;
1.917     raeburn  5230:   width: 98%;
1.349     albertel 5231: }
1.795     www      5232: 
1.349     albertel 5233: table.LC_calendar_pickdate {
                   5234:   font-size: xx-small;
                   5235: }
1.795     www      5236: 
1.349     albertel 5237: table.LC_calendar tr td {
                   5238:   border: 1px solid #000000;
                   5239:   vertical-align: top;
1.917     raeburn  5240:   width: 14%;
1.349     albertel 5241: }
1.795     www      5242: 
1.349     albertel 5243: table.LC_calendar tr td.LC_calendar_day_empty {
                   5244:   background-color: $data_table_dark;
                   5245: }
1.795     www      5246: 
1.779     bisitz   5247: table.LC_calendar tr td.LC_calendar_day_current {
                   5248:   background-color: $data_table_highlight;
1.777     tempelho 5249: }
1.795     www      5250: 
1.349     albertel 5251: table.LC_mail_list tr.LC_mail_new {
                   5252:   background-color: $mail_new;
                   5253: }
1.795     www      5254: 
1.349     albertel 5255: table.LC_mail_list tr.LC_mail_new:hover {
                   5256:   background-color: $mail_new_hover;
                   5257: }
1.795     www      5258: 
                   5259: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5260: }
1.795     www      5261: 
                   5262: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5263: }
1.795     www      5264: 
1.349     albertel 5265: table.LC_mail_list tr.LC_mail_read {
                   5266:   background-color: $mail_read;
                   5267: }
1.795     www      5268: 
1.349     albertel 5269: table.LC_mail_list tr.LC_mail_read:hover {
                   5270:   background-color: $mail_read_hover;
                   5271: }
1.795     www      5272: 
1.349     albertel 5273: table.LC_mail_list tr.LC_mail_replied {
                   5274:   background-color: $mail_replied;
                   5275: }
1.795     www      5276: 
1.349     albertel 5277: table.LC_mail_list tr.LC_mail_replied:hover {
                   5278:   background-color: $mail_replied_hover;
                   5279: }
1.795     www      5280: 
1.349     albertel 5281: table.LC_mail_list tr.LC_mail_other {
                   5282:   background-color: $mail_other;
                   5283: }
1.795     www      5284: 
1.349     albertel 5285: table.LC_mail_list tr.LC_mail_other:hover {
                   5286:   background-color: $mail_other_hover;
                   5287: }
1.494     raeburn  5288: 
1.777     tempelho 5289: table.LC_data_table tr > td.LC_browser_file,
                   5290: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5291:   background: #AAEE77;
1.389     albertel 5292: }
1.795     www      5293: 
1.777     tempelho 5294: table.LC_data_table tr > td.LC_browser_file_locked,
                   5295: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5296:   background: #FFAA99;
1.387     albertel 5297: }
1.795     www      5298: 
1.777     tempelho 5299: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5300:   background: #888888;
1.779     bisitz   5301: }
1.795     www      5302: 
1.777     tempelho 5303: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5304: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5305:   background: #F8F866;
1.777     tempelho 5306: }
1.795     www      5307: 
1.696     bisitz   5308: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5309:   background: #E0E8FF;
1.387     albertel 5310: }
1.696     bisitz   5311: 
1.707     bisitz   5312: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5313:   /* background: #77FF77; */
1.707     bisitz   5314: }
1.795     www      5315: 
1.707     bisitz   5316: table.LC_data_table tr > td.LC_roles_future {
                   5317:   background: #FFFF77;
                   5318: }
1.795     www      5319: 
1.707     bisitz   5320: table.LC_data_table tr > td.LC_roles_will {
                   5321:   background: #FFAA77;
                   5322: }
1.795     www      5323: 
1.707     bisitz   5324: table.LC_data_table tr > td.LC_roles_expired {
                   5325:   background: #FF7777;
                   5326: }
1.795     www      5327: 
1.707     bisitz   5328: table.LC_data_table tr > td.LC_roles_will_not {
                   5329:   background: #AAFF77;
                   5330: }
1.795     www      5331: 
1.707     bisitz   5332: table.LC_data_table tr > td.LC_roles_selected {
                   5333:   background: #11CC55;
                   5334: }
                   5335: 
1.388     albertel 5336: span.LC_current_location {
1.701     harmsja  5337:   font-size:larger;
1.388     albertel 5338:   background: $pgbg;
                   5339: }
1.387     albertel 5340: 
1.395     albertel 5341: span.LC_parm_menu_item {
                   5342:   font-size: larger;
                   5343: }
1.795     www      5344: 
1.395     albertel 5345: span.LC_parm_scope_all {
                   5346:   color: red;
                   5347: }
1.795     www      5348: 
1.395     albertel 5349: span.LC_parm_scope_folder {
                   5350:   color: green;
                   5351: }
1.795     www      5352: 
1.395     albertel 5353: span.LC_parm_scope_resource {
                   5354:   color: orange;
                   5355: }
1.795     www      5356: 
1.395     albertel 5357: span.LC_parm_part {
                   5358:   color: blue;
                   5359: }
1.795     www      5360: 
1.911     bisitz   5361: span.LC_parm_folder,
                   5362: span.LC_parm_symb {
1.395     albertel 5363:   font-size: x-small;
                   5364:   font-family: $mono;
                   5365:   color: #AAAAAA;
                   5366: }
                   5367: 
1.795     www      5368: td.LC_parm_overview_level_menu,
                   5369: td.LC_parm_overview_map_menu,
                   5370: td.LC_parm_overview_parm_selectors,
                   5371: td.LC_parm_overview_restrictions  {
1.396     albertel 5372:   border: 1px solid black;
                   5373:   border-collapse: collapse;
                   5374: }
1.795     www      5375: 
1.396     albertel 5376: table.LC_parm_overview_restrictions td {
                   5377:   border-width: 1px 4px 1px 4px;
                   5378:   border-style: solid;
                   5379:   border-color: $pgbg;
                   5380:   text-align: center;
                   5381: }
1.795     www      5382: 
1.396     albertel 5383: table.LC_parm_overview_restrictions th {
                   5384:   background: $tabbg;
                   5385:   border-width: 1px 4px 1px 4px;
                   5386:   border-style: solid;
                   5387:   border-color: $pgbg;
                   5388: }
1.795     www      5389: 
1.398     albertel 5390: table#LC_helpmenu {
1.803     bisitz   5391:   border: none;
1.398     albertel 5392:   height: 55px;
1.803     bisitz   5393:   border-spacing: 0;
1.398     albertel 5394: }
                   5395: 
                   5396: table#LC_helpmenu fieldset legend {
                   5397:   font-size: larger;
                   5398: }
1.795     www      5399: 
1.397     albertel 5400: table#LC_helpmenu_links {
                   5401:   width: 100%;
                   5402:   border: 1px solid black;
                   5403:   background: $pgbg;
1.803     bisitz   5404:   padding: 0;
1.397     albertel 5405:   border-spacing: 1px;
                   5406: }
1.795     www      5407: 
1.397     albertel 5408: table#LC_helpmenu_links tr td {
                   5409:   padding: 1px;
                   5410:   background: $tabbg;
1.399     albertel 5411:   text-align: center;
                   5412:   font-weight: bold;
1.397     albertel 5413: }
1.396     albertel 5414: 
1.795     www      5415: table#LC_helpmenu_links a:link,
                   5416: table#LC_helpmenu_links a:visited,
1.397     albertel 5417: table#LC_helpmenu_links a:active {
                   5418:   text-decoration: none;
                   5419:   color: $font;
                   5420: }
1.795     www      5421: 
1.397     albertel 5422: table#LC_helpmenu_links a:hover {
                   5423:   text-decoration: underline;
                   5424:   color: $vlink;
                   5425: }
1.396     albertel 5426: 
1.417     albertel 5427: .LC_chrt_popup_exists {
                   5428:   border: 1px solid #339933;
                   5429:   margin: -1px;
                   5430: }
1.795     www      5431: 
1.417     albertel 5432: .LC_chrt_popup_up {
                   5433:   border: 1px solid yellow;
                   5434:   margin: -1px;
                   5435: }
1.795     www      5436: 
1.417     albertel 5437: .LC_chrt_popup {
                   5438:   border: 1px solid #8888FF;
                   5439:   background: #CCCCFF;
                   5440: }
1.795     www      5441: 
1.421     albertel 5442: table.LC_pick_box {
                   5443:   border-collapse: separate;
                   5444:   background: white;
                   5445:   border: 1px solid black;
                   5446:   border-spacing: 1px;
                   5447: }
1.795     www      5448: 
1.421     albertel 5449: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5450:   background: $sidebg;
1.421     albertel 5451:   font-weight: bold;
1.900     bisitz   5452:   text-align: left;
1.740     bisitz   5453:   vertical-align: top;
1.421     albertel 5454:   width: 184px;
                   5455:   padding: 8px;
                   5456: }
1.795     www      5457: 
1.579     raeburn  5458: table.LC_pick_box td.LC_pick_box_value {
                   5459:   text-align: left;
                   5460:   padding: 8px;
                   5461: }
1.795     www      5462: 
1.579     raeburn  5463: table.LC_pick_box td.LC_pick_box_select {
                   5464:   text-align: left;
                   5465:   padding: 8px;
                   5466: }
1.795     www      5467: 
1.424     albertel 5468: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5469:   padding: 0;
1.421     albertel 5470:   height: 1px;
                   5471:   background: black;
                   5472: }
1.795     www      5473: 
1.421     albertel 5474: table.LC_pick_box td.LC_pick_box_submit {
                   5475:   text-align: right;
                   5476: }
1.795     www      5477: 
1.579     raeburn  5478: table.LC_pick_box td.LC_evenrow_value {
                   5479:   text-align: left;
                   5480:   padding: 8px;
                   5481:   background-color: $data_table_light;
                   5482: }
1.795     www      5483: 
1.579     raeburn  5484: table.LC_pick_box td.LC_oddrow_value {
                   5485:   text-align: left;
                   5486:   padding: 8px;
                   5487:   background-color: $data_table_light;
                   5488: }
1.795     www      5489: 
1.579     raeburn  5490: span.LC_helpform_receipt_cat {
                   5491:   font-weight: bold;
                   5492: }
1.795     www      5493: 
1.424     albertel 5494: table.LC_group_priv_box {
                   5495:   background: white;
                   5496:   border: 1px solid black;
                   5497:   border-spacing: 1px;
                   5498: }
1.795     www      5499: 
1.424     albertel 5500: table.LC_group_priv_box td.LC_pick_box_title {
                   5501:   background: $tabbg;
                   5502:   font-weight: bold;
                   5503:   text-align: right;
                   5504:   width: 184px;
                   5505: }
1.795     www      5506: 
1.424     albertel 5507: table.LC_group_priv_box td.LC_groups_fixed {
                   5508:   background: $data_table_light;
                   5509:   text-align: center;
                   5510: }
1.795     www      5511: 
1.424     albertel 5512: table.LC_group_priv_box td.LC_groups_optional {
                   5513:   background: $data_table_dark;
                   5514:   text-align: center;
                   5515: }
1.795     www      5516: 
1.424     albertel 5517: table.LC_group_priv_box td.LC_groups_functionality {
                   5518:   background: $data_table_darker;
                   5519:   text-align: center;
                   5520:   font-weight: bold;
                   5521: }
1.795     www      5522: 
1.424     albertel 5523: table.LC_group_priv td {
                   5524:   text-align: left;
1.803     bisitz   5525:   padding: 0;
1.424     albertel 5526: }
                   5527: 
1.421     albertel 5528: table.LC_notify_front_page {
                   5529:   background: white;
                   5530:   border: 1px solid black;
                   5531:   padding: 8px;
                   5532: }
1.795     www      5533: 
1.421     albertel 5534: table.LC_notify_front_page td {
                   5535:   padding: 8px;
                   5536: }
1.795     www      5537: 
1.424     albertel 5538: .LC_navbuttons {
                   5539:   margin: 2ex 0ex 2ex 0ex;
                   5540: }
1.795     www      5541: 
1.423     albertel 5542: .LC_topic_bar {
                   5543:   font-weight: bold;
                   5544:   background: $tabbg;
1.918   ! wenzelju 5545:   margin: 1em 0em 1em 2em;
1.805     bisitz   5546:   padding: 3px;
1.918   ! wenzelju 5547:   font-size: 1.2em;
1.423     albertel 5548: }
1.795     www      5549: 
1.423     albertel 5550: .LC_topic_bar span {
1.918   ! wenzelju 5551:   left: 0.5em;
        !          5552:   position: absolute;
1.423     albertel 5553:   vertical-align: middle;
1.918   ! wenzelju 5554:   font-size: 1.2em;
1.423     albertel 5555: }
1.795     www      5556: 
1.423     albertel 5557: .LC_topic_bar img {
                   5558:   vertical-align: bottom;
                   5559: }
1.795     www      5560: 
1.423     albertel 5561: table.LC_course_group_status {
                   5562:   margin: 20px;
                   5563: }
1.795     www      5564: 
1.423     albertel 5565: table.LC_status_selector td {
                   5566:   vertical-align: top;
                   5567:   text-align: center;
1.424     albertel 5568:   padding: 4px;
                   5569: }
1.795     www      5570: 
1.599     albertel 5571: div.LC_feedback_link {
1.616     albertel 5572:   clear: both;
1.829     kalberla 5573:   background: $sidebg;
1.779     bisitz   5574:   width: 100%;
1.829     kalberla 5575:   padding-bottom: 10px;
                   5576:   border: 1px $tabbg solid;
1.833     kalberla 5577:   height: 22px;
                   5578:   line-height: 22px;
                   5579:   padding-top: 5px;
                   5580: }
                   5581: 
                   5582: div.LC_feedback_link img {
                   5583:   height: 22px;
1.867     kalberla 5584:   vertical-align:middle;
1.829     kalberla 5585: }
                   5586: 
1.911     bisitz   5587: div.LC_feedback_link a {
1.829     kalberla 5588:   text-decoration: none;
1.489     raeburn  5589: }
1.795     www      5590: 
1.867     kalberla 5591: div.LC_comblock {
1.911     bisitz   5592:   display:inline;
1.867     kalberla 5593:   color:$font;
                   5594:   font-size:90%;
                   5595: }
                   5596: 
                   5597: div.LC_feedback_link div.LC_comblock {
                   5598:   padding-left:5px;
                   5599: }
                   5600: 
                   5601: div.LC_feedback_link div.LC_comblock a {
                   5602:   color:$font;
                   5603: }
                   5604: 
1.489     raeburn  5605: span.LC_feedback_link {
1.858     bisitz   5606:   /* background: $feedback_link_bg; */
1.599     albertel 5607:   font-size: larger;
                   5608: }
1.795     www      5609: 
1.599     albertel 5610: span.LC_message_link {
1.858     bisitz   5611:   /* background: $feedback_link_bg; */
1.599     albertel 5612:   font-size: larger;
                   5613:   position: absolute;
                   5614:   right: 1em;
1.489     raeburn  5615: }
1.421     albertel 5616: 
1.515     albertel 5617: table.LC_prior_tries {
1.524     albertel 5618:   border: 1px solid #000000;
                   5619:   border-collapse: separate;
                   5620:   border-spacing: 1px;
1.515     albertel 5621: }
1.523     albertel 5622: 
1.515     albertel 5623: table.LC_prior_tries td {
1.524     albertel 5624:   padding: 2px;
1.515     albertel 5625: }
1.523     albertel 5626: 
                   5627: .LC_answer_correct {
1.795     www      5628:   background: lightgreen;
                   5629:   color: darkgreen;
                   5630:   padding: 6px;
1.523     albertel 5631: }
1.795     www      5632: 
1.523     albertel 5633: .LC_answer_charged_try {
1.797     www      5634:   background: #FFAAAA;
1.795     www      5635:   color: darkred;
                   5636:   padding: 6px;
1.523     albertel 5637: }
1.795     www      5638: 
1.779     bisitz   5639: .LC_answer_not_charged_try,
1.523     albertel 5640: .LC_answer_no_grade,
                   5641: .LC_answer_late {
1.795     www      5642:   background: lightyellow;
1.523     albertel 5643:   color: black;
1.795     www      5644:   padding: 6px;
1.523     albertel 5645: }
1.795     www      5646: 
1.523     albertel 5647: .LC_answer_previous {
1.795     www      5648:   background: lightblue;
                   5649:   color: darkblue;
                   5650:   padding: 6px;
1.523     albertel 5651: }
1.795     www      5652: 
1.779     bisitz   5653: .LC_answer_no_message {
1.777     tempelho 5654:   background: #FFFFFF;
                   5655:   color: black;
1.795     www      5656:   padding: 6px;
1.779     bisitz   5657: }
1.795     www      5658: 
1.779     bisitz   5659: .LC_answer_unknown {
                   5660:   background: orange;
                   5661:   color: black;
1.795     www      5662:   padding: 6px;
1.777     tempelho 5663: }
1.795     www      5664: 
1.529     albertel 5665: span.LC_prior_numerical,
                   5666: span.LC_prior_string,
                   5667: span.LC_prior_custom,
                   5668: span.LC_prior_reaction,
                   5669: span.LC_prior_math {
1.523     albertel 5670:   font-family: monospace;
                   5671:   white-space: pre;
                   5672: }
                   5673: 
1.525     albertel 5674: span.LC_prior_string {
                   5675:   font-family: monospace;
                   5676:   white-space: pre;
                   5677: }
                   5678: 
1.523     albertel 5679: table.LC_prior_option {
                   5680:   width: 100%;
                   5681:   border-collapse: collapse;
                   5682: }
1.795     www      5683: 
1.911     bisitz   5684: table.LC_prior_rank,
1.795     www      5685: table.LC_prior_match {
1.528     albertel 5686:   border-collapse: collapse;
                   5687: }
1.795     www      5688: 
1.528     albertel 5689: table.LC_prior_option tr td,
                   5690: table.LC_prior_rank tr td,
                   5691: table.LC_prior_match tr td {
1.524     albertel 5692:   border: 1px solid #000000;
1.515     albertel 5693: }
                   5694: 
1.855     bisitz   5695: .LC_nobreak {
1.544     albertel 5696:   white-space: nowrap;
1.519     raeburn  5697: }
                   5698: 
1.576     raeburn  5699: span.LC_cusr_emph {
                   5700:   font-style: italic;
                   5701: }
                   5702: 
1.633     raeburn  5703: span.LC_cusr_subheading {
                   5704:   font-weight: normal;
                   5705:   font-size: 85%;
                   5706: }
                   5707: 
1.545     albertel 5708: table.LC_docs_documents {
                   5709:   background: #BBBBBB;
1.803     bisitz   5710:   border-width: 0;
1.545     albertel 5711:   border-collapse: collapse;
                   5712: }
1.795     www      5713: 
1.777     tempelho 5714: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5715:   border: 2px solid black;
                   5716:   padding: 4px;
1.777     tempelho 5717: }
1.795     www      5718: 
1.861     bisitz   5719: div.LC_docs_entry_move {
1.859     bisitz   5720:   border: 1px solid #BBBBBB;
1.545     albertel 5721:   background: #DDDDDD;
1.861     bisitz   5722:   width: 22px;
1.859     bisitz   5723:   padding: 1px;
                   5724:   margin: 0;
1.545     albertel 5725: }
                   5726: 
1.861     bisitz   5727: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5728: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5729:   background: #DDDDDD;
                   5730:   font-size: x-small;
                   5731: }
1.795     www      5732: 
1.861     bisitz   5733: .LC_docs_entry_parameter {
                   5734:   white-space: nowrap;
                   5735: }
                   5736: 
1.544     albertel 5737: .LC_docs_copy {
1.545     albertel 5738:   color: #000099;
1.544     albertel 5739: }
1.795     www      5740: 
1.544     albertel 5741: .LC_docs_cut {
1.545     albertel 5742:   color: #550044;
1.544     albertel 5743: }
1.795     www      5744: 
1.544     albertel 5745: .LC_docs_rename {
1.545     albertel 5746:   color: #009900;
1.544     albertel 5747: }
1.795     www      5748: 
1.544     albertel 5749: .LC_docs_remove {
1.545     albertel 5750:   color: #990000;
                   5751: }
                   5752: 
1.547     albertel 5753: .LC_docs_reinit_warn,
                   5754: .LC_docs_ext_edit {
                   5755:   font-size: x-small;
                   5756: }
                   5757: 
1.545     albertel 5758: table.LC_docs_adddocs td,
                   5759: table.LC_docs_adddocs th {
                   5760:   border: 1px solid #BBBBBB;
                   5761:   padding: 4px;
                   5762:   background: #DDDDDD;
1.543     albertel 5763: }
                   5764: 
1.584     albertel 5765: table.LC_sty_begin {
                   5766:   background: #BBFFBB;
                   5767: }
1.795     www      5768: 
1.584     albertel 5769: table.LC_sty_end {
                   5770:   background: #FFBBBB;
                   5771: }
                   5772: 
1.589     raeburn  5773: table.LC_double_column {
1.803     bisitz   5774:   border-width: 0;
1.589     raeburn  5775:   border-collapse: collapse;
                   5776:   width: 100%;
                   5777:   padding: 2px;
                   5778: }
                   5779: 
                   5780: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5781:   top: 2px;
1.589     raeburn  5782:   left: 2px;
                   5783:   width: 47%;
                   5784:   vertical-align: top;
                   5785: }
                   5786: 
                   5787: table.LC_double_column tr td.LC_right_col {
                   5788:   top: 2px;
1.779     bisitz   5789:   right: 2px;
1.589     raeburn  5790:   width: 47%;
                   5791:   vertical-align: top;
                   5792: }
                   5793: 
1.591     raeburn  5794: div.LC_left_float {
                   5795:   float: left;
                   5796:   padding-right: 5%;
1.597     albertel 5797:   padding-bottom: 4px;
1.591     raeburn  5798: }
                   5799: 
                   5800: div.LC_clear_float_header {
1.597     albertel 5801:   padding-bottom: 2px;
1.591     raeburn  5802: }
                   5803: 
                   5804: div.LC_clear_float_footer {
1.597     albertel 5805:   padding-top: 10px;
1.591     raeburn  5806:   clear: both;
                   5807: }
                   5808: 
1.597     albertel 5809: div.LC_grade_show_user {
                   5810:   margin-top: 20px;
                   5811:   border: 1px solid black;
                   5812: }
1.795     www      5813: 
1.597     albertel 5814: div.LC_grade_user_name {
                   5815:   background: #DDDDEE;
                   5816:   border-bottom: 1px solid black;
1.705     tempelho 5817:   font-weight: bold;
                   5818:   font-size: large;
1.597     albertel 5819: }
1.795     www      5820: 
1.597     albertel 5821: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5822:   background: #DDEEDD;
                   5823: }
                   5824: 
                   5825: div.LC_grade_show_problem,
                   5826: div.LC_grade_submissions,
                   5827: div.LC_grade_message_center,
                   5828: div.LC_grade_info_links,
                   5829: div.LC_grade_assign {
                   5830:   margin: 5px;
                   5831:   width: 99%;
                   5832:   background: #FFFFFF;
                   5833: }
1.795     www      5834: 
1.597     albertel 5835: div.LC_grade_show_problem_header,
                   5836: div.LC_grade_submissions_header,
                   5837: div.LC_grade_message_center_header,
                   5838: div.LC_grade_assign_header {
1.705     tempelho 5839:   font-weight: bold;
                   5840:   font-size: large;
1.597     albertel 5841: }
1.795     www      5842: 
1.597     albertel 5843: div.LC_grade_show_problem_problem,
                   5844: div.LC_grade_submissions_body,
                   5845: div.LC_grade_message_center_body,
                   5846: div.LC_grade_assign_body {
                   5847:   border: 1px solid black;
                   5848:   width: 99%;
                   5849:   background: #FFFFFF;
                   5850: }
1.795     www      5851: 
1.598     albertel 5852: span.LC_grade_check_note {
1.705     tempelho 5853:   font-weight: normal;
                   5854:   font-size: medium;
1.598     albertel 5855:   display: inline;
                   5856:   position: absolute;
                   5857:   right: 1em;
                   5858: }
1.597     albertel 5859: 
1.613     albertel 5860: table.LC_scantron_action {
                   5861:   width: 100%;
                   5862: }
1.795     www      5863: 
1.613     albertel 5864: table.LC_scantron_action tr th {
1.698     harmsja  5865:   font-weight:bold;
                   5866:   font-style:normal;
1.613     albertel 5867: }
1.795     www      5868: 
1.779     bisitz   5869: .LC_edit_problem_header,
1.614     albertel 5870: div.LC_edit_problem_footer {
1.705     tempelho 5871:   font-weight: normal;
                   5872:   font-size:  medium;
1.602     albertel 5873:   margin: 2px;
1.600     albertel 5874: }
1.795     www      5875: 
1.600     albertel 5876: div.LC_edit_problem_header,
1.602     albertel 5877: div.LC_edit_problem_header div,
1.614     albertel 5878: div.LC_edit_problem_footer,
                   5879: div.LC_edit_problem_footer div,
1.602     albertel 5880: div.LC_edit_problem_editxml_header,
                   5881: div.LC_edit_problem_editxml_header div {
1.600     albertel 5882:   margin-top: 5px;
                   5883: }
1.795     www      5884: 
1.600     albertel 5885: div.LC_edit_problem_header_title {
1.705     tempelho 5886:   font-weight: bold;
                   5887:   font-size: larger;
1.602     albertel 5888:   background: $tabbg;
                   5889:   padding: 3px;
                   5890: }
1.795     www      5891: 
1.602     albertel 5892: table.LC_edit_problem_header_title {
1.705     tempelho 5893:   font-size: larger;
                   5894:   font-weight:  bold;
1.602     albertel 5895:   width: 100%;
                   5896:   border-color: $pgbg;
                   5897:   border-style: solid;
                   5898:   border-width: $border;
1.600     albertel 5899:   background: $tabbg;
1.602     albertel 5900:   border-collapse: collapse;
1.803     bisitz   5901:   padding: 0;
1.602     albertel 5902: }
                   5903: 
                   5904: div.LC_edit_problem_discards {
                   5905:   float: left;
                   5906:   padding-bottom: 5px;
                   5907: }
1.795     www      5908: 
1.602     albertel 5909: div.LC_edit_problem_saves {
                   5910:   float: right;
                   5911:   padding-bottom: 5px;
1.600     albertel 5912: }
1.795     www      5913: 
1.911     bisitz   5914: img.stift {
1.803     bisitz   5915:   border-width: 0;
                   5916:   vertical-align: middle;
1.677     riegler  5917: }
1.680     riegler  5918: 
1.911     bisitz   5919: table#LC_mainmenu {
                   5920:   margin-top:10px;
                   5921:   width:80%;
1.681     riegler  5922: }
                   5923: 
1.911     bisitz   5924: table#LC_mainmenu td.LC_mainmenu_col_fieldset {
1.680     riegler  5925:   vertical-align: top;
                   5926:   width: 45%;
                   5927: }
1.795     www      5928: 
1.779     bisitz   5929: .LC_mainmenu_fieldset_category {
                   5930:   color: $font;
                   5931:   background: $pgbg;
                   5932:   font-size: small;
                   5933:   font-weight: bold;
1.777     tempelho 5934: }
1.795     www      5935: 
1.716     raeburn  5936: div.LC_createcourse {
1.911     bisitz   5937:   margin: 10px 10px 10px 10px;
1.716     raeburn  5938: }
                   5939: 
1.917     raeburn  5940: .LC_dccid {
                   5941:   margin: 0.2em 0 0 0;
                   5942:   padding: 0;
                   5943:   font-size: 90%;
                   5944:   display:none;
                   5945: }
                   5946: 
1.693     droeschl 5947: /* ---- Remove when done ----
                   5948: # The following styles is part of the redesign of LON-CAPA and are
                   5949: # subject to change during this project.
                   5950: # Don't rely on their current functionality as they might be 
                   5951: # changed or removed.
                   5952: # --------------------------*/
                   5953: 
1.698     harmsja  5954: a:hover,
1.897     wenzelju 5955: ol.LC_primary_menu a:hover,
1.721     harmsja  5956: ol#LC_MenuBreadcrumbs a:hover,
                   5957: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5958: ul#LC_secondary_menu a:hover,
1.721     harmsja  5959: .LC_FormSectionClearButton input:hover
1.795     www      5960: ul.LC_TabContent   li:hover a {
1.911     bisitz   5961:   color:#BF2317;
                   5962:   text-decoration:none;
1.693     droeschl 5963: }
                   5964: 
1.779     bisitz   5965: h1 {
1.911     bisitz   5966:   padding: 0;
                   5967:   line-height:130%;
1.693     droeschl 5968: }
1.698     harmsja  5969: 
1.911     bisitz   5970: h2,
                   5971: h3,
                   5972: h4,
                   5973: h5,
                   5974: h6 {
                   5975:   margin: 5px 0 5px 0;
                   5976:   padding: 0;
                   5977:   line-height:130%;
1.693     droeschl 5978: }
1.795     www      5979: 
                   5980: .LC_hcell {
1.911     bisitz   5981:   padding:3px 15px 3px 15px;
                   5982:   margin: 0;
                   5983:   background-color:$tabbg;
                   5984:   color:$fontmenu;
                   5985:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5986: }
1.795     www      5987: 
1.840     bisitz   5988: .LC_Box > .LC_hcell {
1.911     bisitz   5989:   margin: 0 -10px 10px -10px;
1.835     bisitz   5990: }
                   5991: 
1.721     harmsja  5992: .LC_noBorder {
1.911     bisitz   5993:   border: 0;
1.698     harmsja  5994: }
1.693     droeschl 5995: 
1.761     tempelho 5996: .LC_Right {
1.911     bisitz   5997:   float: right;
                   5998:   margin: 0;
                   5999:   padding: 0;
1.761     tempelho 6000: }
                   6001: 
1.721     harmsja  6002: .LC_FormSectionClearButton input {
1.911     bisitz   6003:   background-color:transparent;
                   6004:   border: none;
                   6005:   cursor:pointer;
                   6006:   text-decoration:underline;
1.693     droeschl 6007: }
1.763     bisitz   6008: 
                   6009: .LC_help_open_topic {
1.911     bisitz   6010:   color: #FFFFFF;
                   6011:   background-color: #EEEEFF;
                   6012:   margin: 1px;
                   6013:   padding: 4px;
                   6014:   border: 1px solid #000033;
                   6015:   white-space: nowrap;
                   6016:   /* vertical-align: middle; */
1.759     neumanie 6017: }
1.693     droeschl 6018: 
1.911     bisitz   6019: dl,
                   6020: ul,
                   6021: div,
                   6022: fieldset {
                   6023:   margin: 10px 10px 10px 0;
                   6024:   /* overflow: hidden; */
1.693     droeschl 6025: }
1.795     www      6026: 
1.838     bisitz   6027: fieldset > legend {
1.911     bisitz   6028:   font-weight: bold;
                   6029:   padding: 0 5px 0 5px;
1.838     bisitz   6030: }
                   6031: 
1.813     bisitz   6032: #LC_nav_bar {
1.911     bisitz   6033:   float: left;
                   6034:   margin: 0.2em 0 0 0;
1.807     droeschl 6035: }
                   6036: 
1.916     droeschl 6037: #LC_realm {
                   6038:   margin: 0.2em 0 0 0;
                   6039:   padding: 0;
                   6040:   font-weight: bold;
                   6041:   text-align: center;
                   6042: }
                   6043: 
1.911     bisitz   6044: #LC_nav_bar em {
                   6045:   font-weight: bold;
                   6046:   font-style: normal;
1.807     droeschl 6047: }
                   6048: 
1.897     wenzelju 6049: ol.LC_primary_menu {
1.911     bisitz   6050:   float: right;
                   6051:   margin: 0.2em 0 0 0;
1.807     droeschl 6052: }
                   6053: 
1.852     droeschl 6054: ol#LC_PathBreadcrumbs {
1.911     bisitz   6055:   margin: 0;
1.693     droeschl 6056: }
                   6057: 
1.897     wenzelju 6058: ol.LC_primary_menu li {
1.911     bisitz   6059:   display: inline;
                   6060:   padding: 5px 5px 0 10px;
                   6061:   vertical-align: top;
1.693     droeschl 6062: }
                   6063: 
1.897     wenzelju 6064: ol.LC_primary_menu li img {
1.911     bisitz   6065:   vertical-align: bottom;
1.693     droeschl 6066: }
                   6067: 
1.897     wenzelju 6068: ol.LC_primary_menu a {
1.911     bisitz   6069:   font-size: 90%;
                   6070:   color: RGB(80, 80, 80);
                   6071:   text-decoration: none;
1.693     droeschl 6072: }
1.795     www      6073: 
1.897     wenzelju 6074: ul#LC_secondary_menu {
1.911     bisitz   6075:   clear: both;
                   6076:   color: $fontmenu;
                   6077:   background: $tabbg;
                   6078:   list-style: none;
                   6079:   padding: 0;
                   6080:   margin: 0;
                   6081:   width: 100%;
1.808     droeschl 6082: }
                   6083: 
1.897     wenzelju 6084: ul#LC_secondary_menu li {
1.911     bisitz   6085:   font-weight: bold;
                   6086:   line-height: 1.8em;
                   6087:   padding: 0 0.8em;
                   6088:   border-right: 1px solid black;
                   6089:   display: inline;
                   6090:   vertical-align: middle;
1.807     droeschl 6091: }
                   6092: 
1.847     tempelho 6093: ul.LC_TabContent {
1.911     bisitz   6094:   display:block;
                   6095:   background: $sidebg;
                   6096:   border-bottom: solid 1px $lg_border_color;
                   6097:   list-style:none;
                   6098:   margin: 0 -10px;
                   6099:   padding: 0;
1.693     droeschl 6100: }
                   6101: 
1.795     www      6102: ul.LC_TabContent li,
                   6103: ul.LC_TabContentBigger li {
1.911     bisitz   6104:   float:left;
1.741     harmsja  6105: }
1.795     www      6106: 
1.897     wenzelju 6107: ul#LC_secondary_menu li a {
1.911     bisitz   6108:   color: $fontmenu;
                   6109:   text-decoration: none;
1.693     droeschl 6110: }
1.795     www      6111: 
1.721     harmsja  6112: ul.LC_TabContent {
1.911     bisitz   6113:   min-height:1.5em;
1.721     harmsja  6114: }
1.795     www      6115: 
                   6116: ul.LC_TabContent li {
1.911     bisitz   6117:   vertical-align:middle;
                   6118:   padding: 0 10px 0 10px;
                   6119:   background-color:$tabbg;
                   6120:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6121: }
1.795     www      6122: 
1.847     tempelho 6123: ul.LC_TabContent .right {
1.911     bisitz   6124:   float:right;
1.847     tempelho 6125: }
                   6126: 
1.911     bisitz   6127: ul.LC_TabContent li a,
                   6128: ul.LC_TabContent li {
                   6129:   color:rgb(47,47,47);
                   6130:   text-decoration:none;
                   6131:   font-size:95%;
                   6132:   font-weight:bold;
                   6133:   padding-right: 16px;
1.721     harmsja  6134: }
1.795     www      6135: 
1.911     bisitz   6136: ul.LC_TabContent li:hover,
                   6137: ul.LC_TabContent li.active {
                   6138:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6139:   border-bottom:solid 2px #FFFFFF;
                   6140:   padding-right: 16px;
1.744     ehlerst  6141: }
1.795     www      6142: 
1.870     tempelho 6143: #maincoursedoc {
1.911     bisitz   6144:   clear:both;
1.870     tempelho 6145: }
                   6146: 
                   6147: ul.LC_TabContentBigger {
1.911     bisitz   6148:   display:block;
                   6149:   list-style:none;
                   6150:   padding: 0;
1.870     tempelho 6151: }
                   6152: 
1.795     www      6153: ul.LC_TabContentBigger li {
1.911     bisitz   6154:   vertical-align:bottom;
                   6155:   height: 30px;
                   6156:   font-size:110%;
                   6157:   font-weight:bold;
                   6158:   color: #737373;
1.841     tempelho 6159: }
                   6160: 
1.870     tempelho 6161: 
                   6162: ul.LC_TabContentBigger li a {
1.911     bisitz   6163:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6164:   height: 30px;
                   6165:   line-height: 30px;
                   6166:   text-align: center;
                   6167:   display: block;
                   6168:   text-decoration: none;
1.741     harmsja  6169: }
1.795     www      6170: 
1.911     bisitz   6171: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6172: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6173:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6174:   color:$font;
                   6175:   text-decoration: underline;
1.744     ehlerst  6176: }
1.795     www      6177: 
1.870     tempelho 6178: 
                   6179: ul.LC_TabContentBigger li b {
1.911     bisitz   6180:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6181:   display: block;
                   6182:   float: left;
                   6183:   padding: 0 30px;
1.870     tempelho 6184: }
                   6185: 
                   6186: ul.LC_TabContentBigger li:hover b,
                   6187: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6188:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6189:   color:$font;
                   6190:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6191: }
1.693     droeschl 6192: 
1.870     tempelho 6193: 
1.862     bisitz   6194: ul.LC_CourseBreadcrumbs {
                   6195:   background: $sidebg;
                   6196:   line-height: 32px;
                   6197:   padding-left: 10px;
                   6198:   margin: 0 0 10px 0;
                   6199:   list-style-position: inside;
                   6200: 
                   6201: }
                   6202: 
1.911     bisitz   6203: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6204: ol#LC_PathBreadcrumbs {
1.911     bisitz   6205:   padding-left: 10px;
                   6206:   margin: 0;
                   6207:   list-style-position: inside;
1.915     droeschl 6208:     /* SD working here 
1.904     droeschl 6209:     white-space: nowrap; */
1.693     droeschl 6210: }
                   6211: 
1.911     bisitz   6212: ol#LC_MenuBreadcrumbs li,
                   6213: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6214: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6215:   display: inline;
                   6216:   white-space: nowrap;
1.915     droeschl 6217:     /* SD working here  
                   6218:     white-space: normal; */ 
1.693     droeschl 6219: }
                   6220: 
1.823     bisitz   6221: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6222: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6223:   text-decoration: none;
                   6224:   font-size:90%;
1.693     droeschl 6225: }
1.795     www      6226: 
                   6227: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6228:   text-decoration:none;
                   6229:   font-size:100%;
                   6230:   font-weight:bold;
1.693     droeschl 6231: }
1.795     www      6232: 
1.840     bisitz   6233: .LC_Box {
1.911     bisitz   6234:   border: solid 1px $lg_border_color;
                   6235:   padding: 0 10px 10px 10px;
1.746     neumanie 6236: }
1.795     www      6237: 
                   6238: .LC_AboutMe_Image {
1.911     bisitz   6239:   float:left;
                   6240:   margin-right:10px;
1.747     neumanie 6241: }
1.795     www      6242: 
                   6243: .LC_Clear_AboutMe_Image {
1.911     bisitz   6244:   clear:left;
1.747     neumanie 6245: }
1.795     www      6246: 
1.721     harmsja  6247: dl.LC_ListStyleClean dt {
1.911     bisitz   6248:   padding-right: 5px;
                   6249:   display: table-header-group;
1.693     droeschl 6250: }
                   6251: 
1.721     harmsja  6252: dl.LC_ListStyleClean dd {
1.911     bisitz   6253:   display: table-row;
1.693     droeschl 6254: }
                   6255: 
1.721     harmsja  6256: .LC_ListStyleClean,
                   6257: .LC_ListStyleSimple,
                   6258: .LC_ListStyleNormal,
1.777     tempelho 6259: .LC_ListStyle_Border,
1.795     www      6260: .LC_ListStyleSpecial {
1.911     bisitz   6261:   /* display:block; */
                   6262:   list-style-position: inside;
                   6263:   list-style-type: none;
                   6264:   overflow: hidden;
                   6265:   padding: 0;
1.693     droeschl 6266: }
                   6267: 
1.721     harmsja  6268: .LC_ListStyleSimple li,
                   6269: .LC_ListStyleSimple dd,
                   6270: .LC_ListStyleNormal li,
                   6271: .LC_ListStyleNormal dd,
                   6272: .LC_ListStyleSpecial li,
1.795     www      6273: .LC_ListStyleSpecial dd {
1.911     bisitz   6274:   margin: 0;
                   6275:   padding: 5px 5px 5px 10px;
                   6276:   clear: both;
1.693     droeschl 6277: }
                   6278: 
1.721     harmsja  6279: .LC_ListStyleClean li,
                   6280: .LC_ListStyleClean dd {
1.911     bisitz   6281:   padding-top: 0;
                   6282:   padding-bottom: 0;
1.693     droeschl 6283: }
                   6284: 
1.721     harmsja  6285: .LC_ListStyleSimple dd,
1.795     www      6286: .LC_ListStyleSimple li {
1.911     bisitz   6287:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6288: }
                   6289: 
1.721     harmsja  6290: .LC_ListStyleSpecial li,
                   6291: .LC_ListStyleSpecial dd {
1.911     bisitz   6292:   list-style-type: none;
                   6293:   background-color: RGB(220, 220, 220);
                   6294:   margin-bottom: 4px;
1.693     droeschl 6295: }
                   6296: 
1.721     harmsja  6297: table.LC_SimpleTable {
1.911     bisitz   6298:   margin:5px;
                   6299:   border:solid 1px $lg_border_color;
1.795     www      6300: }
1.693     droeschl 6301: 
1.721     harmsja  6302: table.LC_SimpleTable tr {
1.911     bisitz   6303:   padding: 0;
                   6304:   border:solid 1px $lg_border_color;
1.693     droeschl 6305: }
1.795     www      6306: 
                   6307: table.LC_SimpleTable thead {
1.911     bisitz   6308:   background:rgb(220,220,220);
1.693     droeschl 6309: }
                   6310: 
1.721     harmsja  6311: div.LC_columnSection {
1.911     bisitz   6312:   display: block;
                   6313:   clear: both;
                   6314:   overflow: hidden;
                   6315:   margin: 0;
1.693     droeschl 6316: }
                   6317: 
1.721     harmsja  6318: div.LC_columnSection>* {
1.911     bisitz   6319:   float: left;
                   6320:   margin: 10px 20px 10px 0;
                   6321:   overflow:hidden;
1.693     droeschl 6322: }
1.721     harmsja  6323: 
1.694     tempelho 6324: .LC_loginpage_container {
1.911     bisitz   6325:   text-align:left;
                   6326:   margin : 0 auto;
                   6327:   width:90%;
                   6328:   padding: 10px;
                   6329:   height: auto;
                   6330:   background-color:#FFFFFF;
                   6331:   border:1px solid #CCCCCC;
1.694     tempelho 6332: }
                   6333: 
                   6334: 
                   6335: .LC_loginpage_loginContainer {
1.911     bisitz   6336:   float:left;
                   6337:   width: 182px;
                   6338:   padding: 2px;
                   6339:   border:1px solid #CCCCCC;
                   6340:   background-color:$loginbg;
1.694     tempelho 6341: }
                   6342: 
1.795     www      6343: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6344:   margin-top: 0;
                   6345:   display:block;
                   6346:   background:$bgcol;
                   6347:   color:$textcol;
                   6348:   padding-left:5px;
1.712     muellerd 6349: }
1.785     tempelho 6350: 
1.694     tempelho 6351: .LC_loginpage_loginInfo {
1.911     bisitz   6352:   float:left;
                   6353:   width:182px;
                   6354:   border:1px solid #CCCCCC;
                   6355:   padding:2px;
1.712     muellerd 6356: }
                   6357: 
1.694     tempelho 6358: .LC_loginpage_space {
1.911     bisitz   6359:   clear: both;
                   6360:   margin-bottom: 20px;
                   6361:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6362: }
                   6363: 
1.785     tempelho 6364: .LC_loginpage_floatLeft {
1.911     bisitz   6365:   float: left;
                   6366:   width: 200px;
                   6367:   margin: 0;
1.785     tempelho 6368: }
                   6369: 
1.795     www      6370: table em {
1.911     bisitz   6371:   font-weight: bold;
                   6372:   font-style: normal;
1.748     schulted 6373: }
1.795     www      6374: 
1.779     bisitz   6375: table.LC_tableBrowseRes,
1.795     www      6376: table.LC_tableOfContent {
1.911     bisitz   6377:   border:none;
                   6378:   border-spacing: 1px;
                   6379:   padding: 3px;
                   6380:   background-color: #FFFFFF;
                   6381:   font-size: 90%;
1.753     droeschl 6382: }
1.789     droeschl 6383: 
1.911     bisitz   6384: table.LC_tableOfContent {
                   6385:   border-collapse: collapse;
1.789     droeschl 6386: }
                   6387: 
1.771     droeschl 6388: table.LC_tableBrowseRes a,
1.768     schulted 6389: table.LC_tableOfContent a {
1.911     bisitz   6390:   background-color: transparent;
                   6391:   text-decoration: none;
1.753     droeschl 6392: }
                   6393: 
1.771     droeschl 6394: table.LC_tableBrowseRes tr.LC_trOdd,
1.911     bisitz   6395: table.LC_tableOfContent tr.LC_trOdd {
                   6396:   background-color: #EEEEEE;
1.753     droeschl 6397: }
                   6398: 
1.795     www      6399: table.LC_tableOfContent img {
1.911     bisitz   6400:   border: none;
                   6401:   height: 1.3em;
                   6402:   vertical-align: text-bottom;
                   6403:   margin-right: 0.3em;
1.753     droeschl 6404: }
1.757     schulted 6405: 
1.795     www      6406: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6407:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6408: }
                   6409: 
1.795     www      6410: a#LC_content_toolbar_launchnav {
1.911     bisitz   6411:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6412: }
                   6413: 
1.795     www      6414: a#LC_content_toolbar_closenav {
1.911     bisitz   6415:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6416: }
                   6417: 
1.795     www      6418: a#LC_content_toolbar_everything {
1.911     bisitz   6419:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6420: }
                   6421: 
1.795     www      6422: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6423:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6424: }
                   6425: 
1.795     www      6426: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6427:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6428: }
                   6429: 
1.795     www      6430: a#LC_content_toolbar_changefolder {
1.911     bisitz   6431:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6432: }
                   6433: 
1.795     www      6434: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6435:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6436: }
                   6437: 
1.795     www      6438: ul#LC_toolbar li a:hover {
1.911     bisitz   6439:   background-position: bottom center;
1.757     schulted 6440: }
                   6441: 
1.795     www      6442: ul#LC_toolbar {
1.911     bisitz   6443:   padding: 0;
                   6444:   margin: 2px;
                   6445:   list-style:none;
                   6446:   position:relative;
                   6447:   background-color:white;
1.757     schulted 6448: }
                   6449: 
1.795     www      6450: ul#LC_toolbar li {
1.911     bisitz   6451:   border:1px solid white;
                   6452:   padding: 0;
                   6453:   margin: 0;
                   6454:   float: left;
                   6455:   display:inline;
                   6456:   vertical-align:middle;
                   6457: }
1.757     schulted 6458: 
1.783     amueller 6459: 
1.795     www      6460: a.LC_toolbarItem {
1.911     bisitz   6461:   display:block;
                   6462:   padding: 0;
                   6463:   margin: 0;
                   6464:   height: 32px;
                   6465:   width: 32px;
                   6466:   color:white;
                   6467:   border: none;
                   6468:   background-repeat:no-repeat;
                   6469:   background-color:transparent;
1.757     schulted 6470: }
                   6471: 
1.915     droeschl 6472: ul.LC_funclist {
                   6473:     margin: 0;
                   6474:     padding: 0.5em 1em 0.5em 0;
                   6475: }
                   6476: 
                   6477: ul.LC_funclist + ul.LC_funclist {
                   6478:     /* 
                   6479:        left border as a seperator if we have more than
                   6480:        one list 
                   6481:     */
                   6482:     border-left: 1px solid $sidebg;
                   6483:     /* 
                   6484:        this hides the left border behind the border of the 
                   6485:        outer box if element is wrapped to the next 'line' 
                   6486:     */
                   6487:     margin-left: -1px;
                   6488: }
                   6489: 
1.843     bisitz   6490: ul.LC_funclist li {
1.915     droeschl 6491:   display: inline;
1.782     bisitz   6492:   white-space: nowrap;
1.915     droeschl 6493:   margin: 0 0 0 25px;
                   6494:   line-height: 150%;
1.782     bisitz   6495: }
                   6496: 
1.757     schulted 6497: 
1.343     albertel 6498: END
                   6499: }
                   6500: 
1.306     albertel 6501: =pod
                   6502: 
                   6503: =item * &headtag()
                   6504: 
                   6505: Returns a uniform footer for LON-CAPA web pages.
                   6506: 
1.307     albertel 6507: Inputs: $title - optional title for the head
                   6508:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6509:         $args - optional arguments
1.319     albertel 6510:             force_register - if is true call registerurl so the remote is 
                   6511:                              informed
1.415     albertel 6512:             redirect       -> array ref of
                   6513:                                    1- seconds before redirect occurs
                   6514:                                    2- url to redirect to
                   6515:                                    3- whether the side effect should occur
1.315     albertel 6516:                            (side effect of setting 
                   6517:                                $env{'internal.head.redirect'} to the url 
                   6518:                                redirected too)
1.352     albertel 6519:             domain         -> force to color decorate a page for a specific
                   6520:                                domain
                   6521:             function       -> force usage of a specific rolish color scheme
                   6522:             bgcolor        -> override the default page bgcolor
1.460     albertel 6523:             no_auto_mt_title
                   6524:                            -> prevent &mt()ing the title arg
1.464     albertel 6525: 
1.306     albertel 6526: =cut
                   6527: 
                   6528: sub headtag {
1.313     albertel 6529:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6530:     
1.363     albertel 6531:     my $function = $args->{'function'} || &get_users_function();
                   6532:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6533:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6534:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6535: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6536: 		   #time(),
1.418     albertel 6537: 		   $env{'environment.color.timestamp'},
1.363     albertel 6538: 		   $function,$domain,$bgcolor);
                   6539: 
1.369     www      6540:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6541: 
1.308     albertel 6542:     my $result =
                   6543: 	'<head>'.
1.461     albertel 6544: 	&font_settings();
1.319     albertel 6545: 
1.461     albertel 6546:     if (!$args->{'frameset'}) {
                   6547: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6548:     }
1.319     albertel 6549:     if ($args->{'force_register'}) {
                   6550: 	$result .= &Apache::lonmenu::registerurl(1);
                   6551:     }
1.436     albertel 6552:     if (!$args->{'no_nav_bar'} 
                   6553: 	&& !$args->{'only_body'}
                   6554: 	&& !$args->{'frameset'}) {
                   6555: 	$result .= &help_menu_js();
                   6556:     }
1.319     albertel 6557: 
1.314     albertel 6558:     if (ref($args->{'redirect'})) {
1.414     albertel 6559: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6560: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6561: 	if (!$inhibit_continue) {
                   6562: 	    $env{'internal.head.redirect'} = $url;
                   6563: 	}
1.313     albertel 6564: 	$result.=<<ADDMETA
                   6565: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6566: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6567: ADDMETA
                   6568:     }
1.306     albertel 6569:     if (!defined($title)) {
                   6570: 	$title = 'The LearningOnline Network with CAPA';
                   6571:     }
1.460     albertel 6572:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6573:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6574: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6575: 	.$head_extra;
1.306     albertel 6576:     return $result;
                   6577: }
                   6578: 
                   6579: =pod
                   6580: 
1.340     albertel 6581: =item * &font_settings()
                   6582: 
                   6583: Returns neccessary <meta> to set the proper encoding
                   6584: 
                   6585: Inputs: none
                   6586: 
                   6587: =cut
                   6588: 
                   6589: sub font_settings {
                   6590:     my $headerstring='';
1.647     www      6591:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6592: 	$headerstring.=
                   6593: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6594:     }
                   6595:     return $headerstring;
                   6596: }
                   6597: 
1.341     albertel 6598: =pod
                   6599: 
                   6600: =item * &xml_begin()
                   6601: 
                   6602: Returns the needed doctype and <html>
                   6603: 
                   6604: Inputs: none
                   6605: 
                   6606: =cut
                   6607: 
                   6608: sub xml_begin {
                   6609:     my $output='';
                   6610: 
1.592     albertel 6611:     if ($env{'internal.start_page'}==1) {
                   6612: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6613:     }
1.342     albertel 6614: 
1.341     albertel 6615:     if ($env{'browser.mathml'}) {
                   6616: 	$output='<?xml version="1.0"?>'
                   6617:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6618: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6619:             
                   6620: #	    .'<!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">] >'
                   6621: 	    .'<!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">'
                   6622:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6623: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6624:     } else {
1.849     bisitz   6625: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6626:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6627:     }
                   6628:     return $output;
                   6629: }
1.340     albertel 6630: 
                   6631: =pod
                   6632: 
1.306     albertel 6633: =item * &endheadtag()
                   6634: 
                   6635: Returns a uniform </head> for LON-CAPA web pages.
                   6636: 
                   6637: Inputs: none
                   6638: 
                   6639: =cut
                   6640: 
                   6641: sub endheadtag {
                   6642:     return '</head>';
                   6643: }
                   6644: 
                   6645: =pod
                   6646: 
                   6647: =item * &head()
                   6648: 
                   6649: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6650: 
1.648     raeburn  6651: Inputs:
                   6652: 
                   6653: =over 4
                   6654: 
                   6655: $title - optional title for the page
                   6656: 
                   6657: $head_extra - optional extra HTML to put inside the <head>
                   6658: 
                   6659: =back
1.405     albertel 6660: 
1.306     albertel 6661: =cut
                   6662: 
                   6663: sub head {
1.325     albertel 6664:     my ($title,$head_extra,$args) = @_;
                   6665:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6666: }
                   6667: 
                   6668: =pod
                   6669: 
                   6670: =item * &start_page()
                   6671: 
                   6672: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6673: 
1.648     raeburn  6674: Inputs:
                   6675: 
                   6676: =over 4
                   6677: 
                   6678: $title - optional title for the page
                   6679: 
                   6680: $head_extra - optional extra HTML to incude inside the <head>
                   6681: 
                   6682: $args - additional optional args supported are:
                   6683: 
                   6684: =over 8
                   6685: 
                   6686:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6687:                                     arg on
1.814     bisitz   6688:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6689:              add_entries    -> additional attributes to add to the  <body>
                   6690:              domain         -> force to color decorate a page for a 
1.317     albertel 6691:                                     specific domain
1.648     raeburn  6692:              function       -> force usage of a specific rolish color
1.317     albertel 6693:                                     scheme
1.648     raeburn  6694:              redirect       -> see &headtag()
                   6695:              bgcolor        -> override the default page bg color
                   6696:              js_ready       -> return a string ready for being used in 
1.317     albertel 6697:                                     a javascript writeln
1.648     raeburn  6698:              html_encode    -> return a string ready for being used in 
1.320     albertel 6699:                                     a html attribute
1.648     raeburn  6700:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6701:                                     $forcereg arg
1.648     raeburn  6702:              frameset       -> if true will start with a <frameset>
1.330     albertel 6703:                                     rather than <body>
1.648     raeburn  6704:              skip_phases    -> hash ref of 
1.338     albertel 6705:                                     head -> skip the <html><head> generation
                   6706:                                     body -> skip all <body> generation
1.648     raeburn  6707:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6708:                                     'Switch To Inline Menu' link
1.648     raeburn  6709:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6710:              inherit_jsmath -> when creating popup window in a page,
                   6711:                                     should it have jsmath forced on by the
                   6712:                                     current page
1.867     kalberla 6713:              bread_crumbs ->             Array containing breadcrumbs
                   6714:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6715: 
1.648     raeburn  6716: =back
1.460     albertel 6717: 
1.648     raeburn  6718: =back
1.562     albertel 6719: 
1.306     albertel 6720: =cut
                   6721: 
                   6722: sub start_page {
1.309     albertel 6723:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6724:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6725:     my %head_args;
1.352     albertel 6726:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6727: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6728: 		     'no_auto_mt_title') {
1.319     albertel 6729: 	if (defined($args->{$arg})) {
1.324     raeburn  6730: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6731: 	}
1.313     albertel 6732:     }
1.319     albertel 6733: 
1.315     albertel 6734:     $env{'internal.start_page'}++;
1.338     albertel 6735:     my $result;
                   6736:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6737: 	$result.=
1.341     albertel 6738: 	    &xml_begin().
1.338     albertel 6739: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6740:     }
                   6741:     
                   6742:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6743: 	if ($args->{'frameset'}) {
                   6744: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6745: 						$args->{'add_entries'});
                   6746: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6747:         } else {
                   6748:             $result .=
                   6749:                 &bodytag($title, 
                   6750:                          $args->{'function'},       $args->{'add_entries'},
                   6751:                          $args->{'only_body'},      $args->{'domain'},
                   6752:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6753:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6754:                          $args);
                   6755:         }
1.330     albertel 6756:     }
1.338     albertel 6757: 
1.315     albertel 6758:     if ($args->{'js_ready'}) {
1.713     kaisler  6759: 		$result = &js_ready($result);
1.315     albertel 6760:     }
1.320     albertel 6761:     if ($args->{'html_encode'}) {
1.713     kaisler  6762: 		$result = &html_encode($result);
                   6763:     }
                   6764: 
1.813     bisitz   6765:     # Preparation for new and consistent functionlist at top of screen
                   6766:     # if ($args->{'functionlist'}) {
                   6767:     #            $result .= &build_functionlist();
                   6768:     #}
                   6769: 
                   6770:     # Don't add anything more if only_body wanted
                   6771:     return $result if $args->{'only_body'};
                   6772: 
                   6773:     #Breadcrumbs
1.758     kaisler  6774:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6775: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6776: 		#if any br links exists, add them to the breadcrumbs
                   6777: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6778: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6779: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6780: 			}
                   6781: 		}
                   6782: 
                   6783: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6784: 		if(exists($args->{'bread_crumbs_component'})){
                   6785: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6786: 		}else{
                   6787: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6788: 		}
1.320     albertel 6789:     }
1.315     albertel 6790:     return $result;
1.306     albertel 6791: }
                   6792: 
1.330     albertel 6793: 
1.306     albertel 6794: =pod
                   6795: 
                   6796: =item * &head()
                   6797: 
                   6798: Returns a complete </body></html> section for LON-CAPA web pages.
                   6799: 
1.315     albertel 6800: Inputs:         $args - additional optional args supported are:
                   6801:                  js_ready     -> return a string ready for being used in 
                   6802:                                  a javascript writeln
1.320     albertel 6803:                  html_encode  -> return a string ready for being used in 
                   6804:                                  a html attribute
1.330     albertel 6805:                  frameset     -> if true will start with a <frameset>
                   6806:                                  rather than <body>
1.493     albertel 6807:                  dicsussion   -> if true will get discussion from
                   6808:                                   lonxml::xmlend
                   6809:                                  (you can pass the target and parser arguments
                   6810:                                   through optional 'target' and 'parser' args
                   6811:                                   to this routine)
1.306     albertel 6812: 
                   6813: =cut
                   6814: 
                   6815: sub end_page {
1.315     albertel 6816:     my ($args) = @_;
                   6817:     $env{'internal.end_page'}++;
1.330     albertel 6818:     my $result;
1.335     albertel 6819:     if ($args->{'discussion'}) {
                   6820: 	my ($target,$parser);
                   6821: 	if (ref($args->{'discussion'})) {
                   6822: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6823: 				$args->{'discussion'}{'parser'});
                   6824: 	}
                   6825: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6826:     }
                   6827: 
1.330     albertel 6828:     if ($args->{'frameset'}) {
                   6829: 	$result .= '</frameset>';
                   6830:     } else {
1.635     raeburn  6831: 	$result .= &endbodytag($args);
1.330     albertel 6832:     }
                   6833:     $result .= "\n</html>";
                   6834: 
1.315     albertel 6835:     if ($args->{'js_ready'}) {
1.317     albertel 6836: 	$result = &js_ready($result);
1.315     albertel 6837:     }
1.335     albertel 6838: 
1.320     albertel 6839:     if ($args->{'html_encode'}) {
                   6840: 	$result = &html_encode($result);
                   6841:     }
1.335     albertel 6842: 
1.315     albertel 6843:     return $result;
                   6844: }
                   6845: 
1.320     albertel 6846: sub html_encode {
                   6847:     my ($result) = @_;
                   6848: 
1.322     albertel 6849:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6850:     
                   6851:     return $result;
                   6852: }
1.317     albertel 6853: sub js_ready {
                   6854:     my ($result) = @_;
                   6855: 
1.323     albertel 6856:     $result =~ s/[\n\r]/ /xmsg;
                   6857:     $result =~ s/\\/\\\\/xmsg;
                   6858:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6859:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6860:     
                   6861:     return $result;
                   6862: }
                   6863: 
1.315     albertel 6864: sub validate_page {
                   6865:     if (  exists($env{'internal.start_page'})
1.316     albertel 6866: 	  &&     $env{'internal.start_page'} > 1) {
                   6867: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6868: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6869: 				 $ENV{'request.filename'});
1.315     albertel 6870:     }
                   6871:     if (  exists($env{'internal.end_page'})
1.316     albertel 6872: 	  &&     $env{'internal.end_page'} > 1) {
                   6873: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6874: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6875: 				 $env{'request.filename'});
1.315     albertel 6876:     }
                   6877:     if (     exists($env{'internal.start_page'})
                   6878: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6879: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6880: 				 $env{'request.filename'});
1.315     albertel 6881:     }
                   6882:     if (   ! exists($env{'internal.start_page'})
                   6883: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6884: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6885: 				 $env{'request.filename'});
1.315     albertel 6886:     }
1.306     albertel 6887: }
1.315     albertel 6888: 
1.318     albertel 6889: sub simple_error_page {
                   6890:     my ($r,$title,$msg) = @_;
                   6891:     my $page =
                   6892: 	&Apache::loncommon::start_page($title).
                   6893: 	&mt($msg).
                   6894: 	&Apache::loncommon::end_page();
                   6895:     if (ref($r)) {
                   6896: 	$r->print($page);
1.327     albertel 6897: 	return;
1.318     albertel 6898:     }
                   6899:     return $page;
                   6900: }
1.347     albertel 6901: 
                   6902: {
1.610     albertel 6903:     my @row_count;
1.347     albertel 6904:     sub start_data_table {
1.422     albertel 6905: 	my ($add_class) = @_;
                   6906: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6907: 	unshift(@row_count,0);
1.422     albertel 6908: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6909:     }
                   6910: 
                   6911:     sub end_data_table {
1.610     albertel 6912: 	shift(@row_count);
1.389     albertel 6913: 	return '</table>'."\n";;
1.347     albertel 6914:     }
                   6915: 
                   6916:     sub start_data_table_row {
1.422     albertel 6917: 	my ($add_class) = @_;
1.610     albertel 6918: 	$row_count[0]++;
                   6919: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6920: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 6921: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6922:     }
1.471     banghart 6923:     
                   6924:     sub continue_data_table_row {
                   6925: 	my ($add_class) = @_;
1.610     albertel 6926: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6927: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 6928: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6929:     }
1.347     albertel 6930: 
                   6931:     sub end_data_table_row {
1.389     albertel 6932: 	return '</tr>'."\n";;
1.347     albertel 6933:     }
1.367     www      6934: 
1.421     albertel 6935:     sub start_data_table_empty_row {
1.707     bisitz   6936: #	$row_count[0]++;
1.421     albertel 6937: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6938:     }
                   6939: 
                   6940:     sub end_data_table_empty_row {
                   6941: 	return '</tr>'."\n";;
                   6942:     }
                   6943: 
1.367     www      6944:     sub start_data_table_header_row {
1.389     albertel 6945: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6946:     }
                   6947: 
                   6948:     sub end_data_table_header_row {
1.389     albertel 6949: 	return '</tr>'."\n";;
1.367     www      6950:     }
1.890     droeschl 6951: 
                   6952:     sub data_table_caption {
                   6953:         my $caption = shift;
                   6954:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6955:     }
1.347     albertel 6956: }
                   6957: 
1.548     albertel 6958: =pod
                   6959: 
                   6960: =item * &inhibit_menu_check($arg)
                   6961: 
                   6962: Checks for a inhibitmenu state and generates output to preserve it
                   6963: 
                   6964: Inputs:         $arg - can be any of
                   6965:                      - undef - in which case the return value is a string 
                   6966:                                to add  into arguments list of a uri
                   6967:                      - 'input' - in which case the return value is a HTML
                   6968:                                  <form> <input> field of type hidden to
                   6969:                                  preserve the value
                   6970:                      - a url - in which case the return value is the url with
                   6971:                                the neccesary cgi args added to preserve the
                   6972:                                inhibitmenu state
                   6973:                      - a ref to a url - no return value, but the string is
                   6974:                                         updated to include the neccessary cgi
                   6975:                                         args to preserve the inhibitmenu state
                   6976: 
                   6977: =cut
                   6978: 
                   6979: sub inhibit_menu_check {
                   6980:     my ($arg) = @_;
                   6981:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6982:     if ($arg eq 'input') {
                   6983: 	if ($env{'form.inhibitmenu'}) {
                   6984: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6985: 	} else {
                   6986: 	    return
                   6987: 	}
                   6988:     }
                   6989:     if ($env{'form.inhibitmenu'}) {
                   6990: 	if (ref($arg)) {
                   6991: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6992: 	} elsif ($arg eq '') {
                   6993: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6994: 	} else {
                   6995: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6996: 	}
                   6997:     }
                   6998:     if (!ref($arg)) {
                   6999: 	return $arg;
                   7000:     }
                   7001: }
                   7002: 
1.251     albertel 7003: ###############################################
1.182     matthew  7004: 
                   7005: =pod
                   7006: 
1.549     albertel 7007: =back
                   7008: 
                   7009: =head1 User Information Routines
                   7010: 
                   7011: =over 4
                   7012: 
1.405     albertel 7013: =item * &get_users_function()
1.182     matthew  7014: 
                   7015: Used by &bodytag to determine the current users primary role.
                   7016: Returns either 'student','coordinator','admin', or 'author'.
                   7017: 
                   7018: =cut
                   7019: 
                   7020: ###############################################
                   7021: sub get_users_function {
1.815     tempelho 7022:     my $function = 'norole';
1.818     tempelho 7023:     if ($env{'request.role'}=~/^(st)/) {
                   7024:         $function='student';
                   7025:     }
1.907     raeburn  7026:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  7027:         $function='coordinator';
                   7028:     }
1.258     albertel 7029:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  7030:         $function='admin';
                   7031:     }
1.826     bisitz   7032:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  7033:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   7034:         $function='author';
                   7035:     }
                   7036:     return $function;
1.54      www      7037: }
1.99      www      7038: 
                   7039: ###############################################
                   7040: 
1.233     raeburn  7041: =pod
                   7042: 
1.821     raeburn  7043: =item * &show_course()
                   7044: 
                   7045: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7046: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7047: 
                   7048: Inputs:
                   7049: None
                   7050: 
                   7051: Outputs:
                   7052: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7053: 
                   7054: =cut
                   7055: 
                   7056: ###############################################
                   7057: sub show_course {
                   7058:     my $course = !$env{'user.adv'};
                   7059:     if (!$env{'user.adv'}) {
                   7060:         foreach my $env (keys(%env)) {
                   7061:             next if ($env !~ m/^user\.priv\./);
                   7062:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7063:                 $course = 0;
                   7064:                 last;
                   7065:             }
                   7066:         }
                   7067:     }
                   7068:     return $course;
                   7069: }
                   7070: 
                   7071: ###############################################
                   7072: 
                   7073: =pod
                   7074: 
1.542     raeburn  7075: =item * &check_user_status()
1.274     raeburn  7076: 
                   7077: Determines current status of supplied role for a
                   7078: specific user. Roles can be active, previous or future.
                   7079: 
                   7080: Inputs: 
                   7081: user's domain, user's username, course's domain,
1.375     raeburn  7082: course's number, optional section ID.
1.274     raeburn  7083: 
                   7084: Outputs:
                   7085: role status: active, previous or future. 
                   7086: 
                   7087: =cut
                   7088: 
                   7089: sub check_user_status {
1.412     raeburn  7090:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7091:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7092:     my @uroles = keys %userinfo;
                   7093:     my $srchstr;
                   7094:     my $active_chk = 'none';
1.412     raeburn  7095:     my $now = time;
1.274     raeburn  7096:     if (@uroles > 0) {
1.908     raeburn  7097:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7098:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7099:         } else {
1.412     raeburn  7100:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7101:         }
                   7102:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7103:             my $role_end = 0;
                   7104:             my $role_start = 0;
                   7105:             $active_chk = 'active';
1.412     raeburn  7106:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7107:                 $role_end = $1;
                   7108:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7109:                     $role_start = $1;
1.274     raeburn  7110:                 }
                   7111:             }
                   7112:             if ($role_start > 0) {
1.412     raeburn  7113:                 if ($now < $role_start) {
1.274     raeburn  7114:                     $active_chk = 'future';
                   7115:                 }
                   7116:             }
                   7117:             if ($role_end > 0) {
1.412     raeburn  7118:                 if ($now > $role_end) {
1.274     raeburn  7119:                     $active_chk = 'previous';
                   7120:                 }
                   7121:             }
                   7122:         }
                   7123:     }
                   7124:     return $active_chk;
                   7125: }
                   7126: 
                   7127: ###############################################
                   7128: 
                   7129: =pod
                   7130: 
1.405     albertel 7131: =item * &get_sections()
1.233     raeburn  7132: 
                   7133: Determines all the sections for a course including
                   7134: sections with students and sections containing other roles.
1.419     raeburn  7135: Incoming parameters: 
                   7136: 
                   7137: 1. domain
                   7138: 2. course number 
                   7139: 3. reference to array containing roles for which sections should 
                   7140: be gathered (optional).
                   7141: 4. reference to array containing status types for which sections 
                   7142: should be gathered (optional).
                   7143: 
                   7144: If the third argument is undefined, sections are gathered for any role. 
                   7145: If the fourth argument is undefined, sections are gathered for any status.
                   7146: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7147:  
1.374     raeburn  7148: Returns section hash (keys are section IDs, values are
                   7149: number of users in each section), subject to the
1.419     raeburn  7150: optional roles filter, optional status filter 
1.233     raeburn  7151: 
                   7152: =cut
                   7153: 
                   7154: ###############################################
                   7155: sub get_sections {
1.419     raeburn  7156:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7157:     if (!defined($cdom) || !defined($cnum)) {
                   7158:         my $cid =  $env{'request.course.id'};
                   7159: 
                   7160: 	return if (!defined($cid));
                   7161: 
                   7162:         $cdom = $env{'course.'.$cid.'.domain'};
                   7163:         $cnum = $env{'course.'.$cid.'.num'};
                   7164:     }
                   7165: 
                   7166:     my %sectioncount;
1.419     raeburn  7167:     my $now = time;
1.240     albertel 7168: 
1.366     albertel 7169:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7170: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7171: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7172: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7173:         my $start_index = &Apache::loncoursedata::CL_START();
                   7174:         my $end_index = &Apache::loncoursedata::CL_END();
                   7175:         my $status;
1.366     albertel 7176: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7177: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7178: 				                     $data->[$status_index],
                   7179:                                                      $data->[$start_index],
                   7180:                                                      $data->[$end_index]);
                   7181:             if ($stu_status eq 'Active') {
                   7182:                 $status = 'active';
                   7183:             } elsif ($end < $now) {
                   7184:                 $status = 'previous';
                   7185:             } elsif ($start > $now) {
                   7186:                 $status = 'future';
                   7187:             } 
                   7188: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7189:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7190:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7191: 		    $sectioncount{$section}++;
                   7192:                 }
1.240     albertel 7193: 	    }
                   7194: 	}
                   7195:     }
                   7196:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7197:     foreach my $user (sort(keys(%courseroles))) {
                   7198: 	if ($user !~ /^(\w{2})/) { next; }
                   7199: 	my ($role) = ($user =~ /^(\w{2})/);
                   7200: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7201: 	my ($section,$status);
1.240     albertel 7202: 	if ($role eq 'cr' &&
                   7203: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7204: 	    $section=$1;
                   7205: 	}
                   7206: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7207: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7208:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7209:         if ($end == -1 && $start == -1) {
                   7210:             next; #deleted role
                   7211:         }
                   7212:         if (!defined($possible_status)) { 
                   7213:             $sectioncount{$section}++;
                   7214:         } else {
                   7215:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7216:                 $status = 'active';
                   7217:             } elsif ($end < $now) {
                   7218:                 $status = 'future';
                   7219:             } elsif ($start > $now) {
                   7220:                 $status = 'previous';
                   7221:             }
                   7222:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7223:                 $sectioncount{$section}++;
                   7224:             }
                   7225:         }
1.233     raeburn  7226:     }
1.366     albertel 7227:     return %sectioncount;
1.233     raeburn  7228: }
                   7229: 
1.274     raeburn  7230: ###############################################
1.294     raeburn  7231: 
                   7232: =pod
1.405     albertel 7233: 
                   7234: =item * &get_course_users()
                   7235: 
1.275     raeburn  7236: Retrieves usernames:domains for users in the specified course
                   7237: with specific role(s), and access status. 
                   7238: 
                   7239: Incoming parameters:
1.277     albertel 7240: 1. course domain
                   7241: 2. course number
                   7242: 3. access status: users must have - either active, 
1.275     raeburn  7243: previous, future, or all.
1.277     albertel 7244: 4. reference to array of permissible roles
1.288     raeburn  7245: 5. reference to array of section restrictions (optional)
                   7246: 6. reference to results object (hash of hashes).
                   7247: 7. reference to optional userdata hash
1.609     raeburn  7248: 8. reference to optional statushash
1.630     raeburn  7249: 9. flag if privileged users (except those set to unhide in
                   7250:    course settings) should be excluded    
1.609     raeburn  7251: Keys of top level results hash are roles.
1.275     raeburn  7252: Keys of inner hashes are username:domain, with 
                   7253: values set to access type.
1.288     raeburn  7254: Optional userdata hash returns an array with arguments in the 
                   7255: same order as loncoursedata::get_classlist() for student data.
                   7256: 
1.609     raeburn  7257: Optional statushash returns
                   7258: 
1.288     raeburn  7259: Entries for end, start, section and status are blank because
                   7260: of the possibility of multiple values for non-student roles.
                   7261: 
1.275     raeburn  7262: =cut
1.405     albertel 7263: 
1.275     raeburn  7264: ###############################################
1.405     albertel 7265: 
1.275     raeburn  7266: sub get_course_users {
1.630     raeburn  7267:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7268:     my %idx = ();
1.419     raeburn  7269:     my %seclists;
1.288     raeburn  7270: 
                   7271:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7272:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7273:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7274:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7275:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7276:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7277:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7278:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7279: 
1.290     albertel 7280:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7281:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7282:         my $now = time;
1.277     albertel 7283:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7284:             my $match = 0;
1.412     raeburn  7285:             my $secmatch = 0;
1.419     raeburn  7286:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7287:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7288:             if ($section eq '') {
                   7289:                 $section = 'none';
                   7290:             }
1.291     albertel 7291:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7292:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7293:                     $secmatch = 1;
                   7294:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7295:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7296:                         $secmatch = 1;
                   7297:                     }
                   7298:                 } else {  
1.419     raeburn  7299: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7300: 		        $secmatch = 1;
                   7301:                     }
1.290     albertel 7302: 		}
1.412     raeburn  7303:                 if (!$secmatch) {
                   7304:                     next;
                   7305:                 }
1.419     raeburn  7306:             }
1.275     raeburn  7307:             if (defined($$types{'active'})) {
1.288     raeburn  7308:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7309:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7310:                     $match = 1;
1.275     raeburn  7311:                 }
                   7312:             }
                   7313:             if (defined($$types{'previous'})) {
1.609     raeburn  7314:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7315:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7316:                     $match = 1;
1.275     raeburn  7317:                 }
                   7318:             }
                   7319:             if (defined($$types{'future'})) {
1.609     raeburn  7320:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7321:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7322:                     $match = 1;
1.275     raeburn  7323:                 }
                   7324:             }
1.609     raeburn  7325:             if ($match) {
                   7326:                 push(@{$seclists{$student}},$section);
                   7327:                 if (ref($userdata) eq 'HASH') {
                   7328:                     $$userdata{$student} = $$classlist{$student};
                   7329:                 }
                   7330:                 if (ref($statushash) eq 'HASH') {
                   7331:                     $statushash->{$student}{'st'}{$section} = $status;
                   7332:                 }
1.288     raeburn  7333:             }
1.275     raeburn  7334:         }
                   7335:     }
1.412     raeburn  7336:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7337:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7338:         my $now = time;
1.609     raeburn  7339:         my %displaystatus = ( previous => 'Expired',
                   7340:                               active   => 'Active',
                   7341:                               future   => 'Future',
                   7342:                             );
1.630     raeburn  7343:         my %nothide;
                   7344:         if ($hidepriv) {
                   7345:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7346:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7347:                 if ($user !~ /:/) {
                   7348:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7349:                 } else {
                   7350:                     $nothide{$user} = 1;
                   7351:                 }
                   7352:             }
                   7353:         }
1.439     raeburn  7354:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7355:             my $match = 0;
1.412     raeburn  7356:             my $secmatch = 0;
1.439     raeburn  7357:             my $status;
1.412     raeburn  7358:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7359:             $user =~ s/:$//;
1.439     raeburn  7360:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7361:             if ($end == -1 || $start == -1) {
                   7362:                 next;
                   7363:             }
                   7364:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7365:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7366:                 my ($uname,$udom) = split(/:/,$user);
                   7367:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7368:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7369:                         $secmatch = 1;
                   7370:                     } elsif ($usec eq '') {
1.420     albertel 7371:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7372:                             $secmatch = 1;
                   7373:                         }
                   7374:                     } else {
                   7375:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7376:                             $secmatch = 1;
                   7377:                         }
                   7378:                     }
                   7379:                     if (!$secmatch) {
                   7380:                         next;
                   7381:                     }
1.288     raeburn  7382:                 }
1.419     raeburn  7383:                 if ($usec eq '') {
                   7384:                     $usec = 'none';
                   7385:                 }
1.275     raeburn  7386:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7387:                     if ($hidepriv) {
                   7388:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7389:                             (!$nothide{$uname.':'.$udom})) {
                   7390:                             next;
                   7391:                         }
                   7392:                     }
1.503     raeburn  7393:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7394:                         $status = 'previous';
                   7395:                     } elsif ($start > $now) {
                   7396:                         $status = 'future';
                   7397:                     } else {
                   7398:                         $status = 'active';
                   7399:                     }
1.277     albertel 7400:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7401:                         if ($status eq $type) {
1.420     albertel 7402:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7403:                                 push(@{$$users{$role}{$user}},$type);
                   7404:                             }
1.288     raeburn  7405:                             $match = 1;
                   7406:                         }
                   7407:                     }
1.419     raeburn  7408:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7409:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7410: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7411:                         }
1.420     albertel 7412:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7413:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7414:                         }
1.609     raeburn  7415:                         if (ref($statushash) eq 'HASH') {
                   7416:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7417:                         }
1.275     raeburn  7418:                     }
                   7419:                 }
                   7420:             }
                   7421:         }
1.290     albertel 7422:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7423:             if ((defined($cdom)) && (defined($cnum))) {
                   7424:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7425:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7426:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7427:                     next if ($owner eq '');
                   7428:                     my ($ownername,$ownerdom);
                   7429:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7430:                         $ownername = $1;
                   7431:                         $ownerdom = $2;
                   7432:                     } else {
                   7433:                         $ownername = $owner;
                   7434:                         $ownerdom = $cdom;
                   7435:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7436:                     }
                   7437:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7438:                     if (defined($userdata) && 
1.609     raeburn  7439: 			!exists($$userdata{$owner})) {
                   7440: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7441:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7442:                             push(@{$seclists{$owner}},'none');
                   7443:                         }
                   7444:                         if (ref($statushash) eq 'HASH') {
                   7445:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7446:                         }
1.290     albertel 7447: 		    }
1.279     raeburn  7448:                 }
                   7449:             }
                   7450:         }
1.419     raeburn  7451:         foreach my $user (keys(%seclists)) {
                   7452:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7453:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7454:         }
1.275     raeburn  7455:     }
                   7456:     return;
                   7457: }
                   7458: 
1.288     raeburn  7459: sub get_user_info {
                   7460:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7461:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7462: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7463:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7464:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7465:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7466:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7467:     return;
                   7468: }
1.275     raeburn  7469: 
1.472     raeburn  7470: ###############################################
                   7471: 
                   7472: =pod
                   7473: 
                   7474: =item * &get_user_quota()
                   7475: 
                   7476: Retrieves quota assigned for storage of portfolio files for a user  
                   7477: 
                   7478: Incoming parameters:
                   7479: 1. user's username
                   7480: 2. user's domain
                   7481: 
                   7482: Returns:
1.536     raeburn  7483: 1. Disk quota (in Mb) assigned to student.
                   7484: 2. (Optional) Type of setting: custom or default
                   7485:    (individually assigned or default for user's 
                   7486:    institutional status).
                   7487: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7488:    or student - types as defined in localenroll::inst_usertypes 
                   7489:    for user's domain, which determines default quota for user.
                   7490: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7491: 
                   7492: If a value has been stored in the user's environment, 
1.536     raeburn  7493: it will return that, otherwise it returns the maximal default
                   7494: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7495: 
                   7496: =cut
                   7497: 
                   7498: ###############################################
                   7499: 
                   7500: 
                   7501: sub get_user_quota {
                   7502:     my ($uname,$udom) = @_;
1.536     raeburn  7503:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7504:     if (!defined($udom)) {
                   7505:         $udom = $env{'user.domain'};
                   7506:     }
                   7507:     if (!defined($uname)) {
                   7508:         $uname = $env{'user.name'};
                   7509:     }
                   7510:     if (($udom eq '' || $uname eq '') ||
                   7511:         ($udom eq 'public') && ($uname eq 'public')) {
                   7512:         $quota = 0;
1.536     raeburn  7513:         $quotatype = 'default';
                   7514:         $defquota = 0; 
1.472     raeburn  7515:     } else {
1.536     raeburn  7516:         my $inststatus;
1.472     raeburn  7517:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7518:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7519:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7520:         } else {
1.536     raeburn  7521:             my %userenv = 
                   7522:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7523:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7524:             my ($tmp) = keys(%userenv);
                   7525:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7526:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7527:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7528:             } else {
                   7529:                 undef(%userenv);
                   7530:             }
                   7531:         }
1.536     raeburn  7532:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7533:         if ($quota eq '') {
1.536     raeburn  7534:             $quota = $defquota;
                   7535:             $quotatype = 'default';
                   7536:         } else {
                   7537:             $quotatype = 'custom';
1.472     raeburn  7538:         }
                   7539:     }
1.536     raeburn  7540:     if (wantarray) {
                   7541:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7542:     } else {
                   7543:         return $quota;
                   7544:     }
1.472     raeburn  7545: }
                   7546: 
                   7547: ###############################################
                   7548: 
                   7549: =pod
                   7550: 
                   7551: =item * &default_quota()
                   7552: 
1.536     raeburn  7553: Retrieves default quota assigned for storage of user portfolio files,
                   7554: given an (optional) user's institutional status.
1.472     raeburn  7555: 
                   7556: Incoming parameters:
                   7557: 1. domain
1.536     raeburn  7558: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7559:    status types (e.g., faculty, staff, student etc.)
                   7560:    which apply to the user for whom the default is being retrieved.
                   7561:    If the institutional status string in undefined, the domain
                   7562:    default quota will be returned. 
1.472     raeburn  7563: 
                   7564: Returns:
                   7565: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7566: 2. (Optional) institutional type which determined the value of the
                   7567:    default quota.
1.472     raeburn  7568: 
                   7569: If a value has been stored in the domain's configuration db,
                   7570: it will return that, otherwise it returns 20 (for backwards 
                   7571: compatibility with domains which have not set up a configuration
                   7572: db file; the original statically defined portfolio quota was 20 Mb). 
                   7573: 
1.536     raeburn  7574: If the user's status includes multiple types (e.g., staff and student),
                   7575: the largest default quota which applies to the user determines the
                   7576: default quota returned.
                   7577: 
1.780     raeburn  7578: =back
                   7579: 
1.472     raeburn  7580: =cut
                   7581: 
                   7582: ###############################################
                   7583: 
                   7584: 
                   7585: sub default_quota {
1.536     raeburn  7586:     my ($udom,$inststatus) = @_;
                   7587:     my ($defquota,$settingstatus);
                   7588:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7589:                                             ['quotas'],$udom);
                   7590:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7591:         if ($inststatus ne '') {
1.765     raeburn  7592:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7593:             foreach my $item (@statuses) {
1.711     raeburn  7594:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7595:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7596:                         if ($defquota eq '') {
                   7597:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7598:                             $settingstatus = $item;
                   7599:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7600:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7601:                             $settingstatus = $item;
                   7602:                         }
                   7603:                     }
                   7604:                 } else {
                   7605:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7606:                         if ($defquota eq '') {
                   7607:                             $defquota = $quotahash{'quotas'}{$item};
                   7608:                             $settingstatus = $item;
                   7609:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7610:                             $defquota = $quotahash{'quotas'}{$item};
                   7611:                             $settingstatus = $item;
                   7612:                         }
1.536     raeburn  7613:                     }
                   7614:                 }
                   7615:             }
                   7616:         }
                   7617:         if ($defquota eq '') {
1.711     raeburn  7618:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7619:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7620:             } else {
                   7621:                 $defquota = $quotahash{'quotas'}{'default'};
                   7622:             }
1.536     raeburn  7623:             $settingstatus = 'default';
                   7624:         }
                   7625:     } else {
                   7626:         $settingstatus = 'default';
                   7627:         $defquota = 20;
                   7628:     }
                   7629:     if (wantarray) {
                   7630:         return ($defquota,$settingstatus);
1.472     raeburn  7631:     } else {
1.536     raeburn  7632:         return $defquota;
1.472     raeburn  7633:     }
                   7634: }
                   7635: 
1.384     raeburn  7636: sub get_secgrprole_info {
                   7637:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7638:     my %sections_count = &get_sections($cdom,$cnum);
                   7639:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7640:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7641:     my @groups = sort(keys(%curr_groups));
                   7642:     my $allroles = [];
                   7643:     my $rolehash;
                   7644:     my $accesshash = {
                   7645:                      active => 'Currently has access',
                   7646:                      future => 'Will have future access',
                   7647:                      previous => 'Previously had access',
                   7648:                   };
                   7649:     if ($needroles) {
                   7650:         $rolehash = {'all' => 'all'};
1.385     albertel 7651:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7652: 	if (&Apache::lonnet::error(%user_roles)) {
                   7653: 	    undef(%user_roles);
                   7654: 	}
                   7655:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7656:             my ($role)=split(/\:/,$item,2);
                   7657:             if ($role eq 'cr') { next; }
                   7658:             if ($role =~ /^cr/) {
                   7659:                 $$rolehash{$role} = (split('/',$role))[3];
                   7660:             } else {
                   7661:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7662:             }
                   7663:         }
                   7664:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7665:             push(@{$allroles},$key);
                   7666:         }
                   7667:         push (@{$allroles},'st');
                   7668:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7669:     }
                   7670:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7671: }
                   7672: 
1.555     raeburn  7673: sub user_picker {
1.627     raeburn  7674:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7675:     my $currdom = $dom;
                   7676:     my %curr_selected = (
                   7677:                         srchin => 'dom',
1.580     raeburn  7678:                         srchby => 'lastname',
1.555     raeburn  7679:                       );
                   7680:     my $srchterm;
1.625     raeburn  7681:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7682:         if ($srch->{'srchby'} ne '') {
                   7683:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7684:         }
                   7685:         if ($srch->{'srchin'} ne '') {
                   7686:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7687:         }
                   7688:         if ($srch->{'srchtype'} ne '') {
                   7689:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7690:         }
                   7691:         if ($srch->{'srchdomain'} ne '') {
                   7692:             $currdom = $srch->{'srchdomain'};
                   7693:         }
                   7694:         $srchterm = $srch->{'srchterm'};
                   7695:     }
                   7696:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7697:                     'usr'       => 'Search criteria',
1.563     raeburn  7698:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7699:                     'uname'     => 'username',
                   7700:                     'lastname'  => 'last name',
1.555     raeburn  7701:                     'lastfirst' => 'last name, first name',
1.558     albertel 7702:                     'crs'       => 'in this course',
1.576     raeburn  7703:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7704:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7705:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7706:                     'exact'     => 'is',
                   7707:                     'contains'  => 'contains',
1.569     raeburn  7708:                     'begins'    => 'begins with',
1.571     raeburn  7709:                     'youm'      => "You must include some text to search for.",
                   7710:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7711:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7712:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7713:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7714:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7715:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7716:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7717:                                        );
1.563     raeburn  7718:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7719:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7720: 
                   7721:     my @srchins = ('crs','dom','alc','instd');
                   7722: 
                   7723:     foreach my $option (@srchins) {
                   7724:         # FIXME 'alc' option unavailable until 
                   7725:         #       loncreateuser::print_user_query_page()
                   7726:         #       has been completed.
                   7727:         next if ($option eq 'alc');
1.880     raeburn  7728:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7729:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7730:         if ($curr_selected{'srchin'} eq $option) {
                   7731:             $srchinsel .= ' 
                   7732:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7733:         } else {
                   7734:             $srchinsel .= '
                   7735:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7736:         }
1.555     raeburn  7737:     }
1.563     raeburn  7738:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7739: 
                   7740:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7741:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7742:         if ($curr_selected{'srchby'} eq $option) {
                   7743:             $srchbysel .= '
                   7744:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7745:         } else {
                   7746:             $srchbysel .= '
                   7747:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7748:          }
                   7749:     }
                   7750:     $srchbysel .= "\n  </select>\n";
                   7751: 
                   7752:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7753:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7754:         if ($curr_selected{'srchtype'} eq $option) {
                   7755:             $srchtypesel .= '
                   7756:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7757:         } else {
                   7758:             $srchtypesel .= '
                   7759:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7760:         }
                   7761:     }
                   7762:     $srchtypesel .= "\n  </select>\n";
                   7763: 
1.558     albertel 7764:     my ($newuserscript,$new_user_create);
1.556     raeburn  7765: 
                   7766:     if ($forcenewuser) {
1.576     raeburn  7767:         if (ref($srch) eq 'HASH') {
                   7768:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7769:                 if ($cancreate) {
                   7770:                     $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>';
                   7771:                 } else {
1.799     bisitz   7772:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7773:                     my %usertypetext = (
                   7774:                         official   => 'institutional',
                   7775:                         unofficial => 'non-institutional',
                   7776:                     );
1.799     bisitz   7777:                     $new_user_create = '<p class="LC_warning">'
                   7778:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7779:                                       .' '
                   7780:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7781:                                           ,'<a href="'.$helplink.'">','</a>')
                   7782:                                       .'</p><br />';
1.627     raeburn  7783:                 }
1.576     raeburn  7784:             }
                   7785:         }
                   7786: 
1.556     raeburn  7787:         $newuserscript = <<"ENDSCRIPT";
                   7788: 
1.570     raeburn  7789: function setSearch(createnew,callingForm) {
1.556     raeburn  7790:     if (createnew == 1) {
1.570     raeburn  7791:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7792:             if (callingForm.srchby.options[i].value == 'uname') {
                   7793:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7794:             }
                   7795:         }
1.570     raeburn  7796:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7797:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7798: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7799:             }
                   7800:         }
1.570     raeburn  7801:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7802:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7803:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7804:             }
                   7805:         }
1.570     raeburn  7806:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7807:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7808:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7809:             }
                   7810:         }
                   7811:     }
                   7812: }
                   7813: ENDSCRIPT
1.558     albertel 7814: 
1.556     raeburn  7815:     }
                   7816: 
1.555     raeburn  7817:     my $output = <<"END_BLOCK";
1.556     raeburn  7818: <script type="text/javascript">
1.824     bisitz   7819: // <![CDATA[
1.570     raeburn  7820: function validateEntry(callingForm) {
1.558     albertel 7821: 
1.556     raeburn  7822:     var checkok = 1;
1.558     albertel 7823:     var srchin;
1.570     raeburn  7824:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7825: 	if ( callingForm.srchin[i].checked ) {
                   7826: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7827: 	}
                   7828:     }
                   7829: 
1.570     raeburn  7830:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7831:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7832:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7833:     var srchterm =  callingForm.srchterm.value;
                   7834:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7835:     var msg = "";
                   7836: 
                   7837:     if (srchterm == "") {
                   7838:         checkok = 0;
1.571     raeburn  7839:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7840:     }
                   7841: 
1.569     raeburn  7842:     if (srchtype== 'begins') {
                   7843:         if (srchterm.length < 2) {
                   7844:             checkok = 0;
1.571     raeburn  7845:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7846:         }
                   7847:     }
                   7848: 
1.556     raeburn  7849:     if (srchtype== 'contains') {
                   7850:         if (srchterm.length < 3) {
                   7851:             checkok = 0;
1.571     raeburn  7852:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7853:         }
                   7854:     }
                   7855:     if (srchin == 'instd') {
                   7856:         if (srchdomain == '') {
                   7857:             checkok = 0;
1.571     raeburn  7858:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7859:         }
                   7860:     }
                   7861:     if (srchin == 'dom') {
                   7862:         if (srchdomain == '') {
                   7863:             checkok = 0;
1.571     raeburn  7864:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7865:         }
                   7866:     }
                   7867:     if (srchby == 'lastfirst') {
                   7868:         if (srchterm.indexOf(",") == -1) {
                   7869:             checkok = 0;
1.571     raeburn  7870:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7871:         }
                   7872:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7873:             checkok = 0;
1.571     raeburn  7874:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7875:         }
                   7876:     }
                   7877:     if (checkok == 0) {
1.571     raeburn  7878:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7879:         return;
                   7880:     }
                   7881:     if (checkok == 1) {
1.570     raeburn  7882:         callingForm.submit();
1.556     raeburn  7883:     }
                   7884: }
                   7885: 
                   7886: $newuserscript
                   7887: 
1.824     bisitz   7888: // ]]>
1.556     raeburn  7889: </script>
1.558     albertel 7890: 
                   7891: $new_user_create
                   7892: 
1.555     raeburn  7893: END_BLOCK
1.558     albertel 7894: 
1.876     raeburn  7895:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7896:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7897:                $domform.
                   7898:                &Apache::lonhtmlcommon::row_closure().
                   7899:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7900:                $srchbysel.
                   7901:                $srchtypesel. 
                   7902:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7903:                $srchinsel.
                   7904:                &Apache::lonhtmlcommon::row_closure(1). 
                   7905:                &Apache::lonhtmlcommon::end_pick_box().
                   7906:                '<br />';
1.555     raeburn  7907:     return $output;
                   7908: }
                   7909: 
1.612     raeburn  7910: sub user_rule_check {
1.615     raeburn  7911:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7912:     my $response;
                   7913:     if (ref($usershash) eq 'HASH') {
                   7914:         foreach my $user (keys(%{$usershash})) {
                   7915:             my ($uname,$udom) = split(/:/,$user);
                   7916:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7917:             my ($id,$newuser);
1.612     raeburn  7918:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7919:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7920:                 $id = $usershash->{$user}->{'id'};
                   7921:             }
                   7922:             my $inst_response;
                   7923:             if (ref($checks) eq 'HASH') {
                   7924:                 if (defined($checks->{'username'})) {
1.615     raeburn  7925:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7926:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7927:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7928:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7929:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7930:                 }
1.615     raeburn  7931:             } else {
                   7932:                 ($inst_response,%{$inst_results->{$user}}) =
                   7933:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7934:                 return;
1.612     raeburn  7935:             }
1.615     raeburn  7936:             if (!$got_rules->{$udom}) {
1.612     raeburn  7937:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7938:                                                   ['usercreation'],$udom);
                   7939:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7940:                     foreach my $item ('username','id') {
1.612     raeburn  7941:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7942:                             $$curr_rules{$udom}{$item} = 
                   7943:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7944:                         }
                   7945:                     }
                   7946:                 }
1.615     raeburn  7947:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7948:             }
1.612     raeburn  7949:             foreach my $item (keys(%{$checks})) {
                   7950:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7951:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7952:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7953:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7954:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7955:                                 if ($rule_check{$rule}) {
                   7956:                                     $$rulematch{$user}{$item} = $rule;
                   7957:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7958:                                         if (ref($inst_results) eq 'HASH') {
                   7959:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7960:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7961:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7962:                                                 }
1.612     raeburn  7963:                                             }
                   7964:                                         }
1.615     raeburn  7965:                                     }
                   7966:                                     last;
1.585     raeburn  7967:                                 }
                   7968:                             }
                   7969:                         }
                   7970:                     }
                   7971:                 }
                   7972:             }
                   7973:         }
                   7974:     }
1.612     raeburn  7975:     return;
                   7976: }
                   7977: 
                   7978: sub user_rule_formats {
                   7979:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7980:     my %text = ( 
                   7981:                  'username' => 'Usernames',
                   7982:                  'id'       => 'IDs',
                   7983:                );
                   7984:     my $output;
                   7985:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7986:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7987:         if (@{$ruleorder} > 0) {
                   7988:             $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>';
                   7989:             foreach my $rule (@{$ruleorder}) {
                   7990:                 if (ref($curr_rules) eq 'ARRAY') {
                   7991:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7992:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7993:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7994:                                         $rules->{$rule}{'desc'}.'</li>';
                   7995:                         }
                   7996:                     }
                   7997:                 }
                   7998:             }
                   7999:             $output .= '</ul>';
                   8000:         }
                   8001:     }
                   8002:     return $output;
                   8003: }
                   8004: 
                   8005: sub instrule_disallow_msg {
1.615     raeburn  8006:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  8007:     my $response;
                   8008:     my %text = (
                   8009:                   item   => 'username',
                   8010:                   items  => 'usernames',
                   8011:                   match  => 'matches',
                   8012:                   do     => 'does',
                   8013:                   action => 'a username',
                   8014:                   one    => 'one',
                   8015:                );
                   8016:     if ($count > 1) {
                   8017:         $text{'item'} = 'usernames';
                   8018:         $text{'match'} ='match';
                   8019:         $text{'do'} = 'do';
                   8020:         $text{'action'} = 'usernames',
                   8021:         $text{'one'} = 'ones';
                   8022:     }
                   8023:     if ($checkitem eq 'id') {
                   8024:         $text{'items'} = 'IDs';
                   8025:         $text{'item'} = 'ID';
                   8026:         $text{'action'} = 'an ID';
1.615     raeburn  8027:         if ($count > 1) {
                   8028:             $text{'item'} = 'IDs';
                   8029:             $text{'action'} = 'IDs';
                   8030:         }
1.612     raeburn  8031:     }
1.674     bisitz   8032:     $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  8033:     if ($mode eq 'upload') {
                   8034:         if ($checkitem eq 'username') {
                   8035:             $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'}.");
                   8036:         } elsif ($checkitem eq 'id') {
1.674     bisitz   8037:             $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  8038:         }
1.669     raeburn  8039:     } elsif ($mode eq 'selfcreate') {
                   8040:         if ($checkitem eq 'id') {
                   8041:             $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.");
                   8042:         }
1.615     raeburn  8043:     } else {
                   8044:         if ($checkitem eq 'username') {
                   8045:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8046:         } elsif ($checkitem eq 'id') {
                   8047:             $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.");
                   8048:         }
1.612     raeburn  8049:     }
                   8050:     return $response;
1.585     raeburn  8051: }
                   8052: 
1.624     raeburn  8053: sub personal_data_fieldtitles {
                   8054:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8055:                         id => 'Student/Employee ID',
                   8056:                         permanentemail => 'E-mail address',
                   8057:                         lastname => 'Last Name',
                   8058:                         firstname => 'First Name',
                   8059:                         middlename => 'Middle Name',
                   8060:                         generation => 'Generation',
                   8061:                         gen => 'Generation',
1.765     raeburn  8062:                         inststatus => 'Affiliation',
1.624     raeburn  8063:                    );
                   8064:     return %fieldtitles;
                   8065: }
                   8066: 
1.642     raeburn  8067: sub sorted_inst_types {
                   8068:     my ($dom) = @_;
                   8069:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8070:     my $othertitle = &mt('All users');
                   8071:     if ($env{'request.course.id'}) {
1.668     raeburn  8072:         $othertitle  = &mt('Any users');
1.642     raeburn  8073:     }
                   8074:     my @types;
                   8075:     if (ref($order) eq 'ARRAY') {
                   8076:         @types = @{$order};
                   8077:     }
                   8078:     if (@types == 0) {
                   8079:         if (ref($usertypes) eq 'HASH') {
                   8080:             @types = sort(keys(%{$usertypes}));
                   8081:         }
                   8082:     }
                   8083:     if (keys(%{$usertypes}) > 0) {
                   8084:         $othertitle = &mt('Other users');
                   8085:     }
                   8086:     return ($othertitle,$usertypes,\@types);
                   8087: }
                   8088: 
1.645     raeburn  8089: sub get_institutional_codes {
                   8090:     my ($settings,$allcourses,$LC_code) = @_;
                   8091: # Get complete list of course sections to update
                   8092:     my @currsections = ();
                   8093:     my @currxlists = ();
                   8094:     my $coursecode = $$settings{'internal.coursecode'};
                   8095: 
                   8096:     if ($$settings{'internal.sectionnums'} ne '') {
                   8097:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8098:     }
                   8099: 
                   8100:     if ($$settings{'internal.crosslistings'} ne '') {
                   8101:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8102:     }
                   8103: 
                   8104:     if (@currxlists > 0) {
                   8105:         foreach (@currxlists) {
                   8106:             if (m/^([^:]+):(\w*)$/) {
                   8107:                 unless (grep/^$1$/,@{$allcourses}) {
                   8108:                     push @{$allcourses},$1;
                   8109:                     $$LC_code{$1} = $2;
                   8110:                 }
                   8111:             }
                   8112:         }
                   8113:     }
                   8114:  
                   8115:     if (@currsections > 0) {
                   8116:         foreach (@currsections) {
                   8117:             if (m/^(\w+):(\w*)$/) {
                   8118:                 my $sec = $coursecode.$1;
                   8119:                 my $lc_sec = $2;
                   8120:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8121:                     push @{$allcourses},$sec;
                   8122:                     $$LC_code{$sec} = $lc_sec;
                   8123:                 }
                   8124:             }
                   8125:         }
                   8126:     }
                   8127:     return;
                   8128: }
                   8129: 
1.112     bowersj2 8130: =pod
                   8131: 
1.780     raeburn  8132: =head1 Slot Helpers
                   8133: 
                   8134: =over 4
                   8135: 
                   8136: =item * sorted_slots()
                   8137: 
                   8138: Sorts an array of slot names in order of slot start time (earliest first). 
                   8139: 
                   8140: Inputs:
                   8141: 
                   8142: =over 4
                   8143: 
                   8144: slotsarr  - Reference to array of unsorted slot names.
                   8145: 
                   8146: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8147: 
1.549     albertel 8148: =back
                   8149: 
1.780     raeburn  8150: Returns:
                   8151: 
                   8152: =over 4
                   8153: 
                   8154: sorted   - An array of slot names sorted by the start time of the slot.
                   8155: 
                   8156: =back
                   8157: 
                   8158: =back
                   8159: 
                   8160: =cut
                   8161: 
                   8162: 
                   8163: sub sorted_slots {
                   8164:     my ($slotsarr,$slots) = @_;
                   8165:     my @sorted;
                   8166:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8167:         @sorted =
                   8168:             sort {
                   8169:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8170:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8171:                      }
                   8172:                      if (ref($slots->{$a})) { return -1;}
                   8173:                      if (ref($slots->{$b})) { return 1;}
                   8174:                      return 0;
                   8175:                  } @{$slotsarr};
                   8176:     }
                   8177:     return @sorted;
                   8178: }
                   8179: 
                   8180: 
                   8181: =pod
                   8182: 
1.549     albertel 8183: =head1 HTTP Helpers
                   8184: 
                   8185: =over 4
                   8186: 
1.648     raeburn  8187: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8188: 
1.258     albertel 8189: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8190: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8191: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8192: 
                   8193: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8194: $possible_names is an ref to an array of form element names.  As an example:
                   8195: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8196: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8197: 
                   8198: =cut
1.1       albertel 8199: 
1.6       albertel 8200: sub get_unprocessed_cgi {
1.25      albertel 8201:   my ($query,$possible_names)= @_;
1.26      matthew  8202:   # $Apache::lonxml::debug=1;
1.356     albertel 8203:   foreach my $pair (split(/&/,$query)) {
                   8204:     my ($name, $value) = split(/=/,$pair);
1.369     www      8205:     $name = &unescape($name);
1.25      albertel 8206:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8207:       $value =~ tr/+/ /;
                   8208:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8209:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8210:     }
1.16      harris41 8211:   }
1.6       albertel 8212: }
                   8213: 
1.112     bowersj2 8214: =pod
                   8215: 
1.648     raeburn  8216: =item * &cacheheader() 
1.112     bowersj2 8217: 
                   8218: returns cache-controlling header code
                   8219: 
                   8220: =cut
                   8221: 
1.7       albertel 8222: sub cacheheader {
1.258     albertel 8223:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8224:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8225:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8226:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8227:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8228:     return $output;
1.7       albertel 8229: }
                   8230: 
1.112     bowersj2 8231: =pod
                   8232: 
1.648     raeburn  8233: =item * &no_cache($r) 
1.112     bowersj2 8234: 
                   8235: specifies header code to not have cache
                   8236: 
                   8237: =cut
                   8238: 
1.9       albertel 8239: sub no_cache {
1.216     albertel 8240:     my ($r) = @_;
                   8241:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8242: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8243:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8244:     $r->no_cache(1);
                   8245:     $r->header_out("Expires" => $date);
                   8246:     $r->header_out("Pragma" => "no-cache");
1.123     www      8247: }
                   8248: 
                   8249: sub content_type {
1.181     albertel 8250:     my ($r,$type,$charset) = @_;
1.299     foxr     8251:     if ($r) {
                   8252: 	#  Note that printout.pl calls this with undef for $r.
                   8253: 	&no_cache($r);
                   8254:     }
1.258     albertel 8255:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8256:     unless ($charset) {
                   8257: 	$charset=&Apache::lonlocal::current_encoding;
                   8258:     }
                   8259:     if ($charset) { $type.='; charset='.$charset; }
                   8260:     if ($r) {
                   8261: 	$r->content_type($type);
                   8262:     } else {
                   8263: 	print("Content-type: $type\n\n");
                   8264:     }
1.9       albertel 8265: }
1.25      albertel 8266: 
1.112     bowersj2 8267: =pod
                   8268: 
1.648     raeburn  8269: =item * &add_to_env($name,$value) 
1.112     bowersj2 8270: 
1.258     albertel 8271: adds $name to the %env hash with value
1.112     bowersj2 8272: $value, if $name already exists, the entry is converted to an array
                   8273: reference and $value is added to the array.
                   8274: 
                   8275: =cut
                   8276: 
1.25      albertel 8277: sub add_to_env {
                   8278:   my ($name,$value)=@_;
1.258     albertel 8279:   if (defined($env{$name})) {
                   8280:     if (ref($env{$name})) {
1.25      albertel 8281:       #already have multiple values
1.258     albertel 8282:       push(@{ $env{$name} },$value);
1.25      albertel 8283:     } else {
                   8284:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8285:       my $first=$env{$name};
                   8286:       undef($env{$name});
                   8287:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8288:     }
                   8289:   } else {
1.258     albertel 8290:     $env{$name}=$value;
1.25      albertel 8291:   }
1.31      albertel 8292: }
1.149     albertel 8293: 
                   8294: =pod
                   8295: 
1.648     raeburn  8296: =item * &get_env_multiple($name) 
1.149     albertel 8297: 
1.258     albertel 8298: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8299: values may be defined and end up as an array ref.
                   8300: 
                   8301: returns an array of values
                   8302: 
                   8303: =cut
                   8304: 
                   8305: sub get_env_multiple {
                   8306:     my ($name) = @_;
                   8307:     my @values;
1.258     albertel 8308:     if (defined($env{$name})) {
1.149     albertel 8309:         # exists is it an array
1.258     albertel 8310:         if (ref($env{$name})) {
                   8311:             @values=@{ $env{$name} };
1.149     albertel 8312:         } else {
1.258     albertel 8313:             $values[0]=$env{$name};
1.149     albertel 8314:         }
                   8315:     }
                   8316:     return(@values);
                   8317: }
                   8318: 
1.660     raeburn  8319: sub ask_for_embedded_content {
                   8320:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8321:     my $upload_output = '
                   8322:    <form name="upload_embedded" action="'.$actionurl.'"
                   8323:                   method="post" enctype="multipart/form-data">';
                   8324:     $upload_output .= $state;
1.661     raeburn  8325:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8326: 
                   8327:     my $num = 0;
                   8328:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8329:         $upload_output .= &start_data_table_row().
                   8330:             '<td>'.$embed_file.'</td><td>';
                   8331:         if ($args->{'ignore_remote_references'}
                   8332:             && $embed_file =~ m{^\w+://}) {
                   8333:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8334:         } elsif ($args->{'error_on_invalid_names'}
                   8335:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8336: 
                   8337:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8338: 
                   8339:         } else {
                   8340:             $upload_output .='
1.661     raeburn  8341:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8342:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8343:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8344:             $upload_output .=
                   8345:                 "\n\t\t".
                   8346:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8347:                 $attrib.'" />';
                   8348:             if (exists($$codebase{$embed_file})) {
                   8349:                 $upload_output .=
                   8350:                     "\n\t\t".
                   8351:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8352:                     &escape($$codebase{$embed_file}).'" />';
                   8353:             }
                   8354:         }
                   8355:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8356:         $num++;
                   8357:     }
                   8358:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8359:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8360:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8361:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8362:    </form>';
                   8363:     return $upload_output;
                   8364: }
                   8365: 
1.661     raeburn  8366: sub upload_embedded {
                   8367:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8368:         $current_disk_usage) = @_;
                   8369:     my $output;
                   8370:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8371:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8372:         my $orig_uploaded_filename =
                   8373:             $env{'form.embedded_item_'.$i.'.filename'};
                   8374: 
                   8375:         $env{'form.embedded_orig_'.$i} =
                   8376:             &unescape($env{'form.embedded_orig_'.$i});
                   8377:         my ($path,$fname) =
                   8378:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8379:         # no path, whole string is fname
                   8380:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8381: 
                   8382:         $path = $env{'form.currentpath'}.$path;
                   8383:         $fname = &Apache::lonnet::clean_filename($fname);
                   8384:         # See if there is anything left
                   8385:         next if ($fname eq '');
                   8386: 
                   8387:         # Check if file already exists as a file or directory.
                   8388:         my ($state,$msg);
                   8389:         if ($context eq 'portfolio') {
                   8390:             my $port_path = $dirpath;
                   8391:             if ($group ne '') {
                   8392:                 $port_path = "groups/$group/$port_path";
                   8393:             }
                   8394:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8395:                                               $dir_root,$port_path,$disk_quota,
                   8396:                                               $current_disk_usage,$uname,$udom);
                   8397:             if ($state eq 'will_exceed_quota'
                   8398:                 || $state eq 'file_locked'
                   8399:                 || $state eq 'file_exists' ) {
                   8400:                 $output .= $msg;
                   8401:                 next;
                   8402:             }
                   8403:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8404:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8405:             if ($state eq 'exists') {
                   8406:                 $output .= $msg;
                   8407:                 next;
                   8408:             }
                   8409:         }
                   8410:         # Check if extension is valid
                   8411:         if (($fname =~ /\.(\w+)$/) &&
                   8412:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8413:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8414:             next;
                   8415:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8416:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8417:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8418:             next;
                   8419:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8420:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8421:             next;
                   8422:         }
                   8423: 
                   8424:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8425:         if ($context eq 'portfolio') {
                   8426:             my $result=
                   8427:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8428:                                                 $dirpath.$path);
                   8429:             if ($result !~ m|^/uploaded/|) {
                   8430:                 $output .= '<span class="LC_error">'
                   8431:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8432:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8433:                       .'</span><br />';
                   8434:                 next;
                   8435:             } else {
                   8436:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8437:                            $path.$fname.'</span>').'</p>';     
                   8438:             }
                   8439:         } else {
                   8440: # Save the file
                   8441:             my $target = $env{'form.embedded_item_'.$i};
                   8442:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8443:             my $dest = $fullpath.$fname;
                   8444:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8445:             my @parts=split(/\//,$fullpath);
                   8446:             my $count;
                   8447:             my $filepath = $dir_root;
                   8448:             for ($count=4;$count<=$#parts;$count++) {
                   8449:                 $filepath .= "/$parts[$count]";
                   8450:                 if ((-e $filepath)!=1) {
                   8451:                     mkdir($filepath,0770);
                   8452:                 }
                   8453:             }
                   8454:             my $fh;
                   8455:             if (!open($fh,'>'.$dest)) {
                   8456:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8457:                 $output .= '<span class="LC_error">'.
                   8458:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8459:                            '</span><br />';
                   8460:             } else {
                   8461:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8462:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8463:                     $output .= '<span class="LC_error">'.
                   8464:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8465:                               '</span><br />';
                   8466:                 } else {
                   8467:                     if ($context eq 'testbank') {
                   8468:                         $output .= &mt('Embedded file uploaded successfully:').
                   8469:                                    '&nbsp;<a href="'.$url.'">'.
                   8470:                                    $orig_uploaded_filename.'</a><br />';
                   8471:                     } else {
1.705     tempelho 8472:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8473:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8474:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8475:                     }
                   8476:                 }
                   8477:                 close($fh);
                   8478:             }
                   8479:         }
                   8480:     }
                   8481:     return $output;
                   8482: }
                   8483: 
                   8484: sub check_for_existing {
                   8485:     my ($path,$fname,$element) = @_;
                   8486:     my ($state,$msg);
                   8487:     if (-d $path.'/'.$fname) {
                   8488:         $state = 'exists';
                   8489:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8490:     } elsif (-e $path.'/'.$fname) {
                   8491:         $state = 'exists';
                   8492:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8493:     }
                   8494:     if ($state eq 'exists') {
                   8495:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8496:     }
                   8497:     return ($state,$msg);
                   8498: }
                   8499: 
                   8500: sub check_for_upload {
                   8501:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8502:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8503:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8504:     my $getpropath = 1;
                   8505:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8506:                                             $getpropath);
                   8507:     my $found_file = 0;
                   8508:     my $locked_file = 0;
                   8509:     foreach my $line (@dir_list) {
                   8510:         my ($file_name)=split(/\&/,$line,2);
                   8511:         if ($file_name eq $fname){
                   8512:             $file_name = $path.$file_name;
                   8513:             if ($group ne '') {
                   8514:                 $file_name = $group.$file_name;
                   8515:             }
                   8516:             $found_file = 1;
                   8517:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8518:                 $locked_file = 1;
                   8519:             }
                   8520:         }
                   8521:     }
                   8522:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8523:         my $msg = '<span class="LC_error">'.
                   8524:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8525:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8526:         return ('will_exceed_quota',$msg);
                   8527:     } elsif ($found_file) {
                   8528:         if ($locked_file) {
                   8529:             my $msg = '<span class="LC_error">';
                   8530:             $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>');
                   8531:             $msg .= '</span><br />';
                   8532:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8533:             return ('file_locked',$msg);
                   8534:         } else {
                   8535:             my $msg = '<span class="LC_error">';
                   8536:             $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'});
                   8537:             $msg .= '</span>';
                   8538:             $msg .= '<br />';
                   8539:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8540:             return ('file_exists',$msg);
                   8541:         }
                   8542:     }
                   8543: }
                   8544: 
1.31      albertel 8545: 
1.41      ng       8546: =pod
1.45      matthew  8547: 
1.464     albertel 8548: =back
1.41      ng       8549: 
1.112     bowersj2 8550: =head1 CSV Upload/Handling functions
1.38      albertel 8551: 
1.41      ng       8552: =over 4
                   8553: 
1.648     raeburn  8554: =item * &upfile_store($r)
1.41      ng       8555: 
                   8556: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8557: needs $env{'form.upfile'}
1.41      ng       8558: returns $datatoken to be put into hidden field
                   8559: 
                   8560: =cut
1.31      albertel 8561: 
                   8562: sub upfile_store {
                   8563:     my $r=shift;
1.258     albertel 8564:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8565:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8566:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8567:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8568: 
1.258     albertel 8569:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8570: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8571:     {
1.158     raeburn  8572:         my $datafile = $r->dir_config('lonDaemons').
                   8573:                            '/tmp/'.$datatoken.'.tmp';
                   8574:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8575:             print $fh $env{'form.upfile'};
1.158     raeburn  8576:             close($fh);
                   8577:         }
1.31      albertel 8578:     }
                   8579:     return $datatoken;
                   8580: }
                   8581: 
1.56      matthew  8582: =pod
                   8583: 
1.648     raeburn  8584: =item * &load_tmp_file($r)
1.41      ng       8585: 
                   8586: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8587: needs $env{'form.datatoken'},
                   8588: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8589: 
                   8590: =cut
1.31      albertel 8591: 
                   8592: sub load_tmp_file {
                   8593:     my $r=shift;
                   8594:     my @studentdata=();
                   8595:     {
1.158     raeburn  8596:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8597:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8598:         if ( open(my $fh,"<$studentfile") ) {
                   8599:             @studentdata=<$fh>;
                   8600:             close($fh);
                   8601:         }
1.31      albertel 8602:     }
1.258     albertel 8603:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8604: }
                   8605: 
1.56      matthew  8606: =pod
                   8607: 
1.648     raeburn  8608: =item * &upfile_record_sep()
1.41      ng       8609: 
                   8610: Separate uploaded file into records
                   8611: returns array of records,
1.258     albertel 8612: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8613: 
                   8614: =cut
1.31      albertel 8615: 
                   8616: sub upfile_record_sep {
1.258     albertel 8617:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8618:     } else {
1.248     albertel 8619: 	my @records;
1.258     albertel 8620: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8621: 	    if ($line=~/^\s*$/) { next; }
                   8622: 	    push(@records,$line);
                   8623: 	}
                   8624: 	return @records;
1.31      albertel 8625:     }
                   8626: }
                   8627: 
1.56      matthew  8628: =pod
                   8629: 
1.648     raeburn  8630: =item * &record_sep($record)
1.41      ng       8631: 
1.258     albertel 8632: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8633: 
                   8634: =cut
                   8635: 
1.263     www      8636: sub takeleft {
                   8637:     my $index=shift;
                   8638:     return substr('0000'.$index,-4,4);
                   8639: }
                   8640: 
1.31      albertel 8641: sub record_sep {
                   8642:     my $record=shift;
                   8643:     my %components=();
1.258     albertel 8644:     if ($env{'form.upfiletype'} eq 'xml') {
                   8645:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8646:         my $i=0;
1.356     albertel 8647:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8648:             $field=~s/^(\"|\')//;
                   8649:             $field=~s/(\"|\')$//;
1.263     www      8650:             $components{&takeleft($i)}=$field;
1.31      albertel 8651:             $i++;
                   8652:         }
1.258     albertel 8653:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8654:         my $i=0;
1.356     albertel 8655:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8656:             $field=~s/^(\"|\')//;
                   8657:             $field=~s/(\"|\')$//;
1.263     www      8658:             $components{&takeleft($i)}=$field;
1.31      albertel 8659:             $i++;
                   8660:         }
                   8661:     } else {
1.561     www      8662:         my $separator=',';
1.480     banghart 8663:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8664:             $separator=';';
1.480     banghart 8665:         }
1.31      albertel 8666:         my $i=0;
1.561     www      8667: # the character we are looking for to indicate the end of a quote or a record 
                   8668:         my $looking_for=$separator;
                   8669: # do not add the characters to the fields
                   8670:         my $ignore=0;
                   8671: # we just encountered a separator (or the beginning of the record)
                   8672:         my $just_found_separator=1;
                   8673: # store the field we are working on here
                   8674:         my $field='';
                   8675: # work our way through all characters in record
                   8676:         foreach my $character ($record=~/(.)/g) {
                   8677:             if ($character eq $looking_for) {
                   8678:                if ($character ne $separator) {
                   8679: # Found the end of a quote, again looking for separator
                   8680:                   $looking_for=$separator;
                   8681:                   $ignore=1;
                   8682:                } else {
                   8683: # Found a separator, store away what we got
                   8684:                   $components{&takeleft($i)}=$field;
                   8685: 	          $i++;
                   8686:                   $just_found_separator=1;
                   8687:                   $ignore=0;
                   8688:                   $field='';
                   8689:                }
                   8690:                next;
                   8691:             }
                   8692: # single or double quotation marks after a separator indicate beginning of a quote
                   8693: # we are now looking for the end of the quote and need to ignore separators
                   8694:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8695:                $looking_for=$character;
                   8696:                next;
                   8697:             }
                   8698: # ignore would be true after we reached the end of a quote
                   8699:             if ($ignore) { next; }
                   8700:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8701:             $field.=$character;
                   8702:             $just_found_separator=0; 
1.31      albertel 8703:         }
1.561     www      8704: # catch the very last entry, since we never encountered the separator
                   8705:         $components{&takeleft($i)}=$field;
1.31      albertel 8706:     }
                   8707:     return %components;
                   8708: }
                   8709: 
1.144     matthew  8710: ######################################################
                   8711: ######################################################
                   8712: 
1.56      matthew  8713: =pod
                   8714: 
1.648     raeburn  8715: =item * &upfile_select_html()
1.41      ng       8716: 
1.144     matthew  8717: Return HTML code to select a file from the users machine and specify 
                   8718: the file type.
1.41      ng       8719: 
                   8720: =cut
                   8721: 
1.144     matthew  8722: ######################################################
                   8723: ######################################################
1.31      albertel 8724: sub upfile_select_html {
1.144     matthew  8725:     my %Types = (
                   8726:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8727:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8728:                  space => &mt('Space separated'),
                   8729:                  tab   => &mt('Tabulator separated'),
                   8730: #                 xml   => &mt('HTML/XML'),
                   8731:                  );
                   8732:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8733:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8734:     foreach my $type (sort(keys(%Types))) {
                   8735:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8736:     }
                   8737:     $Str .= "</select>\n";
                   8738:     return $Str;
1.31      albertel 8739: }
                   8740: 
1.301     albertel 8741: sub get_samples {
                   8742:     my ($records,$toget) = @_;
                   8743:     my @samples=({});
                   8744:     my $got=0;
                   8745:     foreach my $rec (@$records) {
                   8746: 	my %temp = &record_sep($rec);
                   8747: 	if (! grep(/\S/, values(%temp))) { next; }
                   8748: 	if (%temp) {
                   8749: 	    $samples[$got]=\%temp;
                   8750: 	    $got++;
                   8751: 	    if ($got == $toget) { last; }
                   8752: 	}
                   8753:     }
                   8754:     return \@samples;
                   8755: }
                   8756: 
1.144     matthew  8757: ######################################################
                   8758: ######################################################
                   8759: 
1.56      matthew  8760: =pod
                   8761: 
1.648     raeburn  8762: =item * &csv_print_samples($r,$records)
1.41      ng       8763: 
                   8764: Prints a table of sample values from each column uploaded $r is an
                   8765: Apache Request ref, $records is an arrayref from
                   8766: &Apache::loncommon::upfile_record_sep
                   8767: 
                   8768: =cut
                   8769: 
1.144     matthew  8770: ######################################################
                   8771: ######################################################
1.31      albertel 8772: sub csv_print_samples {
                   8773:     my ($r,$records) = @_;
1.662     bisitz   8774:     my $samples = &get_samples($records,5);
1.301     albertel 8775: 
1.594     raeburn  8776:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8777:               &start_data_table_header_row());
1.356     albertel 8778:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8779:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8780:     $r->print(&end_data_table_header_row());
1.301     albertel 8781:     foreach my $hash (@$samples) {
1.594     raeburn  8782: 	$r->print(&start_data_table_row());
1.356     albertel 8783: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8784: 	    $r->print('<td>');
1.356     albertel 8785: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8786: 	    $r->print('</td>');
                   8787: 	}
1.594     raeburn  8788: 	$r->print(&end_data_table_row());
1.31      albertel 8789:     }
1.594     raeburn  8790:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8791: }
                   8792: 
1.144     matthew  8793: ######################################################
                   8794: ######################################################
                   8795: 
1.56      matthew  8796: =pod
                   8797: 
1.648     raeburn  8798: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8799: 
                   8800: Prints a table to create associations between values and table columns.
1.144     matthew  8801: 
1.41      ng       8802: $r is an Apache Request ref,
                   8803: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8804: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8805: 
                   8806: =cut
                   8807: 
1.144     matthew  8808: ######################################################
                   8809: ######################################################
1.31      albertel 8810: sub csv_print_select_table {
                   8811:     my ($r,$records,$d) = @_;
1.301     albertel 8812:     my $i=0;
                   8813:     my $samples = &get_samples($records,1);
1.144     matthew  8814:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8815: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8816:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8817:               '<th>'.&mt('Column').'</th>'.
                   8818:               &end_data_table_header_row()."\n");
1.356     albertel 8819:     foreach my $array_ref (@$d) {
                   8820: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8821: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8822: 
1.875     bisitz   8823: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8824: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8825: 	$r->print('<option value="none"></option>');
1.356     albertel 8826: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8827: 	    $r->print('<option value="'.$sample.'"'.
                   8828:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8829:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8830: 	}
1.594     raeburn  8831: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8832: 	$i++;
                   8833:     }
1.594     raeburn  8834:     $r->print(&end_data_table());
1.31      albertel 8835:     $i--;
                   8836:     return $i;
                   8837: }
1.56      matthew  8838: 
1.144     matthew  8839: ######################################################
                   8840: ######################################################
                   8841: 
1.56      matthew  8842: =pod
1.31      albertel 8843: 
1.648     raeburn  8844: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8845: 
                   8846: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8847: 
                   8848: $r is an Apache Request ref,
                   8849: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8850: $d is an array of 2 element arrays (internal name, displayed name)
                   8851: 
                   8852: =cut
                   8853: 
1.144     matthew  8854: ######################################################
                   8855: ######################################################
1.31      albertel 8856: sub csv_samples_select_table {
                   8857:     my ($r,$records,$d) = @_;
                   8858:     my $i=0;
1.144     matthew  8859:     #
1.662     bisitz   8860:     my $max_samples = 5;
                   8861:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8862:     $r->print(&start_data_table().
                   8863:               &start_data_table_header_row().'<th>'.
                   8864:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8865:               &end_data_table_header_row());
1.301     albertel 8866: 
                   8867:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8868: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8869: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8870: 	foreach my $option (@$d) {
                   8871: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8872: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8873:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8874:                       $display.'</option>');
1.31      albertel 8875: 	}
                   8876: 	$r->print('</select></td><td>');
1.662     bisitz   8877: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8878: 	    if (defined($samples->[$line]{$key})) { 
                   8879: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8880: 	    }
                   8881: 	}
1.594     raeburn  8882: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8883: 	$i++;
                   8884:     }
1.594     raeburn  8885:     $r->print(&end_data_table());
1.31      albertel 8886:     $i--;
                   8887:     return($i);
1.115     matthew  8888: }
                   8889: 
1.144     matthew  8890: ######################################################
                   8891: ######################################################
                   8892: 
1.115     matthew  8893: =pod
                   8894: 
1.648     raeburn  8895: =item * &clean_excel_name($name)
1.115     matthew  8896: 
                   8897: Returns a replacement for $name which does not contain any illegal characters.
                   8898: 
                   8899: =cut
                   8900: 
1.144     matthew  8901: ######################################################
                   8902: ######################################################
1.115     matthew  8903: sub clean_excel_name {
                   8904:     my ($name) = @_;
                   8905:     $name =~ s/[:\*\?\/\\]//g;
                   8906:     if (length($name) > 31) {
                   8907:         $name = substr($name,0,31);
                   8908:     }
                   8909:     return $name;
1.25      albertel 8910: }
1.84      albertel 8911: 
1.85      albertel 8912: =pod
                   8913: 
1.648     raeburn  8914: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8915: 
                   8916: Returns either 1 or undef
                   8917: 
                   8918: 1 if the part is to be hidden, undef if it is to be shown
                   8919: 
                   8920: Arguments are:
                   8921: 
                   8922: $id the id of the part to be checked
                   8923: $symb, optional the symb of the resource to check
                   8924: $udom, optional the domain of the user to check for
                   8925: $uname, optional the username of the user to check for
                   8926: 
                   8927: =cut
1.84      albertel 8928: 
                   8929: sub check_if_partid_hidden {
                   8930:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8931:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8932: 					 $symb,$udom,$uname);
1.141     albertel 8933:     my $truth=1;
                   8934:     #if the string starts with !, then the list is the list to show not hide
                   8935:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8936:     my @hiddenlist=split(/,/,$hiddenparts);
                   8937:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8938: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8939:     }
1.141     albertel 8940:     return !$truth;
1.84      albertel 8941: }
1.127     matthew  8942: 
1.138     matthew  8943: 
                   8944: ############################################################
                   8945: ############################################################
                   8946: 
                   8947: =pod
                   8948: 
1.157     matthew  8949: =back 
                   8950: 
1.138     matthew  8951: =head1 cgi-bin script and graphing routines
                   8952: 
1.157     matthew  8953: =over 4
                   8954: 
1.648     raeburn  8955: =item * &get_cgi_id()
1.138     matthew  8956: 
                   8957: Inputs: none
                   8958: 
                   8959: Returns an id which can be used to pass environment variables
                   8960: to various cgi-bin scripts.  These environment variables will
                   8961: be removed from the users environment after a given time by
                   8962: the routine &Apache::lonnet::transfer_profile_to_env.
                   8963: 
                   8964: =cut
                   8965: 
                   8966: ############################################################
                   8967: ############################################################
1.152     albertel 8968: my $uniq=0;
1.136     matthew  8969: sub get_cgi_id {
1.154     albertel 8970:     $uniq=($uniq+1)%100000;
1.280     albertel 8971:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8972: }
                   8973: 
1.127     matthew  8974: ############################################################
                   8975: ############################################################
                   8976: 
                   8977: =pod
                   8978: 
1.648     raeburn  8979: =item * &DrawBarGraph()
1.127     matthew  8980: 
1.138     matthew  8981: Facilitates the plotting of data in a (stacked) bar graph.
                   8982: Puts plot definition data into the users environment in order for 
                   8983: graph.png to plot it.  Returns an <img> tag for the plot.
                   8984: The bars on the plot are labeled '1','2',...,'n'.
                   8985: 
                   8986: Inputs:
                   8987: 
                   8988: =over 4
                   8989: 
                   8990: =item $Title: string, the title of the plot
                   8991: 
                   8992: =item $xlabel: string, text describing the X-axis of the plot
                   8993: 
                   8994: =item $ylabel: string, text describing the Y-axis of the plot
                   8995: 
                   8996: =item $Max: scalar, the maximum Y value to use in the plot
                   8997: If $Max is < any data point, the graph will not be rendered.
                   8998: 
1.140     matthew  8999: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  9000: they are plotted.  If undefined, default values will be used.
                   9001: 
1.178     matthew  9002: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   9003: 
1.138     matthew  9004: =item @Values: An array of array references.  Each array reference holds data
                   9005: to be plotted in a stacked bar chart.
                   9006: 
1.239     matthew  9007: =item If the final element of @Values is a hash reference the key/value
                   9008: pairs will be added to the graph definition.
                   9009: 
1.138     matthew  9010: =back
                   9011: 
                   9012: Returns:
                   9013: 
                   9014: An <img> tag which references graph.png and the appropriate identifying
                   9015: information for the plot.
                   9016: 
1.127     matthew  9017: =cut
                   9018: 
                   9019: ############################################################
                   9020: ############################################################
1.134     matthew  9021: sub DrawBarGraph {
1.178     matthew  9022:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  9023:     #
                   9024:     if (! defined($colors)) {
                   9025:         $colors = ['#33ff00', 
                   9026:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   9027:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   9028:                   ]; 
                   9029:     }
1.228     matthew  9030:     my $extra_settings = {};
                   9031:     if (ref($Values[-1]) eq 'HASH') {
                   9032:         $extra_settings = pop(@Values);
                   9033:     }
1.127     matthew  9034:     #
1.136     matthew  9035:     my $identifier = &get_cgi_id();
                   9036:     my $id = 'cgi.'.$identifier;        
1.129     matthew  9037:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9038:         return '';
                   9039:     }
1.225     matthew  9040:     #
                   9041:     my @Labels;
                   9042:     if (defined($labels)) {
                   9043:         @Labels = @$labels;
                   9044:     } else {
                   9045:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9046:             push (@Labels,$i+1);
                   9047:         }
                   9048:     }
                   9049:     #
1.129     matthew  9050:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9051:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9052:     my %ValuesHash;
                   9053:     my $NumSets=1;
                   9054:     foreach my $array (@Values) {
                   9055:         next if (! ref($array));
1.136     matthew  9056:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9057:             join(',',@$array);
1.129     matthew  9058:     }
1.127     matthew  9059:     #
1.136     matthew  9060:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9061:     if ($NumBars < 3) {
                   9062:         $width = 120+$NumBars*32;
1.220     matthew  9063:         $xskip = 1;
1.225     matthew  9064:         $bar_width = 30;
                   9065:     } elsif ($NumBars < 5) {
                   9066:         $width = 120+$NumBars*20;
                   9067:         $xskip = 1;
                   9068:         $bar_width = 20;
1.220     matthew  9069:     } elsif ($NumBars < 10) {
1.136     matthew  9070:         $width = 120+$NumBars*15;
                   9071:         $xskip = 1;
                   9072:         $bar_width = 15;
                   9073:     } elsif ($NumBars <= 25) {
                   9074:         $width = 120+$NumBars*11;
                   9075:         $xskip = 5;
                   9076:         $bar_width = 8;
                   9077:     } elsif ($NumBars <= 50) {
                   9078:         $width = 120+$NumBars*8;
                   9079:         $xskip = 5;
                   9080:         $bar_width = 4;
                   9081:     } else {
                   9082:         $width = 120+$NumBars*8;
                   9083:         $xskip = 5;
                   9084:         $bar_width = 4;
                   9085:     }
                   9086:     #
1.137     matthew  9087:     $Max = 1 if ($Max < 1);
                   9088:     if ( int($Max) < $Max ) {
                   9089:         $Max++;
                   9090:         $Max = int($Max);
                   9091:     }
1.127     matthew  9092:     $Title  = '' if (! defined($Title));
                   9093:     $xlabel = '' if (! defined($xlabel));
                   9094:     $ylabel = '' if (! defined($ylabel));
1.369     www      9095:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9096:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9097:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9098:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9099:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9100:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9101:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9102:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9103:     $ValuesHash{$id.'.height'}   = $height;
                   9104:     $ValuesHash{$id.'.width'}    = $width;
                   9105:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9106:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9107:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9108:     #
1.228     matthew  9109:     # Deal with other parameters
                   9110:     while (my ($key,$value) = each(%$extra_settings)) {
                   9111:         $ValuesHash{$id.'.'.$key} = $value;
                   9112:     }
                   9113:     #
1.646     raeburn  9114:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9115:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9116: }
                   9117: 
                   9118: ############################################################
                   9119: ############################################################
                   9120: 
                   9121: =pod
                   9122: 
1.648     raeburn  9123: =item * &DrawXYGraph()
1.137     matthew  9124: 
1.138     matthew  9125: Facilitates the plotting of data in an XY graph.
                   9126: Puts plot definition data into the users environment in order for 
                   9127: graph.png to plot it.  Returns an <img> tag for the plot.
                   9128: 
                   9129: Inputs:
                   9130: 
                   9131: =over 4
                   9132: 
                   9133: =item $Title: string, the title of the plot
                   9134: 
                   9135: =item $xlabel: string, text describing the X-axis of the plot
                   9136: 
                   9137: =item $ylabel: string, text describing the Y-axis of the plot
                   9138: 
                   9139: =item $Max: scalar, the maximum Y value to use in the plot
                   9140: If $Max is < any data point, the graph will not be rendered.
                   9141: 
                   9142: =item $colors: Array ref containing the hex color codes for the data to be 
                   9143: plotted in.  If undefined, default values will be used.
                   9144: 
                   9145: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9146: 
                   9147: =item $Ydata: Array ref containing Array refs.  
1.185     www      9148: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9149: 
                   9150: =item %Values: hash indicating or overriding any default values which are 
                   9151: passed to graph.png.  
                   9152: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9153: 
                   9154: =back
                   9155: 
                   9156: Returns:
                   9157: 
                   9158: An <img> tag which references graph.png and the appropriate identifying
                   9159: information for the plot.
                   9160: 
1.137     matthew  9161: =cut
                   9162: 
                   9163: ############################################################
                   9164: ############################################################
                   9165: sub DrawXYGraph {
                   9166:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9167:     #
                   9168:     # Create the identifier for the graph
                   9169:     my $identifier = &get_cgi_id();
                   9170:     my $id = 'cgi.'.$identifier;
                   9171:     #
                   9172:     $Title  = '' if (! defined($Title));
                   9173:     $xlabel = '' if (! defined($xlabel));
                   9174:     $ylabel = '' if (! defined($ylabel));
                   9175:     my %ValuesHash = 
                   9176:         (
1.369     www      9177:          $id.'.title'  => &escape($Title),
                   9178:          $id.'.xlabel' => &escape($xlabel),
                   9179:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9180:          $id.'.y_max_value'=> $Max,
                   9181:          $id.'.labels'     => join(',',@$Xlabels),
                   9182:          $id.'.PlotType'   => 'XY',
                   9183:          );
                   9184:     #
                   9185:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9186:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9187:     }
                   9188:     #
                   9189:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9190:         return '';
                   9191:     }
                   9192:     my $NumSets=1;
1.138     matthew  9193:     foreach my $array (@{$Ydata}){
1.137     matthew  9194:         next if (! ref($array));
                   9195:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9196:     }
1.138     matthew  9197:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9198:     #
                   9199:     # Deal with other parameters
                   9200:     while (my ($key,$value) = each(%Values)) {
                   9201:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9202:     }
                   9203:     #
1.646     raeburn  9204:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9205:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9206: }
                   9207: 
                   9208: ############################################################
                   9209: ############################################################
                   9210: 
                   9211: =pod
                   9212: 
1.648     raeburn  9213: =item * &DrawXYYGraph()
1.138     matthew  9214: 
                   9215: Facilitates the plotting of data in an XY graph with two Y axes.
                   9216: Puts plot definition data into the users environment in order for 
                   9217: graph.png to plot it.  Returns an <img> tag for the plot.
                   9218: 
                   9219: Inputs:
                   9220: 
                   9221: =over 4
                   9222: 
                   9223: =item $Title: string, the title of the plot
                   9224: 
                   9225: =item $xlabel: string, text describing the X-axis of the plot
                   9226: 
                   9227: =item $ylabel: string, text describing the Y-axis of the plot
                   9228: 
                   9229: =item $colors: Array ref containing the hex color codes for the data to be 
                   9230: plotted in.  If undefined, default values will be used.
                   9231: 
                   9232: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9233: 
                   9234: =item $Ydata1: The first data set
                   9235: 
                   9236: =item $Min1: The minimum value of the left Y-axis
                   9237: 
                   9238: =item $Max1: The maximum value of the left Y-axis
                   9239: 
                   9240: =item $Ydata2: The second data set
                   9241: 
                   9242: =item $Min2: The minimum value of the right Y-axis
                   9243: 
                   9244: =item $Max2: The maximum value of the left Y-axis
                   9245: 
                   9246: =item %Values: hash indicating or overriding any default values which are 
                   9247: passed to graph.png.  
                   9248: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9249: 
                   9250: =back
                   9251: 
                   9252: Returns:
                   9253: 
                   9254: An <img> tag which references graph.png and the appropriate identifying
                   9255: information for the plot.
1.136     matthew  9256: 
                   9257: =cut
                   9258: 
                   9259: ############################################################
                   9260: ############################################################
1.137     matthew  9261: sub DrawXYYGraph {
                   9262:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9263:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9264:     #
                   9265:     # Create the identifier for the graph
                   9266:     my $identifier = &get_cgi_id();
                   9267:     my $id = 'cgi.'.$identifier;
                   9268:     #
                   9269:     $Title  = '' if (! defined($Title));
                   9270:     $xlabel = '' if (! defined($xlabel));
                   9271:     $ylabel = '' if (! defined($ylabel));
                   9272:     my %ValuesHash = 
                   9273:         (
1.369     www      9274:          $id.'.title'  => &escape($Title),
                   9275:          $id.'.xlabel' => &escape($xlabel),
                   9276:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9277:          $id.'.labels' => join(',',@$Xlabels),
                   9278:          $id.'.PlotType' => 'XY',
                   9279:          $id.'.NumSets' => 2,
1.137     matthew  9280:          $id.'.two_axes' => 1,
                   9281:          $id.'.y1_max_value' => $Max1,
                   9282:          $id.'.y1_min_value' => $Min1,
                   9283:          $id.'.y2_max_value' => $Max2,
                   9284:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9285:          );
                   9286:     #
1.137     matthew  9287:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9288:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9289:     }
                   9290:     #
                   9291:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9292:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9293:         return '';
                   9294:     }
                   9295:     my $NumSets=1;
1.137     matthew  9296:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9297:         next if (! ref($array));
                   9298:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9299:     }
                   9300:     #
                   9301:     # Deal with other parameters
                   9302:     while (my ($key,$value) = each(%Values)) {
                   9303:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9304:     }
                   9305:     #
1.646     raeburn  9306:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9307:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9308: }
                   9309: 
                   9310: ############################################################
                   9311: ############################################################
                   9312: 
                   9313: =pod
                   9314: 
1.157     matthew  9315: =back 
                   9316: 
1.139     matthew  9317: =head1 Statistics helper routines?  
                   9318: 
                   9319: Bad place for them but what the hell.
                   9320: 
1.157     matthew  9321: =over 4
                   9322: 
1.648     raeburn  9323: =item * &chartlink()
1.139     matthew  9324: 
                   9325: Returns a link to the chart for a specific student.  
                   9326: 
                   9327: Inputs:
                   9328: 
                   9329: =over 4
                   9330: 
                   9331: =item $linktext: The text of the link
                   9332: 
                   9333: =item $sname: The students username
                   9334: 
                   9335: =item $sdomain: The students domain
                   9336: 
                   9337: =back
                   9338: 
1.157     matthew  9339: =back
                   9340: 
1.139     matthew  9341: =cut
                   9342: 
                   9343: ############################################################
                   9344: ############################################################
                   9345: sub chartlink {
                   9346:     my ($linktext, $sname, $sdomain) = @_;
                   9347:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9348:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9349:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9350:        '">'.$linktext.'</a>';
1.153     matthew  9351: }
                   9352: 
                   9353: #######################################################
                   9354: #######################################################
                   9355: 
                   9356: =pod
                   9357: 
                   9358: =head1 Course Environment Routines
1.157     matthew  9359: 
                   9360: =over 4
1.153     matthew  9361: 
1.648     raeburn  9362: =item * &restore_course_settings()
1.153     matthew  9363: 
1.648     raeburn  9364: =item * &store_course_settings()
1.153     matthew  9365: 
                   9366: Restores/Store indicated form parameters from the course environment.
                   9367: Will not overwrite existing values of the form parameters.
                   9368: 
                   9369: Inputs: 
                   9370: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9371: 
                   9372: a hash ref describing the data to be stored.  For example:
                   9373:    
                   9374: %Save_Parameters = ('Status' => 'scalar',
                   9375:     'chartoutputmode' => 'scalar',
                   9376:     'chartoutputdata' => 'scalar',
                   9377:     'Section' => 'array',
1.373     raeburn  9378:     'Group' => 'array',
1.153     matthew  9379:     'StudentData' => 'array',
                   9380:     'Maps' => 'array');
                   9381: 
                   9382: Returns: both routines return nothing
                   9383: 
1.631     raeburn  9384: =back
                   9385: 
1.153     matthew  9386: =cut
                   9387: 
                   9388: #######################################################
                   9389: #######################################################
                   9390: sub store_course_settings {
1.496     albertel 9391:     return &store_settings($env{'request.course.id'},@_);
                   9392: }
                   9393: 
                   9394: sub store_settings {
1.153     matthew  9395:     # save to the environment
                   9396:     # appenv the same items, just to be safe
1.300     albertel 9397:     my $udom  = $env{'user.domain'};
                   9398:     my $uname = $env{'user.name'};
1.496     albertel 9399:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9400:     my %SaveHash;
                   9401:     my %AppHash;
                   9402:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9403:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9404:         my $envname = 'environment.'.$basename;
1.258     albertel 9405:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9406:             # Save this value away
                   9407:             if ($type eq 'scalar' &&
1.258     albertel 9408:                 (! exists($env{$envname}) || 
                   9409:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9410:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9411:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9412:             } elsif ($type eq 'array') {
                   9413:                 my $stored_form;
1.258     albertel 9414:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9415:                     $stored_form = join(',',
                   9416:                                         map {
1.369     www      9417:                                             &escape($_);
1.258     albertel 9418:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9419:                 } else {
                   9420:                     $stored_form = 
1.369     www      9421:                         &escape($env{'form.'.$setting});
1.153     matthew  9422:                 }
                   9423:                 # Determine if the array contents are the same.
1.258     albertel 9424:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9425:                     $SaveHash{$basename} = $stored_form;
                   9426:                     $AppHash{$envname}   = $stored_form;
                   9427:                 }
                   9428:             }
                   9429:         }
                   9430:     }
                   9431:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9432:                                           $udom,$uname);
1.153     matthew  9433:     if ($put_result !~ /^(ok|delayed)/) {
                   9434:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9435:                                  'got error:'.$put_result);
                   9436:     }
                   9437:     # Make sure these settings stick around in this session, too
1.646     raeburn  9438:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9439:     return;
                   9440: }
                   9441: 
                   9442: sub restore_course_settings {
1.499     albertel 9443:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9444: }
                   9445: 
                   9446: sub restore_settings {
                   9447:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9448:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9449:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9450:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9451:             '.'.$setting;
1.258     albertel 9452:         if (exists($env{$envname})) {
1.153     matthew  9453:             if ($type eq 'scalar') {
1.258     albertel 9454:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9455:             } elsif ($type eq 'array') {
1.258     albertel 9456:                 $env{'form.'.$setting} = [ 
1.153     matthew  9457:                                            map { 
1.369     www      9458:                                                &unescape($_); 
1.258     albertel 9459:                                            } split(',',$env{$envname})
1.153     matthew  9460:                                            ];
                   9461:             }
                   9462:         }
                   9463:     }
1.127     matthew  9464: }
                   9465: 
1.618     raeburn  9466: #######################################################
                   9467: #######################################################
                   9468: 
                   9469: =pod
                   9470: 
                   9471: =head1 Domain E-mail Routines  
                   9472: 
                   9473: =over 4
                   9474: 
1.648     raeburn  9475: =item * &build_recipient_list()
1.618     raeburn  9476: 
1.884     raeburn  9477: Build recipient lists for five types of e-mail:
1.766     raeburn  9478: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9479: (d) Help requests, (e) Course requests needing approval,  generated by
                   9480: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9481: loncoursequeueadmin.pm respectively.
1.618     raeburn  9482: 
                   9483: Inputs:
1.619     raeburn  9484: defmail (scalar - email address of default recipient), 
1.618     raeburn  9485: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9486: defdom (domain for which to retrieve configuration settings),
                   9487: origmail (scalar - email address of recipient from loncapa.conf, 
                   9488: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9489: 
1.655     raeburn  9490: Returns: comma separated list of addresses to which to send e-mail.
                   9491: 
                   9492: =back
1.618     raeburn  9493: 
                   9494: =cut
                   9495: 
                   9496: ############################################################
                   9497: ############################################################
                   9498: sub build_recipient_list {
1.619     raeburn  9499:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9500:     my @recipients;
                   9501:     my $otheremails;
                   9502:     my %domconfig =
                   9503:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9504:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9505:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9506:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9507:                 my @contacts = ('adminemail','supportemail');
                   9508:                 foreach my $item (@contacts) {
                   9509:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9510:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9511:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9512:                             push(@recipients,$addr);
                   9513:                         }
1.619     raeburn  9514:                     }
1.766     raeburn  9515:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9516:                 }
                   9517:             }
1.766     raeburn  9518:         } elsif ($origmail ne '') {
                   9519:             push(@recipients,$origmail);
1.618     raeburn  9520:         }
1.619     raeburn  9521:     } elsif ($origmail ne '') {
                   9522:         push(@recipients,$origmail);
1.618     raeburn  9523:     }
1.688     raeburn  9524:     if (defined($defmail)) {
                   9525:         if ($defmail ne '') {
                   9526:             push(@recipients,$defmail);
                   9527:         }
1.618     raeburn  9528:     }
                   9529:     if ($otheremails) {
1.619     raeburn  9530:         my @others;
                   9531:         if ($otheremails =~ /,/) {
                   9532:             @others = split(/,/,$otheremails);
1.618     raeburn  9533:         } else {
1.619     raeburn  9534:             push(@others,$otheremails);
                   9535:         }
                   9536:         foreach my $addr (@others) {
                   9537:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9538:                 push(@recipients,$addr);
                   9539:             }
1.618     raeburn  9540:         }
                   9541:     }
1.619     raeburn  9542:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9543:     return $recipientlist;
                   9544: }
                   9545: 
1.127     matthew  9546: ############################################################
                   9547: ############################################################
1.154     albertel 9548: 
1.655     raeburn  9549: =pod
                   9550: 
                   9551: =head1 Course Catalog Routines
                   9552: 
                   9553: =over 4
                   9554: 
                   9555: =item * &gather_categories()
                   9556: 
                   9557: Converts category definitions - keys of categories hash stored in  
                   9558: coursecategories in configuration.db on the primary library server in a 
                   9559: domain - to an array.  Also generates javascript and idx hash used to 
                   9560: generate Domain Coordinator interface for editing Course Categories.
                   9561: 
                   9562: Inputs:
1.663     raeburn  9563: 
1.655     raeburn  9564: categories (reference to hash of category definitions).
1.663     raeburn  9565: 
1.655     raeburn  9566: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9567:       categories and subcategories).
1.663     raeburn  9568: 
1.655     raeburn  9569: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9570:       editing Course Categories).
1.663     raeburn  9571: 
1.655     raeburn  9572: jsarray (reference to array of categories used to create Javascript arrays for
                   9573:          Domain Coordinator interface for editing Course Categories).
                   9574: 
                   9575: Returns: nothing
                   9576: 
                   9577: Side effects: populates cats, idx and jsarray. 
                   9578: 
                   9579: =cut
                   9580: 
                   9581: sub gather_categories {
                   9582:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9583:     my %counters;
                   9584:     my $num = 0;
                   9585:     foreach my $item (keys(%{$categories})) {
                   9586:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9587:         if ($container eq '' && $depth == 0) {
                   9588:             $cats->[$depth][$categories->{$item}] = $cat;
                   9589:         } else {
                   9590:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9591:         }
                   9592:         my ($escitem,$tail) = split(/:/,$item,2);
                   9593:         if ($counters{$tail} eq '') {
                   9594:             $counters{$tail} = $num;
                   9595:             $num ++;
                   9596:         }
                   9597:         if (ref($idx) eq 'HASH') {
                   9598:             $idx->{$item} = $counters{$tail};
                   9599:         }
                   9600:         if (ref($jsarray) eq 'ARRAY') {
                   9601:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9602:         }
                   9603:     }
                   9604:     return;
                   9605: }
                   9606: 
                   9607: =pod
                   9608: 
                   9609: =item * &extract_categories()
                   9610: 
                   9611: Used to generate breadcrumb trails for course categories.
                   9612: 
                   9613: Inputs:
1.663     raeburn  9614: 
1.655     raeburn  9615: categories (reference to hash of category definitions).
1.663     raeburn  9616: 
1.655     raeburn  9617: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9618:       categories and subcategories).
1.663     raeburn  9619: 
1.655     raeburn  9620: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9621: 
1.655     raeburn  9622: allitems (reference to hash - key is category key 
                   9623:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9624: 
1.655     raeburn  9625: idx (reference to hash of counters used in Domain Coordinator interface for
                   9626:       editing Course Categories).
1.663     raeburn  9627: 
1.655     raeburn  9628: jsarray (reference to array of categories used to create Javascript arrays for
                   9629:          Domain Coordinator interface for editing Course Categories).
                   9630: 
1.665     raeburn  9631: subcats (reference to hash of arrays containing all subcategories within each 
                   9632:          category, -recursive)
                   9633: 
1.655     raeburn  9634: Returns: nothing
                   9635: 
                   9636: Side effects: populates trails and allitems hash references.
                   9637: 
                   9638: =cut
                   9639: 
                   9640: sub extract_categories {
1.665     raeburn  9641:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9642:     if (ref($categories) eq 'HASH') {
                   9643:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9644:         if (ref($cats->[0]) eq 'ARRAY') {
                   9645:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9646:                 my $name = $cats->[0][$i];
                   9647:                 my $item = &escape($name).'::0';
                   9648:                 my $trailstr;
                   9649:                 if ($name eq 'instcode') {
                   9650:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9651:                 } else {
                   9652:                     $trailstr = $name;
                   9653:                 }
                   9654:                 if ($allitems->{$item} eq '') {
                   9655:                     push(@{$trails},$trailstr);
                   9656:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9657:                 }
                   9658:                 my @parents = ($name);
                   9659:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9660:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9661:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9662:                         if (ref($subcats) eq 'HASH') {
                   9663:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9664:                         }
                   9665:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9666:                     }
                   9667:                 } else {
                   9668:                     if (ref($subcats) eq 'HASH') {
                   9669:                         $subcats->{$item} = [];
1.655     raeburn  9670:                     }
                   9671:                 }
                   9672:             }
                   9673:         }
                   9674:     }
                   9675:     return;
                   9676: }
                   9677: 
                   9678: =pod
                   9679: 
                   9680: =item *&recurse_categories()
                   9681: 
                   9682: Recursively used to generate breadcrumb trails for course categories.
                   9683: 
                   9684: Inputs:
1.663     raeburn  9685: 
1.655     raeburn  9686: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9687:       categories and subcategories).
1.663     raeburn  9688: 
1.655     raeburn  9689: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9690: 
                   9691: category (current course category, for which breadcrumb trail is being generated).
                   9692: 
                   9693: trails (reference to array of breadcrumb trails for each category).
                   9694: 
1.655     raeburn  9695: allitems (reference to hash - key is category key
                   9696:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9697: 
1.655     raeburn  9698: parents (array containing containers directories for current category, 
                   9699:          back to top level). 
                   9700: 
                   9701: Returns: nothing
                   9702: 
                   9703: Side effects: populates trails and allitems hash references
                   9704: 
                   9705: =cut
                   9706: 
                   9707: sub recurse_categories {
1.665     raeburn  9708:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9709:     my $shallower = $depth - 1;
                   9710:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9711:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9712:             my $name = $cats->[$depth]{$category}[$k];
                   9713:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9714:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9715:             if ($allitems->{$item} eq '') {
                   9716:                 push(@{$trails},$trailstr);
                   9717:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9718:             }
                   9719:             my $deeper = $depth+1;
                   9720:             push(@{$parents},$category);
1.665     raeburn  9721:             if (ref($subcats) eq 'HASH') {
                   9722:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9723:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9724:                     my $higher;
                   9725:                     if ($j > 0) {
                   9726:                         $higher = &escape($parents->[$j]).':'.
                   9727:                                   &escape($parents->[$j-1]).':'.$j;
                   9728:                     } else {
                   9729:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9730:                     }
                   9731:                     push(@{$subcats->{$higher}},$subcat);
                   9732:                 }
                   9733:             }
                   9734:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9735:                                 $subcats);
1.655     raeburn  9736:             pop(@{$parents});
                   9737:         }
                   9738:     } else {
                   9739:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9740:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9741:         if ($allitems->{$item} eq '') {
                   9742:             push(@{$trails},$trailstr);
                   9743:             $allitems->{$item} = scalar(@{$trails})-1;
                   9744:         }
                   9745:     }
                   9746:     return;
                   9747: }
                   9748: 
1.663     raeburn  9749: =pod
                   9750: 
                   9751: =item *&assign_categories_table()
                   9752: 
                   9753: Create a datatable for display of hierarchical categories in a domain,
                   9754: with checkboxes to allow a course to be categorized. 
                   9755: 
                   9756: Inputs:
                   9757: 
                   9758: cathash - reference to hash of categories defined for the domain (from
                   9759:           configuration.db)
                   9760: 
                   9761: currcat - scalar with an & separated list of categories assigned to a course. 
                   9762: 
                   9763: Returns: $output (markup to be displayed) 
                   9764: 
                   9765: =cut
                   9766: 
                   9767: sub assign_categories_table {
                   9768:     my ($cathash,$currcat) = @_;
                   9769:     my $output;
                   9770:     if (ref($cathash) eq 'HASH') {
                   9771:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9772:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9773:         $maxdepth = scalar(@cats);
                   9774:         if (@cats > 0) {
                   9775:             my $itemcount = 0;
                   9776:             if (ref($cats[0]) eq 'ARRAY') {
                   9777:                 $output = &Apache::loncommon::start_data_table();
                   9778:                 my @currcategories;
                   9779:                 if ($currcat ne '') {
                   9780:                     @currcategories = split('&',$currcat);
                   9781:                 }
                   9782:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9783:                     my $parent = $cats[0][$i];
                   9784:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9785:                     next if ($parent eq 'instcode');
                   9786:                     my $item = &escape($parent).'::0';
                   9787:                     my $checked = '';
                   9788:                     if (@currcategories > 0) {
                   9789:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9790:                             $checked = ' checked="checked"';
1.663     raeburn  9791:                         }
                   9792:                     }
1.675     raeburn  9793:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9794:                                '<input type="checkbox" name="usecategory" value="'.
                   9795:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9796:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9797:                     my $depth = 1;
                   9798:                     push(@path,$parent);
                   9799:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9800:                     pop(@path);
                   9801:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9802:                     $itemcount ++;
                   9803:                 }
                   9804:                 $output .= &Apache::loncommon::end_data_table();
                   9805:             }
                   9806:         }
                   9807:     }
                   9808:     return $output;
                   9809: }
                   9810: 
                   9811: =pod
                   9812: 
                   9813: =item *&assign_category_rows()
                   9814: 
                   9815: Create a datatable row for display of nested categories in a domain,
                   9816: with checkboxes to allow a course to be categorized,called recursively.
                   9817: 
                   9818: Inputs:
                   9819: 
                   9820: itemcount - track row number for alternating colors
                   9821: 
                   9822: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9823:       categories and subcategories.
                   9824: 
                   9825: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9826: 
                   9827: parent - parent of current category item
                   9828: 
                   9829: path - Array containing all categories back up through the hierarchy from the
                   9830:        current category to the top level.
                   9831: 
                   9832: currcategories - reference to array of current categories assigned to the course
                   9833: 
                   9834: Returns: $output (markup to be displayed).
                   9835: 
                   9836: =cut
                   9837: 
                   9838: sub assign_category_rows {
                   9839:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9840:     my ($text,$name,$item,$chgstr);
                   9841:     if (ref($cats) eq 'ARRAY') {
                   9842:         my $maxdepth = scalar(@{$cats});
                   9843:         if (ref($cats->[$depth]) eq 'HASH') {
                   9844:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9845:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9846:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9847:                 $text .= '<td><table class="LC_datatable">';
                   9848:                 for (my $j=0; $j<$numchildren; $j++) {
                   9849:                     $name = $cats->[$depth]{$parent}[$j];
                   9850:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9851:                     my $deeper = $depth+1;
                   9852:                     my $checked = '';
                   9853:                     if (ref($currcategories) eq 'ARRAY') {
                   9854:                         if (@{$currcategories} > 0) {
                   9855:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9856:                                 $checked = ' checked="checked"';
1.663     raeburn  9857:                             }
                   9858:                         }
                   9859:                     }
1.664     raeburn  9860:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9861:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9862:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9863:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9864:                              '</td><td>';
1.663     raeburn  9865:                     if (ref($path) eq 'ARRAY') {
                   9866:                         push(@{$path},$name);
                   9867:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9868:                         pop(@{$path});
                   9869:                     }
                   9870:                     $text .= '</td></tr>';
                   9871:                 }
                   9872:                 $text .= '</table></td>';
                   9873:             }
                   9874:         }
                   9875:     }
                   9876:     return $text;
                   9877: }
                   9878: 
1.655     raeburn  9879: ############################################################
                   9880: ############################################################
                   9881: 
                   9882: 
1.443     albertel 9883: sub commit_customrole {
1.664     raeburn  9884:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9885:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9886:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9887:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9888:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9889:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9890:                  '</b><br />';
                   9891:     return $output;
                   9892: }
                   9893: 
                   9894: sub commit_standardrole {
1.541     raeburn  9895:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9896:     my ($output,$logmsg,$linefeed);
                   9897:     if ($context eq 'auto') {
                   9898:         $linefeed = "\n";
                   9899:     } else {
                   9900:         $linefeed = "<br />\n";
                   9901:     }  
1.443     albertel 9902:     if ($three eq 'st') {
1.541     raeburn  9903:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9904:                                          $one,$two,$sec,$context);
                   9905:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9906:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9907:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9908:         } else {
1.541     raeburn  9909:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9910:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9911:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9912:             if ($context eq 'auto') {
                   9913:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9914:             } else {
                   9915:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9916:                &mt('Add to classlist').': <b>ok</b>';
                   9917:             }
                   9918:             $output .= $linefeed;
1.443     albertel 9919:         }
                   9920:     } else {
                   9921:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9922:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9923:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9924:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9925:         if ($context eq 'auto') {
                   9926:             $output .= $result.$linefeed;
                   9927:         } else {
                   9928:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9929:         }
1.443     albertel 9930:     }
                   9931:     return $output;
                   9932: }
                   9933: 
                   9934: sub commit_studentrole {
1.541     raeburn  9935:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9936:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9937:     if ($context eq 'auto') {
                   9938:         $linefeed = "\n";
                   9939:     } else {
                   9940:         $linefeed = '<br />'."\n";
                   9941:     }
1.443     albertel 9942:     if (defined($one) && defined($two)) {
                   9943:         my $cid=$one.'_'.$two;
                   9944:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9945:         my $secchange = 0;
                   9946:         my $expire_role_result;
                   9947:         my $modify_section_result;
1.628     raeburn  9948:         if ($oldsec ne '-1') { 
                   9949:             if ($oldsec ne $sec) {
1.443     albertel 9950:                 $secchange = 1;
1.628     raeburn  9951:                 my $now = time;
1.443     albertel 9952:                 my $uurl='/'.$cid;
                   9953:                 $uurl=~s/\_/\//g;
                   9954:                 if ($oldsec) {
                   9955:                     $uurl.='/'.$oldsec;
                   9956:                 }
1.626     raeburn  9957:                 $oldsecurl = $uurl;
1.628     raeburn  9958:                 $expire_role_result = 
1.652     raeburn  9959:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9960:                 if ($env{'request.course.sec'} ne '') { 
                   9961:                     if ($expire_role_result eq 'refused') {
                   9962:                         my @roles = ('st');
                   9963:                         my @statuses = ('previous');
                   9964:                         my @roledoms = ($one);
                   9965:                         my $withsec = 1;
                   9966:                         my %roleshash = 
                   9967:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9968:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9969:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9970:                             my ($oldstart,$oldend) = 
                   9971:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9972:                             if ($oldend > 0 && $oldend <= $now) {
                   9973:                                 $expire_role_result = 'ok';
                   9974:                             }
                   9975:                         }
                   9976:                     }
                   9977:                 }
1.443     albertel 9978:                 $result = $expire_role_result;
                   9979:             }
                   9980:         }
                   9981:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9982:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9983:             if ($modify_section_result =~ /^ok/) {
                   9984:                 if ($secchange == 1) {
1.628     raeburn  9985:                     if ($sec eq '') {
                   9986:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9987:                     } else {
                   9988:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9989:                     }
1.443     albertel 9990:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9991:                     if ($sec eq '') {
                   9992:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9993:                     } else {
                   9994:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9995:                     }
1.443     albertel 9996:                 } else {
1.628     raeburn  9997:                     if ($sec eq '') {
                   9998:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9999:                     } else {
                   10000:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   10001:                     }
1.443     albertel 10002:                 }
                   10003:             } else {
1.628     raeburn  10004:                 if ($secchange) {       
                   10005:                     $$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;
                   10006:                 } else {
                   10007:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   10008:                 }
1.443     albertel 10009:             }
                   10010:             $result = $modify_section_result;
                   10011:         } elsif ($secchange == 1) {
1.628     raeburn  10012:             if ($oldsec eq '') {
                   10013:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   10014:             } else {
                   10015:                 $$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;
                   10016:             }
1.626     raeburn  10017:             if ($expire_role_result eq 'refused') {
                   10018:                 my $newsecurl = '/'.$cid;
                   10019:                 $newsecurl =~ s/\_/\//g;
                   10020:                 if ($sec ne '') {
                   10021:                     $newsecurl.='/'.$sec;
                   10022:                 }
                   10023:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   10024:                     if ($sec eq '') {
                   10025:                         $$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;
                   10026:                     } else {
                   10027:                         $$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;
                   10028:                     }
                   10029:                 }
                   10030:             }
1.443     albertel 10031:         }
                   10032:     } else {
1.626     raeburn  10033:         $$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 10034:         $result = "error: incomplete course id\n";
                   10035:     }
                   10036:     return $result;
                   10037: }
                   10038: 
                   10039: ############################################################
                   10040: ############################################################
                   10041: 
1.566     albertel 10042: sub check_clone {
1.578     raeburn  10043:     my ($args,$linefeed) = @_;
1.566     albertel 10044:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10045:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10046:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10047:     my $clonemsg;
                   10048:     my $can_clone = 0;
1.908     raeburn  10049:     my $lctype = lc($args->{'type'});
                   10050:     if ($lctype ne 'community') {
                   10051:         $lctype = 'course';
                   10052:     }
1.566     albertel 10053:     if ($clonehome eq 'no_host') {
1.908     raeburn  10054:         if ($args->{'type'} eq 'Community') {
                   10055:             $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'});
                   10056:         } else {
                   10057:             $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'});
                   10058:         }     
1.566     albertel 10059:     } else {
                   10060: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908     raeburn  10061:         if ($args->{'type'} eq 'Community') {
                   10062:             if ($clonedesc{'type'} ne 'Community') {
                   10063:                  $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'});
                   10064:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10065:             }
                   10066:         }
1.882     raeburn  10067: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10068:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10069: 	    $can_clone = 1;
                   10070: 	} else {
                   10071: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10072: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10073: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10074:             if (grep(/^\*$/,@cloners)) {
                   10075:                 $can_clone = 1;
                   10076:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10077:                 $can_clone = 1;
                   10078:             } else {
1.908     raeburn  10079:                 my $ccrole = 'cc';
                   10080:                 if ($args->{'type'} eq 'Community') {
                   10081:                     $ccrole = 'co';
                   10082:                 }
1.578     raeburn  10083: 	        my %roleshash =
                   10084: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10085: 					 $args->{'ccdomain'},
1.908     raeburn  10086:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10087: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10088: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10089: 		    $can_clone = 1;
                   10090: 	        } else {
1.908     raeburn  10091:                     if ($args->{'type'} eq 'Community') {
                   10092:                         $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'});
                   10093:                     } else {
                   10094:                         $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'});
                   10095:                     }
1.578     raeburn  10096: 	        }
1.566     albertel 10097: 	    }
1.578     raeburn  10098:         }
1.566     albertel 10099:     }
                   10100:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10101: }
                   10102: 
1.444     albertel 10103: sub construct_course {
1.885     raeburn  10104:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10105:     my $outcome;
1.541     raeburn  10106:     my $linefeed =  '<br />'."\n";
                   10107:     if ($context eq 'auto') {
                   10108:         $linefeed = "\n";
                   10109:     }
1.566     albertel 10110: 
                   10111: #
                   10112: # Are we cloning?
                   10113: #
                   10114:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10115:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10116: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10117: 	if ($context ne 'auto') {
1.578     raeburn  10118:             if ($clonemsg ne '') {
                   10119: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10120:             }
1.566     albertel 10121: 	}
                   10122: 	$outcome .= $clonemsg.$linefeed;
                   10123: 
                   10124:         if (!$can_clone) {
                   10125: 	    return (0,$outcome);
                   10126: 	}
                   10127:     }
                   10128: 
1.444     albertel 10129: #
                   10130: # Open course
                   10131: #
                   10132:     my $crstype = lc($args->{'crstype'});
                   10133:     my %cenv=();
                   10134:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10135:                                              $args->{'cdescr'},
                   10136:                                              $args->{'curl'},
                   10137:                                              $args->{'course_home'},
                   10138:                                              $args->{'nonstandard'},
                   10139:                                              $args->{'crscode'},
                   10140:                                              $args->{'ccuname'}.':'.
                   10141:                                              $args->{'ccdomain'},
1.882     raeburn  10142:                                              $args->{'crstype'},
1.885     raeburn  10143:                                              $cnum,$context,$category);
1.444     albertel 10144: 
                   10145:     # Note: The testing routines depend on this being output; see 
                   10146:     # Utils::Course. This needs to at least be output as a comment
                   10147:     # if anyone ever decides to not show this, and Utils::Course::new
                   10148:     # will need to be suitably modified.
1.541     raeburn  10149:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10150: #
                   10151: # Check if created correctly
                   10152: #
1.479     albertel 10153:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10154:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10155:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10156: 
1.444     albertel 10157: #
1.566     albertel 10158: # Do the cloning
                   10159: #   
                   10160:     if ($can_clone && $cloneid) {
                   10161: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10162: 	if ($context ne 'auto') {
                   10163: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10164: 	}
                   10165: 	$outcome .= $clonemsg.$linefeed;
                   10166: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10167: # Copy all files
1.637     www      10168: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10169: # Restore URL
1.566     albertel 10170: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10171: # Restore title
1.566     albertel 10172: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10173: # Mark as cloned
1.566     albertel 10174: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10175: # Need to clone grading mode
                   10176:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10177:         $cenv{'grading'}=$newenv{'grading'};
                   10178: # Do not clone these environment entries
                   10179:         &Apache::lonnet::del('environment',
                   10180:                   ['default_enrollment_start_date',
                   10181:                    'default_enrollment_end_date',
                   10182:                    'question.email',
                   10183:                    'policy.email',
                   10184:                    'comment.email',
                   10185:                    'pch.users.denied',
1.725     raeburn  10186:                    'plc.users.denied',
                   10187:                    'hidefromcat',
                   10188:                    'categories'],
1.638     www      10189:                    $$crsudom,$$crsunum);
1.444     albertel 10190:     }
1.566     albertel 10191: 
1.444     albertel 10192: #
                   10193: # Set environment (will override cloned, if existing)
                   10194: #
                   10195:     my @sections = ();
                   10196:     my @xlists = ();
                   10197:     if ($args->{'crstype'}) {
                   10198:         $cenv{'type'}=$args->{'crstype'};
                   10199:     }
                   10200:     if ($args->{'crsid'}) {
                   10201:         $cenv{'courseid'}=$args->{'crsid'};
                   10202:     }
                   10203:     if ($args->{'crscode'}) {
                   10204:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10205:     }
                   10206:     if ($args->{'crsquota'} ne '') {
                   10207:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10208:     } else {
                   10209:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10210:     }
                   10211:     if ($args->{'ccuname'}) {
                   10212:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10213:                                         ':'.$args->{'ccdomain'};
                   10214:     } else {
                   10215:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10216:     }
                   10217:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10218:     if ($args->{'crssections'}) {
                   10219:         $cenv{'internal.sectionnums'} = '';
                   10220:         if ($args->{'crssections'} =~ m/,/) {
                   10221:             @sections = split/,/,$args->{'crssections'};
                   10222:         } else {
                   10223:             $sections[0] = $args->{'crssections'};
                   10224:         }
                   10225:         if (@sections > 0) {
                   10226:             foreach my $item (@sections) {
                   10227:                 my ($sec,$gp) = split/:/,$item;
                   10228:                 my $class = $args->{'crscode'}.$sec;
                   10229:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10230:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10231:                 unless ($addcheck eq 'ok') {
                   10232:                     push @badclasses, $class;
                   10233:                 }
                   10234:             }
                   10235:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10236:         }
                   10237:     }
                   10238: # do not hide course coordinator from staff listing, 
                   10239: # even if privileged
                   10240:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10241: # add crosslistings
                   10242:     if ($args->{'crsxlist'}) {
                   10243:         $cenv{'internal.crosslistings'}='';
                   10244:         if ($args->{'crsxlist'} =~ m/,/) {
                   10245:             @xlists = split/,/,$args->{'crsxlist'};
                   10246:         } else {
                   10247:             $xlists[0] = $args->{'crsxlist'};
                   10248:         }
                   10249:         if (@xlists > 0) {
                   10250:             foreach my $item (@xlists) {
                   10251:                 my ($xl,$gp) = split/:/,$item;
                   10252:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10253:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10254:                 unless ($addcheck eq 'ok') {
                   10255:                     push @badclasses, $xl;
                   10256:                 }
                   10257:             }
                   10258:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10259:         }
                   10260:     }
                   10261:     if ($args->{'autoadds'}) {
                   10262:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10263:     }
                   10264:     if ($args->{'autodrops'}) {
                   10265:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10266:     }
                   10267: # check for notification of enrollment changes
                   10268:     my @notified = ();
                   10269:     if ($args->{'notify_owner'}) {
                   10270:         if ($args->{'ccuname'} ne '') {
                   10271:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10272:         }
                   10273:     }
                   10274:     if ($args->{'notify_dc'}) {
                   10275:         if ($uname ne '') { 
1.630     raeburn  10276:             push(@notified,$uname.':'.$udom);
1.444     albertel 10277:         }
                   10278:     }
                   10279:     if (@notified > 0) {
                   10280:         my $notifylist;
                   10281:         if (@notified > 1) {
                   10282:             $notifylist = join(',',@notified);
                   10283:         } else {
                   10284:             $notifylist = $notified[0];
                   10285:         }
                   10286:         $cenv{'internal.notifylist'} = $notifylist;
                   10287:     }
                   10288:     if (@badclasses > 0) {
                   10289:         my %lt=&Apache::lonlocal::texthash(
                   10290:                 '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',
                   10291:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10292:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10293:         );
1.541     raeburn  10294:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10295:                            ' ('.$lt{'adby'}.')';
                   10296:         if ($context eq 'auto') {
                   10297:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10298:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10299:             foreach my $item (@badclasses) {
                   10300:                 if ($context eq 'auto') {
                   10301:                     $outcome .= " - $item\n";
                   10302:                 } else {
                   10303:                     $outcome .= "<li>$item</li>\n";
                   10304:                 }
                   10305:             }
                   10306:             if ($context eq 'auto') {
                   10307:                 $outcome .= $linefeed;
                   10308:             } else {
1.566     albertel 10309:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10310:             }
                   10311:         } 
1.444     albertel 10312:     }
                   10313:     if ($args->{'no_end_date'}) {
                   10314:         $args->{'endaccess'} = 0;
                   10315:     }
                   10316:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10317:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10318:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10319:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10320:     if ($args->{'showphotos'}) {
                   10321:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10322:     }
                   10323:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10324:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10325:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10326:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10327:             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'); 
                   10328:             if ($context eq 'auto') {
                   10329:                 $outcome .= $krb_msg;
                   10330:             } else {
1.566     albertel 10331:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10332:             }
                   10333:             $outcome .= $linefeed;
1.444     albertel 10334:         }
                   10335:     }
                   10336:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10337:        if ($args->{'setpolicy'}) {
                   10338:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10339:        }
                   10340:        if ($args->{'setcontent'}) {
                   10341:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10342:        }
                   10343:     }
                   10344:     if ($args->{'reshome'}) {
                   10345: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10346: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10347:     }
                   10348: #
                   10349: # course has keyed access
                   10350: #
                   10351:     if ($args->{'setkeys'}) {
                   10352:        $cenv{'keyaccess'}='yes';
                   10353:     }
                   10354: # if specified, key authority is not course, but user
                   10355: # only active if keyaccess is yes
                   10356:     if ($args->{'keyauth'}) {
1.487     albertel 10357: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10358: 	$user = &LONCAPA::clean_username($user);
                   10359: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10360: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10361: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10362: 	}
                   10363:     }
                   10364: 
                   10365:     if ($args->{'disresdis'}) {
                   10366:         $cenv{'pch.roles.denied'}='st';
                   10367:     }
                   10368:     if ($args->{'disablechat'}) {
                   10369:         $cenv{'plc.roles.denied'}='st';
                   10370:     }
                   10371: 
                   10372:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10373:     # course
                   10374:     $cenv{'course.helper.not.run'} = 1;
                   10375:     #
                   10376:     # Use new Randomseed
                   10377:     #
                   10378:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10379:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10380:     #
                   10381:     # The encryption code and receipt prefix for this course
                   10382:     #
                   10383:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10384:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10385:     #
                   10386:     # By default, use standard grading
                   10387:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10388: 
1.541     raeburn  10389:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10390:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10391: #
                   10392: # Open all assignments
                   10393: #
                   10394:     if ($args->{'openall'}) {
                   10395:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10396:        my %storecontent = ($storeunder         => time,
                   10397:                            $storeunder.'.type' => 'date_start');
                   10398:        
                   10399:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10400:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10401:    }
                   10402: #
                   10403: # Set first page
                   10404: #
                   10405:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10406: 	    || ($cloneid)) {
1.445     albertel 10407: 	use LONCAPA::map;
1.444     albertel 10408: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10409: 
                   10410: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10411:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10412: 
1.444     albertel 10413:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10414:         my $title; my $url;
                   10415:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10416: 	    $title=&mt('Syllabus');
1.444     albertel 10417:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10418:         } else {
1.690     bisitz   10419:             $title=&mt('Navigate Contents');
1.444     albertel 10420:             $url='/adm/navmaps';
                   10421:         }
1.445     albertel 10422: 
                   10423:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10424: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10425: 
                   10426: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10427:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10428:     }
1.566     albertel 10429: 
                   10430:     return (1,$outcome);
1.444     albertel 10431: }
                   10432: 
                   10433: ############################################################
                   10434: ############################################################
                   10435: 
1.378     raeburn  10436: sub course_type {
                   10437:     my ($cid) = @_;
                   10438:     if (!defined($cid)) {
                   10439:         $cid = $env{'request.course.id'};
                   10440:     }
1.404     albertel 10441:     if (defined($env{'course.'.$cid.'.type'})) {
                   10442:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10443:     } else {
                   10444:         return 'Course';
1.377     raeburn  10445:     }
                   10446: }
1.156     albertel 10447: 
1.406     raeburn  10448: sub group_term {
                   10449:     my $crstype = &course_type();
                   10450:     my %names = (
                   10451:                   'Course' => 'group',
1.865     raeburn  10452:                   'Community' => 'group',
1.406     raeburn  10453:                 );
                   10454:     return $names{$crstype};
                   10455: }
                   10456: 
1.902     raeburn  10457: sub course_types {
                   10458:     my @types = ('official','unofficial','community');
                   10459:     my %typename = (
                   10460:                          official   => 'Official course',
                   10461:                          unofficial => 'Unofficial course',
                   10462:                          community  => 'Community',
                   10463:                    );
                   10464:     return (\@types,\%typename);
                   10465: }
                   10466: 
1.156     albertel 10467: sub icon {
                   10468:     my ($file)=@_;
1.505     albertel 10469:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10470:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10471:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10472:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10473: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10474: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10475: 	            $curfext.".gif") {
                   10476: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10477: 		$curfext.".gif";
                   10478: 	}
                   10479:     }
1.249     albertel 10480:     return &lonhttpdurl($iconname);
1.154     albertel 10481: } 
1.84      albertel 10482: 
1.575     albertel 10483: sub lonhttpdurl {
1.692     www      10484: #
                   10485: # Had been used for "small fry" static images on separate port 8080.
                   10486: # Modify here if lightweight http functionality desired again.
                   10487: # Currently eliminated due to increasing firewall issues.
                   10488: #
1.575     albertel 10489:     my ($url)=@_;
1.692     www      10490:     return $url;
1.215     albertel 10491: }
                   10492: 
1.213     albertel 10493: sub connection_aborted {
                   10494:     my ($r)=@_;
                   10495:     $r->print(" ");$r->rflush();
                   10496:     my $c = $r->connection;
                   10497:     return $c->aborted();
                   10498: }
                   10499: 
1.221     foxr     10500: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10501: #    strings as 'strings'.
                   10502: sub escape_single {
1.221     foxr     10503:     my ($input) = @_;
1.223     albertel 10504:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10505:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10506:     return $input;
                   10507: }
1.223     albertel 10508: 
1.222     foxr     10509: #  Same as escape_single, but escape's "'s  This 
                   10510: #  can be used for  "strings"
                   10511: sub escape_double {
                   10512:     my ($input) = @_;
                   10513:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10514:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10515:     return $input;
                   10516: }
1.223     albertel 10517:  
1.222     foxr     10518: #   Escapes the last element of a full URL.
                   10519: sub escape_url {
                   10520:     my ($url)   = @_;
1.238     raeburn  10521:     my @urlslices = split(/\//, $url,-1);
1.369     www      10522:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10523:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10524: }
1.462     albertel 10525: 
1.820     raeburn  10526: sub compare_arrays {
                   10527:     my ($arrayref1,$arrayref2) = @_;
                   10528:     my (@difference,%count);
                   10529:     @difference = ();
                   10530:     %count = ();
                   10531:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10532:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10533:         foreach my $element (keys(%count)) {
                   10534:             if ($count{$element} == 1) {
                   10535:                 push(@difference,$element);
                   10536:             }
                   10537:         }
                   10538:     }
                   10539:     return @difference;
                   10540: }
                   10541: 
1.817     bisitz   10542: # -------------------------------------------------------- Initialize user login
1.462     albertel 10543: sub init_user_environment {
1.463     albertel 10544:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10545:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10546: 
                   10547:     my $public=($username eq 'public' && $domain eq 'public');
                   10548: 
                   10549: # See if old ID present, if so, remove
                   10550: 
                   10551:     my ($filename,$cookie,$userroles);
                   10552:     my $now=time;
                   10553: 
                   10554:     if ($public) {
                   10555: 	my $max_public=100;
                   10556: 	my $oldest;
                   10557: 	my $oldest_time=0;
                   10558: 	for(my $next=1;$next<=$max_public;$next++) {
                   10559: 	    if (-e $lonids."/publicuser_$next.id") {
                   10560: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10561: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10562: 		    $oldest_time=$mtime;
                   10563: 		    $oldest=$next;
                   10564: 		}
                   10565: 	    } else {
                   10566: 		$cookie="publicuser_$next";
                   10567: 		last;
                   10568: 	    }
                   10569: 	}
                   10570: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10571:     } else {
1.463     albertel 10572: 	# if this isn't a robot, kill any existing non-robot sessions
                   10573: 	if (!$args->{'robot'}) {
                   10574: 	    opendir(DIR,$lonids);
                   10575: 	    while ($filename=readdir(DIR)) {
                   10576: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10577: 		    unlink($lonids.'/'.$filename);
                   10578: 		}
1.462     albertel 10579: 	    }
1.463     albertel 10580: 	    closedir(DIR);
1.462     albertel 10581: 	}
                   10582: # Give them a new cookie
1.463     albertel 10583: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10584: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10585: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10586:     
                   10587: # Initialize roles
                   10588: 
                   10589: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10590:     }
                   10591: # ------------------------------------ Check browser type and MathML capability
                   10592: 
                   10593:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10594:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10595: 
                   10596: # ------------------------------------------------------------- Get environment
                   10597: 
                   10598:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10599:     my ($tmp) = keys(%userenv);
                   10600:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10601: 	# default remote control to off
                   10602: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10603:     } else {
                   10604: 	undef(%userenv);
                   10605:     }
                   10606:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10607: 	$form->{'interface'}=$userenv{'interface'};
                   10608:     }
                   10609:     $env{'environment.remote'}=$userenv{'remote'};
                   10610:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10611: 
                   10612: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10613:     foreach my $option ('interface','localpath','localres') {
                   10614:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10615:     }
                   10616: # --------------------------------------------------------- Write first profile
                   10617: 
                   10618:     {
                   10619: 	my %initial_env = 
                   10620: 	    ("user.name"          => $username,
                   10621: 	     "user.domain"        => $domain,
                   10622: 	     "user.home"          => $authhost,
                   10623: 	     "browser.type"       => $clientbrowser,
                   10624: 	     "browser.version"    => $clientversion,
                   10625: 	     "browser.mathml"     => $clientmathml,
                   10626: 	     "browser.unicode"    => $clientunicode,
                   10627: 	     "browser.os"         => $clientos,
                   10628: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10629: 	     "request.course.fn"  => '',
                   10630: 	     "request.course.uri" => '',
                   10631: 	     "request.course.sec" => '',
                   10632: 	     "request.role"       => 'cm',
                   10633: 	     "request.role.adv"   => $env{'user.adv'},
                   10634: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10635: 
                   10636:         if ($form->{'localpath'}) {
                   10637: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10638: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10639:         }
                   10640: 	
                   10641: 	if ($public) {
                   10642: 	    $initial_env{"environment.remote"} = "off";
                   10643: 	}
                   10644: 	if ($form->{'interface'}) {
                   10645: 	    $form->{'interface'}=~s/\W//gs;
                   10646: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10647: 	    $env{'browser.interface'}=$form->{'interface'};
                   10648: 	}
                   10649: 
1.724     raeburn  10650:         foreach my $tool ('aboutme','blog','portfolio') {
                   10651:             $userenv{'availabletools.'.$tool} = 
                   10652:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10653:         }
                   10654: 
1.864     raeburn  10655:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10656:             $userenv{'canrequest.'.$crstype} =
                   10657:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10658:                                                   'reload','requestcourses');
                   10659:         }
                   10660: 
1.462     albertel 10661: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10662: 	
                   10663: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10664: 		 &GDBM_WRCREAT(),0640)) {
                   10665: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10666: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10667: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10668: 	    if (ref($args->{'extra_env'})) {
                   10669: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10670: 	    }
1.462     albertel 10671: 	    untie(%disk_env);
                   10672: 	} else {
1.705     tempelho 10673: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10674: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10675: 	    return 'error: '.$!;
                   10676: 	}
                   10677:     }
                   10678:     $env{'request.role'}='cm';
                   10679:     $env{'request.role.adv'}=$env{'user.adv'};
                   10680:     $env{'browser.type'}=$clientbrowser;
                   10681: 
                   10682:     return $cookie;
                   10683: 
                   10684: }
                   10685: 
                   10686: sub _add_to_env {
                   10687:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10688:     if (ref($env_data) eq 'HASH') {
                   10689:         while (my ($key,$value) = each(%$env_data)) {
                   10690: 	    $idf->{$prefix.$key} = $value;
                   10691: 	    $env{$prefix.$key}   = $value;
                   10692:         }
1.462     albertel 10693:     }
                   10694: }
                   10695: 
1.685     tempelho 10696: # --- Get the symbolic name of a problem and the url
                   10697: sub get_symb {
                   10698:     my ($request,$silent) = @_;
1.726     raeburn  10699:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10700:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10701:     if ($symb eq '') {
                   10702:         if (!$silent) {
                   10703:             $request->print("Unable to handle ambiguous references:$url:.");
                   10704:             return ();
                   10705:         }
                   10706:     }
                   10707:     &Apache::lonenc::check_decrypt(\$symb);
                   10708:     return ($symb);
                   10709: }
                   10710: 
                   10711: # --------------------------------------------------------------Get annotation
                   10712: 
                   10713: sub get_annotation {
                   10714:     my ($symb,$enc) = @_;
                   10715: 
                   10716:     my $key = $symb;
                   10717:     if (!$enc) {
                   10718:         $key =
                   10719:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10720:     }
                   10721:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10722:     return $annotation{$key};
                   10723: }
                   10724: 
                   10725: sub clean_symb {
1.731     raeburn  10726:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10727: 
                   10728:     &Apache::lonenc::check_decrypt(\$symb);
                   10729:     my $enc = $env{'request.enc'};
1.731     raeburn  10730:     if ($delete_enc) {
1.730     raeburn  10731:         delete($env{'request.enc'});
                   10732:     }
1.685     tempelho 10733: 
                   10734:     return ($symb,$enc);
                   10735: }
1.462     albertel 10736: 
1.41      ng       10737: =pod
                   10738: 
                   10739: =back
                   10740: 
1.112     bowersj2 10741: =cut
1.41      ng       10742: 
1.112     bowersj2 10743: 1;
                   10744: __END__;
1.41      ng       10745: 

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