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

1.10      albertel    1: # The LearningOnline Network with CAPA
1.1       albertel    2: # a pile of common routines
1.10      albertel    3: #
1.915   ! droeschl    4: # $Id: loncommon.pm,v 1.914 2009/11/14 04:03:00 faziophi Exp $
1.10      albertel    5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.1       albertel   28: 
                     29: # Makes a table out of the previous attempts
1.2       albertel   30: # Inputs result_from_symbread, user, domain, course_id
1.16      harris41   31: # Reads in non-network-related .tab files
1.1       albertel   32: 
1.35      matthew    33: # POD header:
                     34: 
1.45      matthew    35: =pod
                     36: 
1.35      matthew    37: =head1 NAME
                     38: 
                     39: Apache::loncommon - pile of common routines
                     40: 
                     41: =head1 SYNOPSIS
                     42: 
1.112     bowersj2   43: Common routines for manipulating connections, student answers,
                     44:     domains, common Javascript fragments, etc.
1.35      matthew    45: 
1.112     bowersj2   46: =head1 OVERVIEW
1.35      matthew    47: 
1.112     bowersj2   48: A collection of commonly used subroutines that don't have a natural
                     49: home anywhere else. This collection helps remove
1.35      matthew    50: redundancy from other modules and increase efficiency of memory usage.
                     51: 
                     52: =cut 
                     53: 
                     54: # End of POD header
1.1       albertel   55: package Apache::loncommon;
                     56: 
                     57: use strict;
1.258     albertel   58: use Apache::lonnet;
1.46      matthew    59: use GDBM_File;
1.51      www        60: use POSIX qw(strftime mktime);
1.82      www        61: use Apache::lonmenu();
1.498     albertel   62: use Apache::lonenc();
1.117     www        63: use Apache::lonlocal;
1.685     tempelho   64: use Apache::lonnet();
1.139     matthew    65: use HTML::Entities;
1.334     albertel   66: use Apache::lonhtmlcommon();
                     67: use Apache::loncoursedata();
1.344     albertel   68: use Apache::lontexconvert();
1.444     albertel   69: use Apache::lonclonecourse();
1.479     albertel   70: use LONCAPA qw(:DEFAULT :match);
1.657     raeburn    71: use DateTime::TimeZone;
1.687     raeburn    72: use DateTime::Locale::Catalog;
1.117     www        73: 
1.517     raeburn    74: # ---------------------------------------------- Designs
                     75: use vars qw(%defaultdesign);
                     76: 
1.22      www        77: my $readit;
                     78: 
1.517     raeburn    79: 
1.157     matthew    80: ##
                     81: ## Global Variables
                     82: ##
1.46      matthew    83: 
1.643     foxr       84: 
                     85: # ----------------------------------------------- SSI with retries:
                     86: #
                     87: 
                     88: =pod
                     89: 
1.648     raeburn    90: =head1 Server Side include with retries:
1.643     foxr       91: 
                     92: =over 4
                     93: 
1.648     raeburn    94: =item * &ssi_with_retries(resource,retries form)
1.643     foxr       95: 
                     96: Performs an ssi with some number of retries.  Retries continue either
                     97: until the result is ok or until the retry count supplied by the
                     98: caller is exhausted.  
                     99: 
                    100: Inputs:
1.648     raeburn   101: 
                    102: =over 4
                    103: 
1.643     foxr      104: resource   - Identifies the resource to insert.
1.648     raeburn   105: 
1.643     foxr      106: retries    - Count of the number of retries allowed.
1.648     raeburn   107: 
1.643     foxr      108: form       - Hash that identifies the rendering options.
                    109: 
1.648     raeburn   110: =back
                    111: 
                    112: Returns:
                    113: 
                    114: =over 4
                    115: 
1.643     foxr      116: content    - The content of the response.  If retries were exhausted this is empty.
1.648     raeburn   117: 
1.643     foxr      118: response   - The response from the last attempt (which may or may not have been successful.
                    119: 
1.648     raeburn   120: =back
                    121: 
                    122: =back
                    123: 
1.643     foxr      124: =cut
                    125: 
                    126: sub ssi_with_retries {
                    127:     my ($resource, $retries, %form) = @_;
                    128: 
                    129: 
                    130:     my $ok = 0;			# True if we got a good response.
                    131:     my $content;
                    132:     my $response;
                    133: 
                    134:     # Try to get the ssi done. within the retries count:
                    135: 
                    136:     do {
                    137: 	($content, $response) = &Apache::lonnet::ssi($resource, %form);
                    138: 	$ok      = $response->is_success;
1.650     www       139:         if (!$ok) {
                    140:             &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
                    141:         }
1.643     foxr      142: 	$retries--;
                    143:     } while (!$ok && ($retries > 0));
                    144: 
                    145:     if (!$ok) {
                    146: 	$content = '';		# On error return an empty content.
                    147:     }
                    148:     return ($content, $response);
                    149: 
                    150: }
                    151: 
                    152: 
                    153: 
1.20      www       154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12      harris41  155: my %language;
1.124     www       156: my %supported_language;
1.12      harris41  157: my %cprtag;
1.192     taceyjo1  158: my %scprtag;
1.351     www       159: my %fe; my %fd; my %fm;
1.41      ng        160: my %category_extensions;
1.12      harris41  161: 
1.46      matthew   162: # ---------------------------------------------- Thesaurus variables
1.144     matthew   163: #
                    164: # %Keywords:
                    165: #      A hash used by &keyword to determine if a word is considered a keyword.
                    166: # $thesaurus_db_file 
                    167: #      Scalar containing the full path to the thesaurus database.
1.46      matthew   168: 
                    169: my %Keywords;
                    170: my $thesaurus_db_file;
                    171: 
1.144     matthew   172: #
                    173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
                    174: # thesaurus.tab, and filecategories.tab.
                    175: #
1.18      www       176: BEGIN {
1.46      matthew   177:     # Variable initialization
                    178:     $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
                    179:     #
1.22      www       180:     unless ($readit) {
1.12      harris41  181: # ------------------------------------------------------------------- languages
                    182:     {
1.158     raeburn   183:         my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    184:                                    '/language.tab';
                    185:         if ( open(my $fh,"<$langtabfile") ) {
1.356     albertel  186:             while (my $line = <$fh>) {
                    187:                 next if ($line=~/^\#/);
                    188:                 chomp($line);
                    189:                 my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158     raeburn   190:                 $language{$key}=$val.' - '.$enc;
                    191:                 if ($sup) {
                    192:                     $supported_language{$key}=$sup;
                    193:                 }
                    194:             }
                    195:             close($fh);
                    196:         }
1.12      harris41  197:     }
                    198: # ------------------------------------------------------------------ copyrights
                    199:     {
1.158     raeburn   200:         my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    201:                                   '/copyright.tab';
                    202:         if ( open (my $fh,"<$copyrightfile") ) {
1.356     albertel  203:             while (my $line = <$fh>) {
                    204:                 next if ($line=~/^\#/);
                    205:                 chomp($line);
                    206:                 my ($key,$val)=(split(/\s+/,$line,2));
1.158     raeburn   207:                 $cprtag{$key}=$val;
                    208:             }
                    209:             close($fh);
                    210:         }
1.12      harris41  211:     }
1.351     www       212: # ----------------------------------------------------------- source copyrights
1.192     taceyjo1  213:     {
                    214:         my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
                    215:                                   '/source_copyright.tab';
                    216:         if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356     albertel  217:             while (my $line = <$fh>) {
                    218:                 next if ($line =~ /^\#/);
                    219:                 chomp($line);
                    220:                 my ($key,$val)=(split(/\s+/,$line,2));
1.192     taceyjo1  221:                 $scprtag{$key}=$val;
                    222:             }
                    223:             close($fh);
                    224:         }
                    225:     }
1.63      www       226: 
1.517     raeburn   227: # -------------------------------------------------------------- default domain designs
1.63      www       228:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517     raeburn   229:     my $designfile = $designdir.'/default.tab';
                    230:     if ( open (my $fh,"<$designfile") ) {
                    231:         while (my $line = <$fh>) {
                    232:             next if ($line =~ /^\#/);
                    233:             chomp($line);
                    234:             my ($key,$val)=(split(/\=/,$line));
                    235:             if ($val) { $defaultdesign{$key}=$val; }
                    236:         }
                    237:         close($fh);
1.63      www       238:     }
                    239: 
1.15      harris41  240: # ------------------------------------------------------------- file categories
                    241:     {
1.158     raeburn   242:         my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    243:                                   '/filecategories.tab';
                    244:         if ( open (my $fh,"<$categoryfile") ) {
1.356     albertel  245: 	    while (my $line = <$fh>) {
                    246: 		next if ($line =~ /^\#/);
                    247: 		chomp($line);
                    248:                 my ($extension,$category)=(split(/\s+/,$line,2));
1.158     raeburn   249:                 push @{$category_extensions{lc($category)}},$extension;
                    250:             }
                    251:             close($fh);
                    252:         }
                    253: 
1.15      harris41  254:     }
1.12      harris41  255: # ------------------------------------------------------------------ file types
                    256:     {
1.158     raeburn   257:         my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
                    258:                '/filetypes.tab';
                    259:         if ( open (my $fh,"<$typesfile") ) {
1.356     albertel  260:             while (my $line = <$fh>) {
                    261: 		next if ($line =~ /^\#/);
                    262: 		chomp($line);
                    263:                 my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158     raeburn   264:                 if ($descr ne '') {
                    265:                     $fe{$ending}=lc($emb);
                    266:                     $fd{$ending}=$descr;
1.351     www       267:                     if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158     raeburn   268:                 }
                    269:             }
                    270:             close($fh);
                    271:         }
1.12      harris41  272:     }
1.22      www       273:     &Apache::lonnet::logthis(
1.705     tempelho  274:              "<span style='color:yellow;'>INFO: Read file types</span>");
1.22      www       275:     $readit=1;
1.46      matthew   276:     }  # end of unless($readit) 
1.32      matthew   277:     
                    278: }
1.112     bowersj2  279: 
1.42      matthew   280: ###############################################################
                    281: ##           HTML and Javascript Helper Functions            ##
                    282: ###############################################################
                    283: 
                    284: =pod 
                    285: 
1.112     bowersj2  286: =head1 HTML and Javascript Functions
1.42      matthew   287: 
1.112     bowersj2  288: =over 4
                    289: 
1.648     raeburn   290: =item * &browser_and_searcher_javascript()
1.112     bowersj2  291: 
                    292: X<browsing, javascript>X<searching, javascript>Returns a string
                    293: containing javascript with two functions, C<openbrowser> and
                    294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
                    295: tags.
1.42      matthew   296: 
1.648     raeburn   297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42      matthew   298: 
                    299: inputs: formname, elementname, only, omit
                    300: 
                    301: formname and elementname indicate the name of the html form and name of
                    302: the element that the results of the browsing selection are to be placed in. 
                    303: 
                    304: Specifying 'only' will restrict the browser to displaying only files
1.185     www       305: with the given extension.  Can be a comma separated list.
1.42      matthew   306: 
                    307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185     www       308: with the given extension.  Can be a comma separated list.
1.42      matthew   309: 
1.648     raeburn   310: =item * &opensearcher(formname,elementname) [javascript]
1.42      matthew   311: 
                    312: Inputs: formname, elementname
                    313: 
                    314: formname and elementname specify the name of the html form and the name
                    315: of the element the selection from the search results will be placed in.
1.542     raeburn   316: 
1.42      matthew   317: =cut
                    318: 
                    319: sub browser_and_searcher_javascript {
1.199     albertel  320:     my ($mode)=@_;
                    321:     if (!defined($mode)) { $mode='edit'; }
1.453     albertel  322:     my $resurl=&escape_single(&lastresurl());
1.42      matthew   323:     return <<END;
1.219     albertel  324: // <!-- BEGIN LON-CAPA Internal
1.50      matthew   325:     var editbrowser = null;
1.135     albertel  326:     function openbrowser(formname,elementname,only,omit,titleelement) {
1.170     www       327:         var url = '$resurl/?';
1.42      matthew   328:         if (editbrowser == null) {
                    329:             url += 'launch=1&';
                    330:         }
                    331:         url += 'catalogmode=interactive&';
1.199     albertel  332:         url += 'mode=$mode&';
1.611     albertel  333:         url += 'inhibitmenu=yes&';
1.42      matthew   334:         url += 'form=' + formname + '&';
                    335:         if (only != null) {
                    336:             url += 'only=' + only + '&';
1.217     albertel  337:         } else {
                    338:             url += 'only=&';
                    339: 	}
1.42      matthew   340:         if (omit != null) {
                    341:             url += 'omit=' + omit + '&';
1.217     albertel  342:         } else {
                    343:             url += 'omit=&';
                    344: 	}
1.135     albertel  345:         if (titleelement != null) {
                    346:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  347:         } else {
                    348: 	    url += 'titleelement=&';
                    349: 	}
1.42      matthew   350:         url += 'element=' + elementname + '';
                    351:         var title = 'Browser';
1.435     albertel  352:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   353:         options += ',width=700,height=600';
                    354:         editbrowser = open(url,title,options,'1');
                    355:         editbrowser.focus();
                    356:     }
                    357:     var editsearcher;
1.135     albertel  358:     function opensearcher(formname,elementname,titleelement) {
1.42      matthew   359:         var url = '/adm/searchcat?';
                    360:         if (editsearcher == null) {
                    361:             url += 'launch=1&';
                    362:         }
                    363:         url += 'catalogmode=interactive&';
1.199     albertel  364:         url += 'mode=$mode&';
1.42      matthew   365:         url += 'form=' + formname + '&';
1.135     albertel  366:         if (titleelement != null) {
                    367:             url += 'titleelement=' + titleelement + '&';
1.217     albertel  368:         } else {
                    369: 	    url += 'titleelement=&';
                    370: 	}
1.42      matthew   371:         url += 'element=' + elementname + '';
                    372:         var title = 'Search';
1.435     albertel  373:         var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42      matthew   374:         options += ',width=700,height=600';
                    375:         editsearcher = open(url,title,options,'1');
                    376:         editsearcher.focus();
                    377:     }
1.219     albertel  378: // END LON-CAPA Internal -->
1.42      matthew   379: END
1.170     www       380: }
                    381: 
                    382: sub lastresurl {
1.258     albertel  383:     if ($env{'environment.lastresurl'}) {
                    384: 	return $env{'environment.lastresurl'}
1.170     www       385:     } else {
                    386: 	return '/res';
                    387:     }
                    388: }
                    389: 
                    390: sub storeresurl {
                    391:     my $resurl=&Apache::lonnet::clutter(shift);
                    392:     unless ($resurl=~/^\/res/) { return 0; }
                    393:     $resurl=~s/\/$//;
                    394:     &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646     raeburn   395:     &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170     www       396:     return 1;
1.42      matthew   397: }
                    398: 
1.74      www       399: sub studentbrowser_javascript {
1.111     www       400:    unless (
1.258     albertel  401:             (($env{'request.course.id'}) && 
1.302     albertel  402:              (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    403: 	      || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    404: 					  '/'.$env{'request.course.sec'})
                    405: 	      ))
1.258     albertel  406:          || ($env{'request.role'}=~/^(au|dc|su)/)
1.111     www       407:           ) { return ''; }  
1.74      www       408:    return (<<'ENDSTDBRW');
1.776     bisitz    409: <script type="text/javascript" language="Javascript">
1.824     bisitz    410: // <![CDATA[
1.74      www       411:     var stdeditbrowser;
1.793     raeburn   412:     function openstdbrowser(formname,uname,udom,roleflag,ignorefilter,courseadvonly) {
1.74      www       413:         var url = '/adm/pickstudent?';
                    414:         var filter;
1.558     albertel  415: 	if (!ignorefilter) {
                    416: 	    eval('filter=document.'+formname+'.'+uname+'.value;');
                    417: 	}
1.74      www       418:         if (filter != null) {
                    419:            if (filter != '') {
                    420:                url += 'filter='+filter+'&';
                    421: 	   }
                    422:         }
                    423:         url += 'form=' + formname + '&unameelement='+uname+
                    424:                                     '&udomelement='+udom;
1.111     www       425: 	if (roleflag) { url+="&roles=1"; }
1.793     raeburn   426:         if (courseadvonly) { url+="&courseadvonly=1"; }
1.102     www       427:         var title = 'Student_Browser';
1.74      www       428:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    429:         options += ',width=700,height=600';
                    430:         stdeditbrowser = open(url,title,options,'1');
                    431:         stdeditbrowser.focus();
                    432:     }
1.824     bisitz    433: // ]]>
1.74      www       434: </script>
                    435: ENDSTDBRW
                    436: }
1.42      matthew   437: 
1.74      www       438: sub selectstudent_link {
1.793     raeburn   439:    my ($form,$unameele,$udomele,$courseadvonly)=@_;
                    440:    my $callargs = "'".$form."','".$unameele."','".$udomele."'";
1.258     albertel  441:    if ($env{'request.course.id'}) {  
1.302     albertel  442:        if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
                    443: 	   && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
                    444: 					'/'.$env{'request.course.sec'})) {
1.111     www       445: 	   return '';
                    446:        }
1.793     raeburn   447:        if ($courseadvonly)  {
                    448:            $callargs .= ",'',1,1";
                    449:        }
                    450:        return '<span class="LC_nobreak">'.
                    451:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    452:               &mt('Select User').'</a></span>';
1.74      www       453:    }
1.258     albertel  454:    if ($env{'request.role'}=~/^(au|dc|su)/) {
1.793     raeburn   455:        $callargs .= ",1"; 
                    456:        return '<span class="LC_nobreak">'.
                    457:               '<a href="javascript:openstdbrowser('.$callargs.');">'.
                    458:               &mt('Select User').'</a></span>';
1.111     www       459:    }
                    460:    return '';
1.91      www       461: }
                    462: 
1.653     raeburn   463: sub authorbrowser_javascript {
                    464:     return <<"ENDAUTHORBRW";
1.776     bisitz    465: <script type="text/javascript" language="JavaScript">
1.824     bisitz    466: // <![CDATA[
1.653     raeburn   467: var stdeditbrowser;
                    468: 
                    469: function openauthorbrowser(formname,udom) {
                    470:     var url = '/adm/pickauthor?';
                    471:     url += 'form='+formname+'&roledom='+udom;
                    472:     var title = 'Author_Browser';
                    473:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    474:     options += ',width=700,height=600';
                    475:     stdeditbrowser = open(url,title,options,'1');
                    476:     stdeditbrowser.focus();
                    477: }
                    478: 
1.824     bisitz    479: // ]]>
1.653     raeburn   480: </script>
                    481: ENDAUTHORBRW
                    482: }
                    483: 
1.91      www       484: sub coursebrowser_javascript {
1.909     raeburn   485:     my ($domainfilter,$sec_element,$formname,$role_element,$crstype) = @_;
                    486:     my $wintitle = &mt('Course Browser');
                    487:     if ($crstype ne '') {
                    488:         $wintitle = &mt($crstype);
                    489:     }
1.876     raeburn   490:     my $id_functions = &javascript_index_functions();
                    491:     my $output = '
1.776     bisitz    492: <script type="text/javascript" language="JavaScript">
1.824     bisitz    493: // <![CDATA[
1.468     raeburn   494:     var stdeditbrowser;'."\n";
1.876     raeburn   495: 
                    496:     $output .= <<"ENDSTDBRW";
1.909     raeburn   497:     function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,type,type_elem) {
1.91      www       498:         var url = '/adm/pickcourse?';
1.895     raeburn   499:         var formid = getFormIdByName(formname);
1.876     raeburn   500:         var domainfilter = getDomainFromSelectbox(formname,udom);
1.128     albertel  501:         if (domainfilter != null) {
                    502:            if (domainfilter != '') {
                    503:                url += 'domainfilter='+domainfilter+'&';
                    504: 	   }
                    505:         }
1.91      www       506:         url += 'form=' + formname + '&cnumelement='+uname+
1.187     albertel  507: 	                            '&cdomelement='+udom+
                    508:                                     '&cnameelement='+desc;
1.468     raeburn   509:         if (extra_element !=null && extra_element != '') {
1.594     raeburn   510:             if (formname == 'rolechoice' || formname == 'studentform') {
1.468     raeburn   511:                 url += '&roleelement='+extra_element;
                    512:                 if (domainfilter == null || domainfilter == '') {
                    513:                     url += '&domainfilter='+extra_element;
                    514:                 }
1.234     raeburn   515:             }
1.468     raeburn   516:             else {
                    517:                 if (formname == 'portform') {
                    518:                     url += '&setroles='+extra_element;
1.800     raeburn   519:                 } else {
                    520:                     if (formname == 'rules') {
                    521:                         url += '&fixeddom='+extra_element; 
                    522:                     }
1.468     raeburn   523:                 }
                    524:             }     
1.230     raeburn   525:         }
1.909     raeburn   526:         if (type != null && type != '') {
                    527:             url += '&type='+type;
                    528:         }
                    529:         if (type_elem != null && type_elem != '') {
                    530:             url += '&typeelement='+type_elem;
                    531:         }
1.872     raeburn   532:         if (formname == 'ccrs') {
                    533:             var ownername = document.forms[formid].ccuname.value;
                    534:             var ownerdom =  document.forms[formid].ccdomain.options[document.forms[formid].ccdomain.selectedIndex].value;
                    535:             url += '&cloner='+ownername+':'+ownerdom;
                    536:         }
1.293     raeburn   537:         if (multflag !=null && multflag != '') {
                    538:             url += '&multiple='+multflag;
                    539:         }
1.909     raeburn   540:         var title = '$wintitle';
1.91      www       541:         var options = 'scrollbars=1,resizable=1,menubar=0';
                    542:         options += ',width=700,height=600';
                    543:         stdeditbrowser = open(url,title,options,'1');
                    544:         stdeditbrowser.focus();
                    545:     }
1.876     raeburn   546: $id_functions
                    547: ENDSTDBRW
1.905     raeburn   548:     if (($sec_element ne '') || ($role_element ne '')) {
                    549:         $output .= &setsec_javascript($sec_element,$formname,$role_element);
1.876     raeburn   550:     }
                    551:     $output .= '
                    552: // ]]>
                    553: </script>';
                    554:     return $output;
                    555: }
                    556: 
                    557: sub javascript_index_functions {
                    558:     return <<"ENDJS";
                    559: 
                    560: function getFormIdByName(formname) {
                    561:     for (var i=0;i<document.forms.length;i++) {
                    562:         if (document.forms[i].name == formname) {
                    563:             return i;
                    564:         }
                    565:     }
                    566:     return -1;
                    567: }
                    568: 
                    569: function getIndexByName(formid,item) {
                    570:     for (var i=0;i<document.forms[formid].elements.length;i++) {
                    571:         if (document.forms[formid].elements[i].name == item) {
                    572:             return i;
                    573:         }
                    574:     }
                    575:     return -1;
                    576: }
1.468     raeburn   577: 
1.876     raeburn   578: function getDomainFromSelectbox(formname,udom) {
                    579:     var userdom;
                    580:     var formid = getFormIdByName(formname);
                    581:     if (formid > -1) {
                    582:         var domid = getIndexByName(formid,udom);
                    583:         if (domid > -1) {
                    584:             if (document.forms[formid].elements[domid].type == 'select-one') {
                    585:                 userdom=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
                    586:             }
                    587:             if (document.forms[formid].elements[domid].type == 'hidden') {
                    588:                 userdom=document.forms[formid].elements[domid].value;
1.468     raeburn   589:             }
                    590:         }
                    591:     }
1.876     raeburn   592:     return userdom;
                    593: }
                    594: 
                    595: ENDJS
1.468     raeburn   596: 
1.876     raeburn   597: }
                    598: 
                    599: sub userbrowser_javascript {
                    600:     my $id_functions = &javascript_index_functions();
                    601:     return <<"ENDUSERBRW";
                    602: 
1.888     raeburn   603: function openuserbrowser(formname,uname,udom,ulast,ufirst,uemail,hideudom,crsdom,caller) {
1.876     raeburn   604:     var url = '/adm/pickuser?';
                    605:     var userdom = getDomainFromSelectbox(formname,udom);
                    606:     if (userdom != null) {
                    607:        if (userdom != '') {
                    608:            url += 'srchdom='+userdom+'&';
                    609:        }
                    610:     }
                    611:     url += 'form=' + formname + '&unameelement='+uname+
                    612:                                 '&udomelement='+udom+
                    613:                                 '&ulastelement='+ulast+
                    614:                                 '&ufirstelement='+ufirst+
                    615:                                 '&uemailelement='+uemail+
1.881     raeburn   616:                                 '&hideudomelement='+hideudom+
                    617:                                 '&coursedom='+crsdom;
1.888     raeburn   618:     if ((caller != null) && (caller != undefined)) {
                    619:         url += '&caller='+caller;
                    620:     }
1.876     raeburn   621:     var title = 'User_Browser';
                    622:     var options = 'scrollbars=1,resizable=1,menubar=0';
                    623:     options += ',width=700,height=600';
                    624:     var stdeditbrowser = open(url,title,options,'1');
                    625:     stdeditbrowser.focus();
                    626: }
                    627: 
1.888     raeburn   628: function fix_domain (formname,udom,origdom,uname) {
1.876     raeburn   629:     var formid = getFormIdByName(formname);
                    630:     if (formid > -1) {
1.888     raeburn   631:         var unameid = getIndexByName(formid,uname);
1.876     raeburn   632:         var domid = getIndexByName(formid,udom);
                    633:         var hidedomid = getIndexByName(formid,origdom);
                    634:         if (hidedomid > -1) {
                    635:             var fixeddom = document.forms[formid].elements[hidedomid].value;
1.888     raeburn   636:             var unameval = document.forms[formid].elements[unameid].value;
                    637:             if ((fixeddom != '') && (fixeddom != undefined) && (fixeddom != null) && (unameval != '') && (unameval != undefined) && (unameval != null)) {
                    638:                 if (domid > -1) {
                    639:                     var slct = document.forms[formid].elements[domid];
                    640:                     if (slct.type == 'select-one') {
                    641:                         var i;
                    642:                         for (i=0;i<slct.length;i++) {
                    643:                             if (slct.options[i].value==fixeddom) { slct.selectedIndex=i; }
                    644:                         }
                    645:                     }
                    646:                     if (slct.type == 'hidden') {
                    647:                         slct.value = fixeddom;
1.876     raeburn   648:                     }
                    649:                 }
1.468     raeburn   650:             }
                    651:         }
                    652:     }
1.876     raeburn   653:     return;
                    654: }
                    655: 
                    656: $id_functions
                    657: ENDUSERBRW
1.468     raeburn   658: }
                    659: 
                    660: sub setsec_javascript {
1.905     raeburn   661:     my ($sec_element,$formname,$role_element) = @_;
                    662:     my (@courserolenames,@communityrolenames,$rolestr,$courserolestr,
                    663:         $communityrolestr);
                    664:     if ($role_element ne '') {
                    665:         my @allroles = ('st','ta','ep','in','ad');
                    666:         foreach my $crstype ('Course','Community') {
                    667:             if ($crstype eq 'Community') {
                    668:                 foreach my $role (@allroles) {
                    669:                     push(@communityrolenames,&Apache::lonnet::plaintext($role,$crstype));
                    670:                 }
                    671:                 push(@communityrolenames,&Apache::lonnet::plaintext('co'));
                    672:             } else {
                    673:                 foreach my $role (@allroles) {
                    674:                     push(@courserolenames,&Apache::lonnet::plaintext($role,$crstype));
                    675:                 }
                    676:                 push(@courserolenames,&Apache::lonnet::plaintext('cc'));
                    677:             }
                    678:         }
                    679:         $rolestr = '"'.join('","',@allroles).'"';
                    680:         $courserolestr = '"'.join('","',@courserolenames).'"';
                    681:         $communityrolestr = '"'.join('","',@communityrolenames).'"';
                    682:     }
1.468     raeburn   683:     my $setsections = qq|
                    684: function setSect(sectionlist) {
1.629     raeburn   685:     var sectionsArray = new Array();
                    686:     if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
                    687:         sectionsArray = sectionlist.split(",");
                    688:     }
1.468     raeburn   689:     var numSections = sectionsArray.length;
                    690:     document.$formname.$sec_element.length = 0;
                    691:     if (numSections == 0) {
                    692:         document.$formname.$sec_element.multiple=false;
                    693:         document.$formname.$sec_element.size=1;
                    694:         document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
                    695:     } else {
                    696:         if (numSections == 1) {
                    697:             document.$formname.$sec_element.multiple=false;
                    698:             document.$formname.$sec_element.size=1;
                    699:             document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
                    700:             document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
                    701:             document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
                    702:         } else {
                    703:             for (var i=0; i<numSections; i++) {
                    704:                 document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
                    705:             }
                    706:             document.$formname.$sec_element.multiple=true
                    707:             if (numSections < 3) {
                    708:                 document.$formname.$sec_element.size=numSections;
                    709:             } else {
                    710:                 document.$formname.$sec_element.size=3;
                    711:             }
                    712:             document.$formname.$sec_element.options[0].selected = false
                    713:         }
                    714:     }
1.91      www       715: }
1.905     raeburn   716: 
                    717: function setRole(crstype) {
1.468     raeburn   718: |;
1.905     raeburn   719:     if ($role_element eq '') {
                    720:         $setsections .= '    return;
                    721: }
                    722: ';
                    723:     } else {
                    724:         $setsections .= qq|
                    725:     var elementLength = document.$formname.$role_element.length;
                    726:     var allroles = Array($rolestr);
                    727:     var courserolenames = Array($courserolestr);
                    728:     var communityrolenames = Array($communityrolestr);
                    729:     if (elementLength != undefined) {
                    730:         if (document.$formname.$role_element.options[5].value == 'cc') {
                    731:             if (crstype == 'Course') {
                    732:                 return;
                    733:             } else {
                    734:                 allroles[5] = 'co';
                    735:                 for (var i=0; i<6; i++) {
                    736:                     document.$formname.$role_element.options[i].value = allroles[i];
                    737:                     document.$formname.$role_element.options[i].text = communityrolenames[i];
                    738:                 }
                    739:             }
                    740:         } else {
                    741:             if (crstype == 'Community') {
                    742:                 return;
                    743:             } else {
                    744:                 allroles[5] = 'cc';
                    745:                 for (var i=0; i<6; i++) {
                    746:                     document.$formname.$role_element.options[i].value = allroles[i];
                    747:                     document.$formname.$role_element.options[i].text = courserolenames[i];
                    748:                 }
                    749:             }
                    750:         }
                    751:     }
                    752:     return;
                    753: }
                    754: |;
                    755:     }
1.468     raeburn   756:     return $setsections;
                    757: }
                    758: 
1.91      www       759: sub selectcourse_link {
1.909     raeburn   760:    my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype,
                    761:        $typeelement) = @_;
                    762:    my $type = $selecttype;
1.871     raeburn   763:    my $linktext = &mt('Select Course');
                    764:    if ($selecttype eq 'Community') {
1.909     raeburn   765:        $linktext = &mt('Select Community');
1.906     raeburn   766:    } elsif ($selecttype eq 'Course/Community') {
                    767:        $linktext = &mt('Select Course/Community');
1.909     raeburn   768:        $type = '';
1.871     raeburn   769:    }
1.787     bisitz    770:    return '<span class="LC_nobreak">'
                    771:          ."<a href='"
                    772:          .'javascript:opencrsbrowser("'.$form.'","'.$unameele
                    773:          .'","'.$udomele.'","'.$desc.'","'.$extra_element
1.909     raeburn   774:          .'","'.$multflag.'","'.$type.'","'.$typeelement.'");'
1.871     raeburn   775:          ."'>".$linktext.'</a>'
1.787     bisitz    776:          .'</span>';
1.74      www       777: }
1.42      matthew   778: 
1.653     raeburn   779: sub selectauthor_link {
                    780:    my ($form,$udom)=@_;
                    781:    return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
                    782:           &mt('Select Author').'</a>';
                    783: }
                    784: 
1.876     raeburn   785: sub selectuser_link {
1.881     raeburn   786:     my ($form,$unameelem,$domelem,$lastelem,$firstelem,$emailelem,$hdomelem,
1.888     raeburn   787:         $coursedom,$linktext,$caller) = @_;
1.876     raeburn   788:     return '<a href="javascript:openuserbrowser('."'$form','$unameelem','$domelem',".
1.888     raeburn   789:            "'$lastelem','$firstelem','$emailelem','$hdomelem','$coursedom','$caller'".
1.881     raeburn   790:            ');">'.$linktext.'</a>';
1.876     raeburn   791: }
                    792: 
1.273     raeburn   793: sub check_uncheck_jscript {
                    794:     my $jscript = <<"ENDSCRT";
                    795: function checkAll(field) {
                    796:     if (field.length > 0) {
                    797:         for (i = 0; i < field.length; i++) {
                    798:             field[i].checked = true ;
                    799:         }
                    800:     } else {
                    801:         field.checked = true
                    802:     }
                    803: }
                    804:  
                    805: function uncheckAll(field) {
                    806:     if (field.length > 0) {
                    807:         for (i = 0; i < field.length; i++) {
                    808:             field[i].checked = false ;
1.543     albertel  809:         }
                    810:     } else {
1.273     raeburn   811:         field.checked = false ;
                    812:     }
                    813: }
                    814: ENDSCRT
                    815:     return $jscript;
                    816: }
                    817: 
1.656     www       818: sub select_timezone {
1.659     raeburn   819:    my ($name,$selected,$onchange,$includeempty)=@_;
                    820:    my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    821:    if ($includeempty) {
                    822:        $output .= '<option value=""';
                    823:        if (($selected eq '') || ($selected eq 'local')) {
                    824:            $output .= ' selected="selected" ';
                    825:        }
                    826:        $output .= '> </option>';
                    827:    }
1.657     raeburn   828:    my @timezones = DateTime::TimeZone->all_names;
                    829:    foreach my $tzone (@timezones) {
                    830:        $output.= '<option value="'.$tzone.'"';
                    831:        if ($tzone eq $selected) {
                    832:            $output.=' selected="selected"';
                    833:        }
                    834:        $output.=">$tzone</option>\n";
1.656     www       835:    }
                    836:    $output.="</select>";
                    837:    return $output;
                    838: }
1.273     raeburn   839: 
1.687     raeburn   840: sub select_datelocale {
                    841:     my ($name,$selected,$onchange,$includeempty)=@_;
                    842:     my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
                    843:     if ($includeempty) {
                    844:         $output .= '<option value=""';
                    845:         if ($selected eq '') {
                    846:             $output .= ' selected="selected" ';
                    847:         }
                    848:         $output .= '> </option>';
                    849:     }
                    850:     my (@possibles,%locale_names);
                    851:     my @locales = DateTime::Locale::Catalog::Locales;
                    852:     foreach my $locale (@locales) {
                    853:         if (ref($locale) eq 'HASH') {
                    854:             my $id = $locale->{'id'};
                    855:             if ($id ne '') {
                    856:                 my $en_terr = $locale->{'en_territory'};
                    857:                 my $native_terr = $locale->{'native_territory'};
1.695     raeburn   858:                 my @languages = &Apache::lonlocal::preferred_languages();
1.687     raeburn   859:                 if (grep(/^en$/,@languages) || !@languages) {
                    860:                     if ($en_terr ne '') {
                    861:                         $locale_names{$id} = '('.$en_terr.')';
                    862:                     } elsif ($native_terr ne '') {
                    863:                         $locale_names{$id} = $native_terr;
                    864:                     }
                    865:                 } else {
                    866:                     if ($native_terr ne '') {
                    867:                         $locale_names{$id} = $native_terr.' ';
                    868:                     } elsif ($en_terr ne '') {
                    869:                         $locale_names{$id} = '('.$en_terr.')';
                    870:                     }
                    871:                 }
                    872:                 push (@possibles,$id);
                    873:             }
                    874:         }
                    875:     }
                    876:     foreach my $item (sort(@possibles)) {
                    877:         $output.= '<option value="'.$item.'"';
                    878:         if ($item eq $selected) {
                    879:             $output.=' selected="selected"';
                    880:         }
                    881:         $output.=">$item";
                    882:         if ($locale_names{$item} ne '') {
                    883:             $output.="  $locale_names{$item}</option>\n";
                    884:         }
                    885:         $output.="</option>\n";
                    886:     }
                    887:     $output.="</select>";
                    888:     return $output;
                    889: }
                    890: 
1.792     raeburn   891: sub select_language {
                    892:     my ($name,$selected,$includeempty) = @_;
                    893:     my %langchoices;
                    894:     if ($includeempty) {
                    895:         %langchoices = ('' => 'No language preference');
                    896:     }
                    897:     foreach my $id (&languageids()) {
                    898:         my $code = &supportedlanguagecode($id);
                    899:         if ($code) {
                    900:             $langchoices{$code} = &plainlanguagedescription($id);
                    901:         }
                    902:     }
                    903:     return &select_form($selected,$name,%langchoices);
                    904: }
                    905: 
1.42      matthew   906: =pod
1.36      matthew   907: 
1.648     raeburn   908: =item * &linked_select_forms(...)
1.36      matthew   909: 
                    910: linked_select_forms returns a string containing a <script></script> block
                    911: and html for two <select> menus.  The select menus will be linked in that
                    912: changing the value of the first menu will result in new values being placed
                    913: in the second menu.  The values in the select menu will appear in alphabetical
1.609     raeburn   914: order unless a defined order is provided.
1.36      matthew   915: 
                    916: linked_select_forms takes the following ordered inputs:
                    917: 
                    918: =over 4
                    919: 
1.112     bowersj2  920: =item * $formname, the name of the <form> tag
1.36      matthew   921: 
1.112     bowersj2  922: =item * $middletext, the text which appears between the <select> tags
1.36      matthew   923: 
1.112     bowersj2  924: =item * $firstdefault, the default value for the first menu
1.36      matthew   925: 
1.112     bowersj2  926: =item * $firstselectname, the name of the first <select> tag
1.36      matthew   927: 
1.112     bowersj2  928: =item * $secondselectname, the name of the second <select> tag
1.36      matthew   929: 
1.112     bowersj2  930: =item * $hashref, a reference to a hash containing the data for the menus.
1.36      matthew   931: 
1.609     raeburn   932: =item * $menuorder, the order of values in the first menu
                    933: 
1.41      ng        934: =back 
                    935: 
1.36      matthew   936: Below is an example of such a hash.  Only the 'text', 'default', and 
                    937: 'select2' keys must appear as stated.  keys(%menu) are the possible 
                    938: values for the first select menu.  The text that coincides with the 
1.41      ng        939: first menu value is given in $menu{$choice1}->{'text'}.  The values 
1.36      matthew   940: and text for the second menu are given in the hash pointed to by 
                    941: $menu{$choice1}->{'select2'}.  
                    942: 
1.112     bowersj2  943:  my %menu = ( A1 => { text =>"Choice A1" ,
                    944:                        default => "B3",
                    945:                        select2 => { 
                    946:                            B1 => "Choice B1",
                    947:                            B2 => "Choice B2",
                    948:                            B3 => "Choice B3",
                    949:                            B4 => "Choice B4"
1.609     raeburn   950:                            },
                    951:                        order => ['B4','B3','B1','B2'],
1.112     bowersj2  952:                    },
                    953:                A2 => { text =>"Choice A2" ,
                    954:                        default => "C2",
                    955:                        select2 => { 
                    956:                            C1 => "Choice C1",
                    957:                            C2 => "Choice C2",
                    958:                            C3 => "Choice C3"
1.609     raeburn   959:                            },
                    960:                        order => ['C2','C1','C3'],
1.112     bowersj2  961:                    },
                    962:                A3 => { text =>"Choice A3" ,
                    963:                        default => "D6",
                    964:                        select2 => { 
                    965:                            D1 => "Choice D1",
                    966:                            D2 => "Choice D2",
                    967:                            D3 => "Choice D3",
                    968:                            D4 => "Choice D4",
                    969:                            D5 => "Choice D5",
                    970:                            D6 => "Choice D6",
                    971:                            D7 => "Choice D7"
1.609     raeburn   972:                            },
                    973:                        order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112     bowersj2  974:                    }
                    975:                );
1.36      matthew   976: 
                    977: =cut
                    978: 
                    979: sub linked_select_forms {
                    980:     my ($formname,
                    981:         $middletext,
                    982:         $firstdefault,
                    983:         $firstselectname,
                    984:         $secondselectname, 
1.609     raeburn   985:         $hashref,
                    986:         $menuorder,
1.36      matthew   987:         ) = @_;
                    988:     my $second = "document.$formname.$secondselectname";
                    989:     my $first = "document.$formname.$firstselectname";
                    990:     # output the javascript to do the changing
                    991:     my $result = '';
1.776     bisitz    992:     $result.='<script type="text/javascript" language="JavaScript">'."\n";
1.824     bisitz    993:     $result.="// <![CDATA[\n";
1.36      matthew   994:     $result.="var select2data = new Object();\n";
                    995:     $" = '","';
                    996:     my $debug = '';
                    997:     foreach my $s1 (sort(keys(%$hashref))) {
                    998:         $result.="select2data.d_$s1 = new Object();\n";        
                    999:         $result.="select2data.d_$s1.def = new String('".
                   1000:             $hashref->{$s1}->{'default'}."');\n";
1.609     raeburn  1001:         $result.="select2data.d_$s1.values = new Array(";
1.36      matthew  1002:         my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609     raeburn  1003:         if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
                   1004:             @s2values = @{$hashref->{$s1}->{'order'}};
                   1005:         }
1.36      matthew  1006:         $result.="\"@s2values\");\n";
                   1007:         $result.="select2data.d_$s1.texts = new Array(";        
                   1008:         my @s2texts;
                   1009:         foreach my $value (@s2values) {
                   1010:             push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
                   1011:         }
                   1012:         $result.="\"@s2texts\");\n";
                   1013:     }
                   1014:     $"=' ';
                   1015:     $result.= <<"END";
                   1016: 
                   1017: function select1_changed() {
                   1018:     // Determine new choice
                   1019:     var newvalue = "d_" + $first.value;
                   1020:     // update select2
                   1021:     var values     = select2data[newvalue].values;
                   1022:     var texts      = select2data[newvalue].texts;
                   1023:     var select2def = select2data[newvalue].def;
                   1024:     var i;
                   1025:     // out with the old
                   1026:     for (i = 0; i < $second.options.length; i++) {
                   1027:         $second.options[i] = null;
                   1028:     }
                   1029:     // in with the nuclear
                   1030:     for (i=0;i<values.length; i++) {
                   1031:         $second.options[i] = new Option(values[i]);
1.143     matthew  1032:         $second.options[i].value = values[i];
1.36      matthew  1033:         $second.options[i].text = texts[i];
                   1034:         if (values[i] == select2def) {
                   1035:             $second.options[i].selected = true;
                   1036:         }
                   1037:     }
                   1038: }
1.824     bisitz   1039: // ]]>
1.36      matthew  1040: </script>
                   1041: END
                   1042:     # output the initial values for the selection lists
                   1043:     $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609     raeburn  1044:     my @order = sort(keys(%{$hashref}));
                   1045:     if (ref($menuorder) eq 'ARRAY') {
                   1046:         @order = @{$menuorder};
                   1047:     }
                   1048:     foreach my $value (@order) {
1.36      matthew  1049:         $result.="    <option value=\"$value\" ";
1.253     albertel 1050:         $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119     www      1051:         $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36      matthew  1052:     }
                   1053:     $result .= "</select>\n";
                   1054:     my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
                   1055:     $result .= $middletext;
                   1056:     $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
                   1057:     my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609     raeburn  1058:     
                   1059:     my @secondorder = sort(keys(%select2));
                   1060:     if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
                   1061:         @secondorder = @{$hashref->{$firstdefault}->{'order'}};
                   1062:     }
                   1063:     foreach my $value (@secondorder) {
1.36      matthew  1064:         $result.="    <option value=\"$value\" ";        
1.253     albertel 1065:         $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119     www      1066:         $result.=">".&mt($select2{$value})."</option>\n";
1.36      matthew  1067:     }
                   1068:     $result .= "</select>\n";
                   1069:     #    return $debug;
                   1070:     return $result;
                   1071: }   #  end of sub linked_select_forms {
                   1072: 
1.45      matthew  1073: =pod
1.44      bowersj2 1074: 
1.648     raeburn  1075: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44      bowersj2 1076: 
1.112     bowersj2 1077: Returns a string corresponding to an HTML link to the given help
                   1078: $topic, where $topic corresponds to the name of a .tex file in
                   1079: /home/httpd/html/adm/help/tex, with underscores replaced by
                   1080: spaces. 
                   1081: 
                   1082: $text will optionally be linked to the same topic, allowing you to
                   1083: link text in addition to the graphic. If you do not want to link
                   1084: text, but wish to specify one of the later parameters, pass an
                   1085: empty string. 
                   1086: 
                   1087: $stayOnPage is a value that will be interpreted as a boolean. If true,
                   1088: the link will not open a new window. If false, the link will open
                   1089: a new window using Javascript. (Default is false.) 
                   1090: 
                   1091: $width and $height are optional numerical parameters that will
                   1092: override the width and height of the popped up window, which may
                   1093: be useful for certain help topics with big pictures included. 
1.44      bowersj2 1094: 
                   1095: =cut
                   1096: 
                   1097: sub help_open_topic {
1.48      bowersj2 1098:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
                   1099:     $text = "" if (not defined $text);
1.44      bowersj2 1100:     $stayOnPage = 0 if (not defined $stayOnPage);
                   1101:     $width = 350 if (not defined $width);
                   1102:     $height = 400 if (not defined $height);
                   1103:     my $filename = $topic;
                   1104:     $filename =~ s/ /_/g;
                   1105: 
1.48      bowersj2 1106:     my $template = "";
                   1107:     my $link;
1.572     banghart 1108:     
1.159     www      1109:     $topic=~s/\W/\_/g;
1.44      bowersj2 1110: 
1.572     banghart 1111:     if (!$stayOnPage) {
1.72      bowersj2 1112: 	$link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572     banghart 1113:     } else {
1.48      bowersj2 1114: 	$link = "/adm/help/${filename}.hlp";
                   1115:     }
                   1116: 
                   1117:     # Add the text
1.755     neumanie 1118:     if ($text ne "") {	
1.763     bisitz   1119: 	$template.='<span class="LC_help_open_topic">'
                   1120:                   .'<a target="_top" href="'.$link.'">'
                   1121:                   .$text.'</a>';
1.48      bowersj2 1122:     }
                   1123: 
1.763     bisitz   1124:     # (Always) Add the graphic
1.179     matthew  1125:     my $title = &mt('Online Help');
1.667     raeburn  1126:     my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763     bisitz   1127:     $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
                   1128:               .'<img src="'.$helpicon.'" border="0"'
                   1129:               .' alt="'.&mt('Help: [_1]',$topic).'"'
1.783     amueller 1130:               .' title="'.$title.'"' 
1.763     bisitz   1131:               .' /></a>';
                   1132:     if ($text ne "") {	
                   1133:         $template.='</span>';
                   1134:     }
1.44      bowersj2 1135:     return $template;
                   1136: 
1.106     bowersj2 1137: }
                   1138: 
                   1139: # This is a quicky function for Latex cheatsheet editing, since it 
                   1140: # appears in at least four places
                   1141: sub helpLatexCheatsheet {
1.732     raeburn  1142:     my ($topic,$text,$not_author) = @_;
                   1143:     my $out;
1.106     bowersj2 1144:     my $addOther = '';
1.732     raeburn  1145:     if ($topic) {
1.763     bisitz   1146: 	$addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
                   1147: 							       undef, undef, 600).
                   1148: 								   '</span> ';
                   1149:     }
                   1150:     $out = '<span>' # Start cheatsheet
                   1151: 	  .$addOther
                   1152:           .'<span>'
                   1153: 	  .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
                   1154: 					       undef,undef,600)
                   1155: 	  .'</span> <span>'
                   1156: 	  .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
                   1157: 					       undef,undef,600)
                   1158: 	  .'</span>';
1.732     raeburn  1159:     unless ($not_author) {
1.763     bisitz   1160:         $out .= ' <span>'
                   1161: 	       .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
                   1162: 	                                            undef,undef,600)
                   1163: 	       .'</span>';
1.732     raeburn  1164:     }
1.763     bisitz   1165:     $out .= '</span>'; # End cheatsheet
1.732     raeburn  1166:     return $out;
1.172     www      1167: }
                   1168: 
1.430     albertel 1169: sub general_help {
                   1170:     my $helptopic='Student_Intro';
                   1171:     if ($env{'request.role'}=~/^(ca|au)/) {
                   1172: 	$helptopic='Authoring_Intro';
1.907     raeburn  1173:     } elsif ($env{'request.role'}=~/^(cc|co)/) {
1.430     albertel 1174: 	$helptopic='Course_Coordination_Intro';
1.672     raeburn  1175:     } elsif ($env{'request.role'}=~/^dc/) {
                   1176:         $helptopic='Domain_Coordination_Intro';
1.430     albertel 1177:     }
                   1178:     return $helptopic;
                   1179: }
                   1180: 
                   1181: sub update_help_link {
                   1182:     my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
                   1183:     my $origurl = $ENV{'REQUEST_URI'};
                   1184:     $origurl=~s|^/~|/priv/|;
                   1185:     my $timestamp = time;
                   1186:     foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
                   1187:         $$datum = &escape($$datum);
                   1188:     }
                   1189: 
                   1190:     my $banner_link = "/adm/helpmenu?page=banner&amp;topic=$topic&amp;component_help=$component_help&amp;faq=$faq&amp;bug=$bug&amp;origurl=$origurl&amp;stamp=$timestamp&amp;stayonpage=$stayOnPage";
                   1191:     my $output .= <<"ENDOUTPUT";
                   1192: <script type="text/javascript">
1.824     bisitz   1193: // <![CDATA[
1.430     albertel 1194: banner_link = '$banner_link';
1.824     bisitz   1195: // ]]>
1.430     albertel 1196: </script>
                   1197: ENDOUTPUT
                   1198:     return $output;
                   1199: }
                   1200: 
                   1201: # now just updates the help link and generates a blue icon
1.193     raeburn  1202: sub help_open_menu {
1.430     albertel 1203:     my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text) 
1.552     banghart 1204: 	= @_;    
1.430     albertel 1205:     $stayOnPage = 0 if (not defined $stayOnPage);
1.572     banghart 1206:     # only use pop-up help (stayOnPage == 0)
1.552     banghart 1207:     # if environment.remote is on (using remote control UI)
1.798     tempelho 1208:     if ($env{'environment.remote'} eq 'off' ) {
1.552     banghart 1209:         $stayOnPage=1;
1.430     albertel 1210:     }
                   1211:     my $output;
                   1212:     if ($component_help) {
                   1213: 	if (!$text) {
                   1214: 	    $output=&help_open_topic($component_help,undef,$stayOnPage,
                   1215: 				       $width,$height);
                   1216: 	} else {
                   1217: 	    my $help_text;
                   1218: 	    $help_text=&unescape($topic);
                   1219: 	    $output='<table><tr><td>'.
                   1220: 		&help_open_topic($component_help,$help_text,$stayOnPage,
                   1221: 				 $width,$height).'</td></tr></table>';
                   1222: 	}
                   1223:     }
                   1224:     my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
                   1225:     return $output.$banner_link;
                   1226: }
                   1227: 
                   1228: sub top_nav_help {
                   1229:     my ($text) = @_;
1.436     albertel 1230:     $text = &mt($text);
1.572     banghart 1231:     my $stay_on_page = 
1.798     tempelho 1232: 	($env{'environment.remote'} eq 'off' );
1.572     banghart 1233:     my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436     albertel 1234: 	                     : "javascript:helpMenu('open')";
1.572     banghart 1235:     my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436     albertel 1236: 
1.201     raeburn  1237:     my $title = &mt('Get help');
1.436     albertel 1238: 
                   1239:     return <<"END";
                   1240: $banner_link
                   1241:  <a href="$link" title="$title">$text</a>
                   1242: END
                   1243: }
                   1244: 
                   1245: sub help_menu_js {
                   1246:     my ($text) = @_;
                   1247: 
                   1248:     my $stayOnPage = 
1.798     tempelho 1249: 	($env{'environment.remote'} eq 'off' );
1.436     albertel 1250: 
                   1251:     my $width = 620;
                   1252:     my $height = 600;
1.430     albertel 1253:     my $helptopic=&general_help();
                   1254:     my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261     albertel 1255:     my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331     albertel 1256:     my $start_page =
                   1257:         &Apache::loncommon::start_page('Help Menu', undef,
                   1258: 				       {'frameset'    => 1,
                   1259: 					'js_ready'    => 1,
                   1260: 					'add_entries' => {
                   1261: 					    'border' => '0',
1.579     raeburn  1262: 					    'rows'   => "110,*",},});
1.331     albertel 1263:     my $end_page =
                   1264:         &Apache::loncommon::end_page({'frameset' => 1,
                   1265: 				      'js_ready' => 1,});
                   1266: 
1.436     albertel 1267:     my $template .= <<"ENDTEMPLATE";
                   1268: <script type="text/javascript">
1.877     bisitz   1269: // <![CDATA[
1.253     albertel 1270: // <!-- BEGIN LON-CAPA Internal
1.430     albertel 1271: var banner_link = '';
1.243     raeburn  1272: function helpMenu(target) {
                   1273:     var caller = this;
                   1274:     if (target == 'open') {
                   1275:         var newWindow = null;
                   1276:         try {
1.262     albertel 1277:             newWindow =  window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243     raeburn  1278:         }
                   1279:         catch(error) {
                   1280:             writeHelp(caller);
                   1281:             return;
                   1282:         }
                   1283:         if (newWindow) {
                   1284:             caller = newWindow;
                   1285:         }
1.193     raeburn  1286:     }
1.243     raeburn  1287:     writeHelp(caller);
                   1288:     return;
                   1289: }
                   1290: function writeHelp(caller) {
1.430     albertel 1291:     caller.document.writeln('$start_page<frame name="bannerframe"  src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243     raeburn  1292:     caller.document.close()
                   1293:     caller.focus()
1.193     raeburn  1294: }
1.877     bisitz   1295: // END LON-CAPA Internal -->
1.253     albertel 1296: // ]]>
1.436     albertel 1297: </script>
1.193     raeburn  1298: ENDTEMPLATE
                   1299:     return $template;
                   1300: }
                   1301: 
1.172     www      1302: sub help_open_bug {
                   1303:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1304:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1305:     unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
                   1306:     $text = "" if (not defined $text);
                   1307:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1308:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1309: 	$stayOnPage=1;
                   1310:     }
1.184     albertel 1311:     $width = 600 if (not defined $width);
                   1312:     $height = 600 if (not defined $height);
1.172     www      1313: 
                   1314:     $topic=~s/\W+/\+/g;
                   1315:     my $link='';
                   1316:     my $template='';
1.379     albertel 1317:     my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&amp;bug_file_loc='.
                   1318: 	&escape($ENV{'REQUEST_URI'}).'&amp;component='.$topic;
1.172     www      1319:     if (!$stayOnPage)
                   1320:     {
                   1321: 	$link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1322:     }
                   1323:     else
                   1324:     {
                   1325: 	$link = $url;
                   1326:     }
                   1327:     # Add the text
                   1328:     if ($text ne "")
                   1329:     {
                   1330: 	$template .= 
                   1331:   "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1332:   "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172     www      1333:     }
                   1334: 
                   1335:     # Add the graphic
1.179     matthew  1336:     my $title = &mt('Report a Bug');
1.215     albertel 1337:     my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172     www      1338:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1339:  <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172     www      1340: ENDTEMPLATE
                   1341:     if ($text ne '') { $template.='</td></tr></table>' };
                   1342:     return $template;
                   1343: 
                   1344: }
                   1345: 
                   1346: sub help_open_faq {
                   1347:     my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258     albertel 1348:     unless ($env{'user.adv'}) { return ''; }
1.172     www      1349:     unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
                   1350:     $text = "" if (not defined $text);
                   1351:     $stayOnPage = 0 if (not defined $stayOnPage);
1.798     tempelho 1352:     if ($env{'environment.remote'} eq 'off' ) {
1.172     www      1353: 	$stayOnPage=1;
                   1354:     }
                   1355:     $width = 350 if (not defined $width);
                   1356:     $height = 400 if (not defined $height);
                   1357: 
                   1358:     $topic=~s/\W+/\+/g;
                   1359:     my $link='';
                   1360:     my $template='';
                   1361:     my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
                   1362:     if (!$stayOnPage)
                   1363:     {
                   1364: 	$link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
                   1365:     }
                   1366:     else
                   1367:     {
                   1368: 	$link = $url;
                   1369:     }
                   1370: 
                   1371:     # Add the text
                   1372:     if ($text ne "")
                   1373:     {
                   1374: 	$template .= 
1.173     www      1375:   "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705     tempelho 1376:   "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172     www      1377:     }
                   1378: 
                   1379:     # Add the graphic
1.179     matthew  1380:     my $title = &mt('View the FAQ');
1.215     albertel 1381:     my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172     www      1382:     $template .= <<"ENDTEMPLATE";
1.436     albertel 1383:  <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172     www      1384: ENDTEMPLATE
                   1385:     if ($text ne '') { $template.='</td></tr></table>' };
                   1386:     return $template;
                   1387: 
1.44      bowersj2 1388: }
1.37      matthew  1389: 
1.180     matthew  1390: ###############################################################
                   1391: ###############################################################
                   1392: 
1.45      matthew  1393: =pod
                   1394: 
1.648     raeburn  1395: =item * &change_content_javascript():
1.256     matthew  1396: 
                   1397: This and the next function allow you to create small sections of an
                   1398: otherwise static HTML page that you can update on the fly with
                   1399: Javascript, even in Netscape 4.
                   1400: 
                   1401: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
                   1402: must be written to the HTML page once. It will prove the Javascript
                   1403: function "change(name, content)". Calling the change function with the
                   1404: name of the section 
                   1405: you want to update, matching the name passed to C<changable_area>, and
                   1406: the new content you want to put in there, will put the content into
                   1407: that area.
                   1408: 
                   1409: B<Note>: Netscape 4 only reserves enough space for the changable area
                   1410: to contain room for the original contents. You need to "make space"
                   1411: for whatever changes you wish to make, and be B<sure> to check your
                   1412: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
                   1413: it's adequate for updating a one-line status display, but little more.
                   1414: This script will set the space to 100% width, so you only need to
                   1415: worry about height in Netscape 4.
                   1416: 
                   1417: Modern browsers are much less limiting, and if you can commit to the
                   1418: user not using Netscape 4, this feature may be used freely with
                   1419: pretty much any HTML.
                   1420: 
                   1421: =cut
                   1422: 
                   1423: sub change_content_javascript {
                   1424:     # If we're on Netscape 4, we need to use Layer-based code
1.258     albertel 1425:     if ($env{'browser.type'} eq 'netscape' &&
                   1426: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1427: 	return (<<NETSCAPE4);
                   1428: 	function change(name, content) {
                   1429: 	    doc = document.layers[name+"___escape"].layers[0].document;
                   1430: 	    doc.open();
                   1431: 	    doc.write(content);
                   1432: 	    doc.close();
                   1433: 	}
                   1434: NETSCAPE4
                   1435:     } else {
                   1436: 	# Otherwise, we need to use semi-standards-compliant code
                   1437: 	# (technically, "innerHTML" isn't standard but the equivalent
                   1438: 	# is really scary, and every useful browser supports it
                   1439: 	return (<<DOMBASED);
                   1440: 	function change(name, content) {
                   1441: 	    element = document.getElementById(name);
                   1442: 	    element.innerHTML = content;
                   1443: 	}
                   1444: DOMBASED
                   1445:     }
                   1446: }
                   1447: 
                   1448: =pod
                   1449: 
1.648     raeburn  1450: =item * &changable_area($name,$origContent):
1.256     matthew  1451: 
                   1452: This provides a "changable area" that can be modified on the fly via
                   1453: the Javascript code provided in C<change_content_javascript>. $name is
                   1454: the name you will use to reference the area later; do not repeat the
                   1455: same name on a given HTML page more then once. $origContent is what
                   1456: the area will originally contain, which can be left blank.
                   1457: 
                   1458: =cut
                   1459: 
                   1460: sub changable_area {
                   1461:     my ($name, $origContent) = @_;
                   1462: 
1.258     albertel 1463:     if ($env{'browser.type'} eq 'netscape' &&
                   1464: 	$env{'browser.version'} =~ /^4\./) {
1.256     matthew  1465: 	# If this is netscape 4, we need to use the Layer tag
                   1466: 	return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
                   1467:     } else {
                   1468: 	return "<span id='$name'>$origContent</span>";
                   1469:     }
                   1470: }
                   1471: 
                   1472: =pod
                   1473: 
1.648     raeburn  1474: =item * &viewport_geometry_js 
1.590     raeburn  1475: 
                   1476: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
                   1477: 
                   1478: =cut
                   1479: 
                   1480: 
                   1481: sub viewport_geometry_js { 
                   1482:     return <<"GEOMETRY";
                   1483: var Geometry = {};
                   1484: function init_geometry() {
                   1485:     if (Geometry.init) { return };
                   1486:     Geometry.init=1;
                   1487:     if (window.innerHeight) {
                   1488:         Geometry.getViewportHeight   = function() { return window.innerHeight; };
                   1489:         Geometry.getViewportWidth   = function() { return window.innerWidth; };
                   1490:         Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
                   1491:         Geometry.getVerticalScroll   = function() { return window.pageYOffset; };
                   1492:     }
                   1493:     else if (document.documentElement && document.documentElement.clientHeight) {
                   1494:         Geometry.getViewportHeight =
                   1495:             function() { return document.documentElement.clientHeight; };
                   1496:         Geometry.getViewportWidth =
                   1497:             function() { return document.documentElement.clientWidth; };
                   1498: 
                   1499:         Geometry.getHorizontalScroll =
                   1500:             function() { return document.documentElement.scrollLeft; };
                   1501:         Geometry.getVerticalScroll =
                   1502:             function() { return document.documentElement.scrollTop; };
                   1503:     }
                   1504:     else if (document.body.clientHeight) {
                   1505:         Geometry.getViewportHeight =
                   1506:             function() { return document.body.clientHeight; };
                   1507:         Geometry.getViewportWidth =
                   1508:             function() { return document.body.clientWidth; };
                   1509:         Geometry.getHorizontalScroll =
                   1510:             function() { return document.body.scrollLeft; };
                   1511:         Geometry.getVerticalScroll =
                   1512:             function() { return document.body.scrollTop; };
                   1513:     }
                   1514: }
                   1515: 
                   1516: GEOMETRY
                   1517: }
                   1518: 
                   1519: =pod
                   1520: 
1.648     raeburn  1521: =item * &viewport_size_js()
1.590     raeburn  1522: 
                   1523: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window. 
                   1524: 
                   1525: =cut
                   1526: 
                   1527: sub viewport_size_js {
                   1528:     my $geometry = &viewport_geometry_js();
                   1529:     return <<"DIMS";
                   1530: 
                   1531: $geometry
                   1532: 
                   1533: function getViewportDims(width,height) {
                   1534:     init_geometry();
                   1535:     width.value = Geometry.getViewportWidth();
                   1536:     height.value = Geometry.getViewportHeight();
                   1537:     return;
                   1538: }
                   1539: 
                   1540: DIMS
                   1541: }
                   1542: 
                   1543: =pod
                   1544: 
1.648     raeburn  1545: =item * &resize_textarea_js()
1.565     albertel 1546: 
                   1547: emits the needed javascript to resize a textarea to be as big as possible
                   1548: 
                   1549: creates a function resize_textrea that takes two IDs first should be
                   1550: the id of the element to resize, second should be the id of a div that
                   1551: surrounds everything that comes after the textarea, this routine needs
                   1552: to be attached to the <body> for the onload and onresize events.
                   1553: 
1.648     raeburn  1554: =back
1.565     albertel 1555: 
                   1556: =cut
                   1557: 
                   1558: sub resize_textarea_js {
1.590     raeburn  1559:     my $geometry = &viewport_geometry_js();
1.565     albertel 1560:     return <<"RESIZE";
                   1561:     <script type="text/javascript">
1.824     bisitz   1562: // <![CDATA[
1.590     raeburn  1563: $geometry
1.565     albertel 1564: 
1.588     albertel 1565: function getX(element) {
                   1566:     var x = 0;
                   1567:     while (element) {
                   1568: 	x += element.offsetLeft;
                   1569: 	element = element.offsetParent;
                   1570:     }
                   1571:     return x;
                   1572: }
                   1573: function getY(element) {
                   1574:     var y = 0;
                   1575:     while (element) {
                   1576: 	y += element.offsetTop;
                   1577: 	element = element.offsetParent;
                   1578:     }
                   1579:     return y;
                   1580: }
                   1581: 
                   1582: 
1.565     albertel 1583: function resize_textarea(textarea_id,bottom_id) {
                   1584:     init_geometry();
                   1585:     var textarea        = document.getElementById(textarea_id);
                   1586:     //alert(textarea);
                   1587: 
1.588     albertel 1588:     var textarea_top    = getY(textarea);
1.565     albertel 1589:     var textarea_height = textarea.offsetHeight;
                   1590:     var bottom          = document.getElementById(bottom_id);
1.588     albertel 1591:     var bottom_top      = getY(bottom);
1.565     albertel 1592:     var bottom_height   = bottom.offsetHeight;
                   1593:     var window_height   = Geometry.getViewportHeight();
1.588     albertel 1594:     var fudge           = 23;
1.565     albertel 1595:     var new_height      = window_height-fudge-textarea_top-bottom_height;
                   1596:     if (new_height < 300) {
                   1597: 	new_height = 300;
                   1598:     }
                   1599:     textarea.style.height=new_height+'px';
                   1600: }
1.824     bisitz   1601: // ]]>
1.565     albertel 1602: </script>
                   1603: RESIZE
                   1604: 
                   1605: }
                   1606: 
                   1607: =pod
                   1608: 
1.256     matthew  1609: =head1 Excel and CSV file utility routines
                   1610: 
                   1611: =over 4
                   1612: 
                   1613: =cut
                   1614: 
                   1615: ###############################################################
                   1616: ###############################################################
                   1617: 
                   1618: =pod
                   1619: 
1.648     raeburn  1620: =item * &csv_translate($text) 
1.37      matthew  1621: 
1.185     www      1622: Translate $text to allow it to be output as a 'comma separated values' 
1.37      matthew  1623: format.
                   1624: 
                   1625: =cut
                   1626: 
1.180     matthew  1627: ###############################################################
                   1628: ###############################################################
1.37      matthew  1629: sub csv_translate {
                   1630:     my $text = shift;
                   1631:     $text =~ s/\"/\"\"/g;
1.209     albertel 1632:     $text =~ s/\n/ /g;
1.37      matthew  1633:     return $text;
                   1634: }
1.180     matthew  1635: 
                   1636: ###############################################################
                   1637: ###############################################################
                   1638: 
                   1639: =pod
                   1640: 
1.648     raeburn  1641: =item * &define_excel_formats()
1.180     matthew  1642: 
                   1643: Define some commonly used Excel cell formats.
                   1644: 
                   1645: Currently supported formats:
                   1646: 
                   1647: =over 4
                   1648: 
                   1649: =item header
                   1650: 
                   1651: =item bold
                   1652: 
                   1653: =item h1
                   1654: 
                   1655: =item h2
                   1656: 
                   1657: =item h3
                   1658: 
1.256     matthew  1659: =item h4
                   1660: 
                   1661: =item i
                   1662: 
1.180     matthew  1663: =item date
                   1664: 
                   1665: =back
                   1666: 
                   1667: Inputs: $workbook
                   1668: 
                   1669: Returns: $format, a hash reference.
                   1670: 
                   1671: =cut
                   1672: 
                   1673: ###############################################################
                   1674: ###############################################################
                   1675: sub define_excel_formats {
                   1676:     my ($workbook) = @_;
                   1677:     my $format;
                   1678:     $format->{'header'} = $workbook->add_format(bold      => 1, 
                   1679:                                                 bottom    => 1,
                   1680:                                                 align     => 'center');
                   1681:     $format->{'bold'} = $workbook->add_format(bold=>1);
                   1682:     $format->{'h1'}   = $workbook->add_format(bold=>1, size=>18);
                   1683:     $format->{'h2'}   = $workbook->add_format(bold=>1, size=>16);
                   1684:     $format->{'h3'}   = $workbook->add_format(bold=>1, size=>14);
1.255     matthew  1685:     $format->{'h4'}   = $workbook->add_format(bold=>1, size=>12);
1.246     matthew  1686:     $format->{'i'}    = $workbook->add_format(italic=>1);
1.180     matthew  1687:     $format->{'date'} = $workbook->add_format(num_format=>
1.207     matthew  1688:                                             'mm/dd/yyyy hh:mm:ss');
1.180     matthew  1689:     return $format;
                   1690: }
                   1691: 
                   1692: ###############################################################
                   1693: ###############################################################
1.113     bowersj2 1694: 
                   1695: =pod
                   1696: 
1.648     raeburn  1697: =item * &create_workbook()
1.255     matthew  1698: 
                   1699: Create an Excel worksheet.  If it fails, output message on the
                   1700: request object and return undefs.
                   1701: 
                   1702: Inputs: Apache request object
                   1703: 
                   1704: Returns (undef) on failure, 
                   1705:     Excel worksheet object, scalar with filename, and formats 
                   1706:     from &Apache::loncommon::define_excel_formats on success
                   1707: 
                   1708: =cut
                   1709: 
                   1710: ###############################################################
                   1711: ###############################################################
                   1712: sub create_workbook {
                   1713:     my ($r) = @_;
                   1714:         #
                   1715:     # Create the excel spreadsheet
                   1716:     my $filename = '/prtspool/'.
1.258     albertel 1717:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255     matthew  1718:         time.'_'.rand(1000000000).'.xls';
                   1719:     my $workbook  = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
                   1720:     if (! defined($workbook)) {
                   1721:         $r->log_error("Error creating excel spreadsheet $filename: $!");
                   1722:         $r->print('<p>'.&mt("Unable to create new Excel file.  ".
                   1723:                             "This error has been logged.  ".
                   1724:                             "Please alert your LON-CAPA administrator").
                   1725:                   '</p>');
                   1726:         return (undef);
                   1727:     }
                   1728:     #
                   1729:     $workbook->set_tempdir('/home/httpd/perl/tmp');
                   1730:     #
                   1731:     my $format = &Apache::loncommon::define_excel_formats($workbook);
                   1732:     return ($workbook,$filename,$format);
                   1733: }
                   1734: 
                   1735: ###############################################################
                   1736: ###############################################################
                   1737: 
                   1738: =pod
                   1739: 
1.648     raeburn  1740: =item * &create_text_file()
1.113     bowersj2 1741: 
1.542     raeburn  1742: Create a file to write to and eventually make available to the user.
1.256     matthew  1743: If file creation fails, outputs an error message on the request object and 
                   1744: return undefs.
1.113     bowersj2 1745: 
1.256     matthew  1746: Inputs: Apache request object, and file suffix
1.113     bowersj2 1747: 
1.256     matthew  1748: Returns (undef) on failure, 
                   1749:     Filehandle and filename on success.
1.113     bowersj2 1750: 
                   1751: =cut
                   1752: 
1.256     matthew  1753: ###############################################################
                   1754: ###############################################################
                   1755: sub create_text_file {
                   1756:     my ($r,$suffix) = @_;
                   1757:     if (! defined($suffix)) { $suffix = 'txt'; };
                   1758:     my $fh;
                   1759:     my $filename = '/prtspool/'.
1.258     albertel 1760:         $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256     matthew  1761:         time.'_'.rand(1000000000).'.'.$suffix;
                   1762:     $fh = Apache::File->new('>/home/httpd'.$filename);
                   1763:     if (! defined($fh)) {
                   1764:         $r->log_error("Couldn't open $filename for output $!");
1.683     bisitz   1765:         $r->print(&mt('Problems occurred in creating the output file. '
                   1766:                      .'This error has been logged. '
                   1767:                      .'Please alert your LON-CAPA administrator.'));
1.113     bowersj2 1768:     }
1.256     matthew  1769:     return ($fh,$filename)
1.113     bowersj2 1770: }
                   1771: 
                   1772: 
1.256     matthew  1773: =pod 
1.113     bowersj2 1774: 
                   1775: =back
                   1776: 
                   1777: =cut
1.37      matthew  1778: 
                   1779: ###############################################################
1.33      matthew  1780: ##        Home server <option> list generating code          ##
                   1781: ###############################################################
1.35      matthew  1782: 
1.169     www      1783: # ------------------------------------------
                   1784: 
                   1785: sub domain_select {
                   1786:     my ($name,$value,$multiple)=@_;
                   1787:     my %domains=map { 
1.514     albertel 1788: 	$_ => $_.' '. &Apache::lonnet::domain($_,'description') 
1.512     albertel 1789:     } &Apache::lonnet::all_domains();
1.169     www      1790:     if ($multiple) {
                   1791: 	$domains{''}=&mt('Any domain');
1.550     albertel 1792: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287     albertel 1793: 	return &multiple_select_form($name,$value,4,\%domains);
1.169     www      1794:     } else {
1.550     albertel 1795: 	$domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169     www      1796: 	return &select_form($name,$value,%domains);
                   1797:     }
                   1798: }
                   1799: 
1.282     albertel 1800: #-------------------------------------------
                   1801: 
                   1802: =pod
                   1803: 
1.519     raeburn  1804: =head1 Routines for form select boxes
                   1805: 
                   1806: =over 4
                   1807: 
1.648     raeburn  1808: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282     albertel 1809: 
                   1810: Returns a string containing a <select> element int multiple mode
                   1811: 
                   1812: 
                   1813: Args:
                   1814:   $name - name of the <select> element
1.506     raeburn  1815:   $value - scalar or array ref of values that should already be selected
1.282     albertel 1816:   $size - number of rows long the select element is
1.283     albertel 1817:   $hash - the elements should be 'option' => 'shown text'
1.282     albertel 1818:           (shown text should already have been &mt())
1.506     raeburn  1819:   $order - (optional) array ref of the order to show the elements in
1.283     albertel 1820: 
1.282     albertel 1821: =cut
                   1822: 
                   1823: #-------------------------------------------
1.169     www      1824: sub multiple_select_form {
1.284     albertel 1825:     my ($name,$value,$size,$hash,$order)=@_;
1.169     www      1826:     my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
                   1827:     my $output='';
1.191     matthew  1828:     if (! defined($size)) {
                   1829:         $size = 4;
1.283     albertel 1830:         if (scalar(keys(%$hash))<4) {
                   1831:             $size = scalar(keys(%$hash));
1.191     matthew  1832:         }
                   1833:     }
1.734     bisitz   1834:     $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501     banghart 1835:     my @order;
1.506     raeburn  1836:     if (ref($order) eq 'ARRAY')  {
                   1837:         @order = @{$order};
                   1838:     } else {
                   1839:         @order = sort(keys(%$hash));
1.501     banghart 1840:     }
                   1841:     if (exists($$hash{'select_form_order'})) {
                   1842:         @order = @{$$hash{'select_form_order'}};
                   1843:     }
                   1844:         
1.284     albertel 1845:     foreach my $key (@order) {
1.356     albertel 1846:         $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284     albertel 1847:         $output.='selected="selected" ' if ($selected{$key});
                   1848:         $output.='>'.$hash->{$key}."</option>\n";
1.169     www      1849:     }
                   1850:     $output.="</select>\n";
                   1851:     return $output;
                   1852: }
                   1853: 
1.88      www      1854: #-------------------------------------------
                   1855: 
                   1856: =pod
                   1857: 
1.648     raeburn  1858: =item * &select_form($defdom,$name,%hash)
1.88      www      1859: 
                   1860: Returns a string containing a <select name='$name' size='1'> form to 
                   1861: allow a user to select options from a hash option_name => displayed text.  
                   1862: See lonrights.pm for an example invocation and use.
                   1863: 
                   1864: =cut
                   1865: 
                   1866: #-------------------------------------------
                   1867: sub select_form {
                   1868:     my ($def,$name,%hash) = @_;
                   1869:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128     albertel 1870:     my @keys;
                   1871:     if (exists($hash{'select_form_order'})) {
                   1872: 	@keys=@{$hash{'select_form_order'}};
                   1873:     } else {
                   1874: 	@keys=sort(keys(%hash));
                   1875:     }
1.356     albertel 1876:     foreach my $key (@keys) {
                   1877:         $selectform.=
                   1878: 	    '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
                   1879:             ($key eq $def ? 'selected="selected" ' : '').
                   1880:                 ">".&mt($hash{$key})."</option>\n";
1.88      www      1881:     }
                   1882:     $selectform.="</select>";
                   1883:     return $selectform;
                   1884: }
                   1885: 
1.475     www      1886: # For display filters
                   1887: 
                   1888: sub display_filter {
                   1889:     if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477     www      1890:     if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714     bisitz   1891:     return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475     www      1892: 			       &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
                   1893: 							   (&mt('all'),10,20,50,100,1000,10000))).
1.714     bisitz   1894: 	   '</label></span> <span class="LC_nobreak">'.
1.475     www      1895:            &mt('Filter [_1]',
1.477     www      1896: 	   &select_form($env{'form.displayfilter'},
                   1897: 			'displayfilter',
                   1898: 			('currentfolder' => 'Current folder/page',
                   1899: 			 'containing' => 'Containing phrase',
                   1900: 			 'none' => 'None'))).
1.714     bisitz   1901: 			 '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475     www      1902: }
                   1903: 
1.167     www      1904: sub gradeleveldescription {
                   1905:     my $gradelevel=shift;
                   1906:     my %gradelevels=(0 => 'Not specified',
                   1907: 		     1 => 'Grade 1',
                   1908: 		     2 => 'Grade 2',
                   1909: 		     3 => 'Grade 3',
                   1910: 		     4 => 'Grade 4',
                   1911: 		     5 => 'Grade 5',
                   1912: 		     6 => 'Grade 6',
                   1913: 		     7 => 'Grade 7',
                   1914: 		     8 => 'Grade 8',
                   1915: 		     9 => 'Grade 9',
                   1916: 		     10 => 'Grade 10',
                   1917: 		     11 => 'Grade 11',
                   1918: 		     12 => 'Grade 12',
                   1919: 		     13 => 'Grade 13',
                   1920: 		     14 => '100 Level',
                   1921: 		     15 => '200 Level',
                   1922: 		     16 => '300 Level',
                   1923: 		     17 => '400 Level',
                   1924: 		     18 => 'Graduate Level');
                   1925:     return &mt($gradelevels{$gradelevel});
                   1926: }
                   1927: 
1.163     www      1928: sub select_level_form {
                   1929:     my ($deflevel,$name)=@_;
                   1930:     unless ($deflevel) { $deflevel=0; }
1.167     www      1931:     my $selectform = "<select name=\"$name\" size=\"1\">\n";
                   1932:     for (my $i=0; $i<=18; $i++) {
                   1933:         $selectform.="<option value=\"$i\" ".
1.253     albertel 1934:             ($i==$deflevel ? 'selected="selected" ' : '').
1.167     www      1935:                 ">".&gradeleveldescription($i)."</option>\n";
                   1936:     }
                   1937:     $selectform.="</select>";
                   1938:     return $selectform;
1.163     www      1939: }
1.167     www      1940: 
1.35      matthew  1941: #-------------------------------------------
                   1942: 
1.45      matthew  1943: =pod
                   1944: 
1.910     raeburn  1945: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms)
1.35      matthew  1946: 
                   1947: Returns a string containing a <select name='$name' size='1'> form to 
                   1948: allow a user to select the domain to preform an operation in.  
                   1949: See loncreateuser.pm for an example invocation and use.
                   1950: 
1.90      www      1951: If the $includeempty flag is set, it also includes an empty choice ("no domain
                   1952: selected");
                   1953: 
1.743     raeburn  1954: If the $showdomdesc flag is set, the domain name is followed by the domain description.
                   1955: 
1.910     raeburn  1956: The optional $onchange argument specifies what should occur if the domain selector is changed, e.g., 'this.form.submit()' if the form is to be automatically submitted.
                   1957: 
                   1958: The optional $incdoms is a reference to an array of domains which will be the only available options. 
1.563     raeburn  1959: 
1.35      matthew  1960: =cut
                   1961: 
                   1962: #-------------------------------------------
1.34      matthew  1963: sub select_dom_form {
1.910     raeburn  1964:     my ($defdom,$name,$includeempty,$showdomdesc,$onchange,$incdoms) = @_;
1.872     raeburn  1965:     if ($onchange) {
1.874     raeburn  1966:         $onchange = ' onchange="'.$onchange.'"';
1.743     raeburn  1967:     }
1.910     raeburn  1968:     my @domains;
                   1969:     if (ref($incdoms) eq 'ARRAY') {
                   1970:         @domains = sort {lc($a) cmp lc($b)} (@{$incdoms});
                   1971:     } else {
                   1972:         @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
                   1973:     }
1.90      www      1974:     if ($includeempty) { @domains=('',@domains); }
1.743     raeburn  1975:     my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356     albertel 1976:     foreach my $dom (@domains) {
                   1977:         $selectdomain.="<option value=\"$dom\" ".
1.563     raeburn  1978:             ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
                   1979:         if ($showdomdesc) {
                   1980:             if ($dom ne '') {
                   1981:                 my $domdesc = &Apache::lonnet::domain($dom,'description');
                   1982:                 if ($domdesc ne '') {
                   1983:                     $selectdomain .= ' ('.$domdesc.')';
                   1984:                 }
                   1985:             } 
                   1986:         }
                   1987:         $selectdomain .= "</option>\n";
1.34      matthew  1988:     }
                   1989:     $selectdomain.="</select>";
                   1990:     return $selectdomain;
                   1991: }
                   1992: 
1.35      matthew  1993: #-------------------------------------------
                   1994: 
1.45      matthew  1995: =pod
                   1996: 
1.648     raeburn  1997: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35      matthew  1998: 
1.586     raeburn  1999: input: 4 arguments (two required, two optional) - 
                   2000:     $domain - domain of new user
                   2001:     $name - name of form element
                   2002:     $default - Value of 'default' causes a default item to be first 
                   2003:                             option, and selected by default. 
                   2004:     $hide - Value of 'hide' causes hiding of the name of the server, 
                   2005:                             if 1 server found, or default, if 0 found.
1.594     raeburn  2006: output: returns 2 items: 
1.586     raeburn  2007: (a) form element which contains either:
                   2008:    (i) <select name="$name">
                   2009:         <option value="$hostid1">$hostid $servers{$hostid}</option>
                   2010:         <option value="$hostid2">$hostid $servers{$hostid}</option>       
                   2011:        </select>
                   2012:        form item if there are multiple library servers in $domain, or
                   2013:    (ii) an <input type="hidden" name="$name" value="$hostid" /> form item 
                   2014:        if there is only one library server in $domain.
                   2015: 
                   2016: (b) number of library servers found.
                   2017: 
                   2018: See loncreateuser.pm for example of use.
1.35      matthew  2019: 
                   2020: =cut
                   2021: 
                   2022: #-------------------------------------------
1.586     raeburn  2023: sub home_server_form_item {
                   2024:     my ($domain,$name,$default,$hide) = @_;
1.513     albertel 2025:     my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586     raeburn  2026:     my $result;
                   2027:     my $numlib = keys(%servers);
                   2028:     if ($numlib > 1) {
                   2029:         $result .= '<select name="'.$name.'" />'."\n";
                   2030:         if ($default) {
1.804     bisitz   2031:             $result .= '<option value="default" selected="selected">'.&mt('default').
1.586     raeburn  2032:                        '</option>'."\n";
                   2033:         }
                   2034:         foreach my $hostid (sort(keys(%servers))) {
                   2035:             $result.= '<option value="'.$hostid.'">'.
                   2036: 	              $hostid.' '.$servers{$hostid}."</option>\n";
                   2037:         }
                   2038:         $result .= '</select>'."\n";
                   2039:     } elsif ($numlib == 1) {
                   2040:         my $hostid;
                   2041:         foreach my $item (keys(%servers)) {
                   2042:             $hostid = $item;
                   2043:         }
                   2044:         $result .= '<input type="hidden" name="'.$name.'" value="'.
                   2045:                    $hostid.'" />';
                   2046:                    if (!$hide) {
                   2047:                        $result .= $hostid.' '.$servers{$hostid};
                   2048:                    }
                   2049:                    $result .= "\n";
                   2050:     } elsif ($default) {
                   2051:         $result .= '<input type="hidden" name="'.$name.
                   2052:                    '" value="default" />';
                   2053:                    if (!$hide) {
                   2054:                        $result .= &mt('default');
                   2055:                    }
                   2056:                    $result .= "\n";
1.33      matthew  2057:     }
1.586     raeburn  2058:     return ($result,$numlib);
1.33      matthew  2059: }
1.112     bowersj2 2060: 
                   2061: =pod
                   2062: 
1.534     albertel 2063: =back 
                   2064: 
1.112     bowersj2 2065: =cut
1.87      matthew  2066: 
                   2067: ###############################################################
1.112     bowersj2 2068: ##                  Decoding User Agent                      ##
1.87      matthew  2069: ###############################################################
                   2070: 
                   2071: =pod
                   2072: 
1.112     bowersj2 2073: =head1 Decoding the User Agent
                   2074: 
                   2075: =over 4
                   2076: 
                   2077: =item * &decode_user_agent()
1.87      matthew  2078: 
                   2079: Inputs: $r
                   2080: 
                   2081: Outputs:
                   2082: 
                   2083: =over 4
                   2084: 
1.112     bowersj2 2085: =item * $httpbrowser
1.87      matthew  2086: 
1.112     bowersj2 2087: =item * $clientbrowser
1.87      matthew  2088: 
1.112     bowersj2 2089: =item * $clientversion
1.87      matthew  2090: 
1.112     bowersj2 2091: =item * $clientmathml
1.87      matthew  2092: 
1.112     bowersj2 2093: =item * $clientunicode
1.87      matthew  2094: 
1.112     bowersj2 2095: =item * $clientos
1.87      matthew  2096: 
                   2097: =back
                   2098: 
1.157     matthew  2099: =back 
                   2100: 
1.87      matthew  2101: =cut
                   2102: 
                   2103: ###############################################################
                   2104: ###############################################################
                   2105: sub decode_user_agent {
1.247     albertel 2106:     my ($r)=@_;
1.87      matthew  2107:     my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
                   2108:     my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
                   2109:     my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247     albertel 2110:     if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87      matthew  2111:     my $clientbrowser='unknown';
                   2112:     my $clientversion='0';
                   2113:     my $clientmathml='';
                   2114:     my $clientunicode='0';
                   2115:     for (my $i=0;$i<=$#browsertype;$i++) {
                   2116:         my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
                   2117: 	if (($httpbrowser=~/$match/i)  && ($httpbrowser!~/$notmatch/i)) {
                   2118: 	    $clientbrowser=$bname;
                   2119:             $httpbrowser=~/$vreg/i;
                   2120: 	    $clientversion=$1;
                   2121:             $clientmathml=($clientversion>=$minv);
                   2122:             $clientunicode=($clientversion>=$univ);
                   2123: 	}
                   2124:     }
                   2125:     my $clientos='unknown';
                   2126:     if (($httpbrowser=~/linux/i) ||
                   2127:         ($httpbrowser=~/unix/i) ||
                   2128:         ($httpbrowser=~/ux/i) ||
                   2129:         ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
                   2130:     if (($httpbrowser=~/vax/i) ||
                   2131:         ($httpbrowser=~/vms/i)) { $clientos='vms'; }
                   2132:     if ($httpbrowser=~/next/i) { $clientos='next'; }
                   2133:     if (($httpbrowser=~/mac/i) ||
                   2134:         ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
                   2135:     if ($httpbrowser=~/win/i) { $clientos='win'; }
                   2136:     if ($httpbrowser=~/embed/i) { $clientos='pda'; }
                   2137:     return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   2138:             $clientunicode,$clientos,);
                   2139: }
                   2140: 
1.32      matthew  2141: ###############################################################
                   2142: ##    Authentication changing form generation subroutines    ##
                   2143: ###############################################################
                   2144: ##
                   2145: ## All of the authform_xxxxxxx subroutines take their inputs in a
                   2146: ## hash, and have reasonable default values.
                   2147: ##
                   2148: ##    formname = the name given in the <form> tag.
1.35      matthew  2149: #-------------------------------------------
                   2150: 
1.45      matthew  2151: =pod
                   2152: 
1.112     bowersj2 2153: =head1 Authentication Routines
                   2154: 
                   2155: =over 4
                   2156: 
1.648     raeburn  2157: =item * &authform_xxxxxx()
1.35      matthew  2158: 
                   2159: The authform_xxxxxx subroutines provide javascript and html forms which 
                   2160: handle some of the conveniences required for authentication forms.  
                   2161: This is not an optimal method, but it works.  
                   2162: 
                   2163: =over 4
                   2164: 
1.112     bowersj2 2165: =item * authform_header
1.35      matthew  2166: 
1.112     bowersj2 2167: =item * authform_authorwarning
1.35      matthew  2168: 
1.112     bowersj2 2169: =item * authform_nochange
1.35      matthew  2170: 
1.112     bowersj2 2171: =item * authform_kerberos
1.35      matthew  2172: 
1.112     bowersj2 2173: =item * authform_internal
1.35      matthew  2174: 
1.112     bowersj2 2175: =item * authform_filesystem
1.35      matthew  2176: 
                   2177: =back
                   2178: 
1.648     raeburn  2179: See loncreateuser.pm for invocation and use examples.
1.157     matthew  2180: 
1.35      matthew  2181: =cut
                   2182: 
                   2183: #-------------------------------------------
1.32      matthew  2184: sub authform_header{  
                   2185:     my %in = (
                   2186:         formname => 'cu',
1.80      albertel 2187:         kerb_def_dom => '',
1.32      matthew  2188:         @_,
                   2189:     );
                   2190:     $in{'formname'} = 'document.' . $in{'formname'};
                   2191:     my $result='';
1.80      albertel 2192: 
                   2193: #---------------------------------------------- Code for upper case translation
                   2194:     my $Javascript_toUpperCase;
                   2195:     unless ($in{kerb_def_dom}) {
                   2196:         $Javascript_toUpperCase =<<"END";
                   2197:         switch (choice) {
                   2198:            case 'krb': currentform.elements[choicearg].value =
                   2199:                currentform.elements[choicearg].value.toUpperCase();
                   2200:                break;
                   2201:            default:
                   2202:         }
                   2203: END
                   2204:     } else {
                   2205:         $Javascript_toUpperCase = "";
                   2206:     }
                   2207: 
1.165     raeburn  2208:     my $radioval = "'nochange'";
1.591     raeburn  2209:     if (defined($in{'curr_authtype'})) {
                   2210:         if ($in{'curr_authtype'} ne '') {
                   2211:             $radioval = "'".$in{'curr_authtype'}."arg'";
                   2212:         }
1.174     matthew  2213:     }
1.165     raeburn  2214:     my $argfield = 'null';
1.591     raeburn  2215:     if (defined($in{'mode'})) {
1.165     raeburn  2216:         if ($in{'mode'} eq 'modifycourse')  {
1.591     raeburn  2217:             if (defined($in{'curr_autharg'})) {
                   2218:                 if ($in{'curr_autharg'} ne '') {
1.165     raeburn  2219:                     $argfield = "'$in{'curr_autharg'}'";
                   2220:                 }
                   2221:             }
                   2222:         }
                   2223:     }
                   2224: 
1.32      matthew  2225:     $result.=<<"END";
                   2226: var current = new Object();
1.165     raeburn  2227: current.radiovalue = $radioval;
                   2228: current.argfield = $argfield;
1.32      matthew  2229: 
                   2230: function changed_radio(choice,currentform) {
                   2231:     var choicearg = choice + 'arg';
                   2232:     // If a radio button in changed, we need to change the argfield
                   2233:     if (current.radiovalue != choice) {
                   2234:         current.radiovalue = choice;
                   2235:         if (current.argfield != null) {
                   2236:             currentform.elements[current.argfield].value = '';
                   2237:         }
                   2238:         if (choice == 'nochange') {
                   2239:             current.argfield = null;
                   2240:         } else {
                   2241:             current.argfield = choicearg;
                   2242:             switch(choice) {
                   2243:                 case 'krb': 
                   2244:                     currentform.elements[current.argfield].value = 
                   2245:                         "$in{'kerb_def_dom'}";
                   2246:                 break;
                   2247:               default:
                   2248:                 break;
                   2249:             }
                   2250:         }
                   2251:     }
                   2252:     return;
                   2253: }
1.22      www      2254: 
1.32      matthew  2255: function changed_text(choice,currentform) {
                   2256:     var choicearg = choice + 'arg';
                   2257:     if (currentform.elements[choicearg].value !='') {
1.80      albertel 2258:         $Javascript_toUpperCase
1.32      matthew  2259:         // clear old field
                   2260:         if ((current.argfield != choicearg) && (current.argfield != null)) {
                   2261:             currentform.elements[current.argfield].value = '';
                   2262:         }
                   2263:         current.argfield = choicearg;
                   2264:     }
                   2265:     set_auth_radio_buttons(choice,currentform);
                   2266:     return;
1.20      www      2267: }
1.32      matthew  2268: 
                   2269: function set_auth_radio_buttons(newvalue,currentform) {
                   2270:     var i=0;
                   2271:     while (i < currentform.login.length) {
                   2272:         if (currentform.login[i].value == newvalue) { break; }
                   2273:         i++;
                   2274:     }
                   2275:     if (i == currentform.login.length) {
                   2276:         return;
                   2277:     }
                   2278:     current.radiovalue = newvalue;
                   2279:     currentform.login[i].checked = true;
                   2280:     return;
                   2281: }
                   2282: END
                   2283:     return $result;
                   2284: }
                   2285: 
                   2286: sub authform_authorwarning{
                   2287:     my $result='';
1.144     matthew  2288:     $result='<i>'.
                   2289:         &mt('As a general rule, only authors or co-authors should be '.
                   2290:             'filesystem authenticated '.
                   2291:             '(which allows access to the server filesystem).')."</i>\n";
1.32      matthew  2292:     return $result;
                   2293: }
                   2294: 
                   2295: sub authform_nochange{  
                   2296:     my %in = (
                   2297:               formname => 'document.cu',
                   2298:               kerb_def_dom => 'MSU.EDU',
                   2299:               @_,
                   2300:           );
1.586     raeburn  2301:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'}); 
                   2302:     my $result;
                   2303:     if (keys(%can_assign) == 0) {
                   2304:         $result = &mt('Under you current role you are not permitted to change login settings for this user');  
                   2305:     } else {
                   2306:         $result = '<label>'.&mt('[_1] Do not change login data',
                   2307:                   '<input type="radio" name="login" value="nochange" '.
                   2308:                   'checked="checked" onclick="'.
1.281     albertel 2309:             "javascript:changed_radio('nochange',$in{'formname'});".'" />').
                   2310: 	    '</label>';
1.586     raeburn  2311:     }
1.32      matthew  2312:     return $result;
                   2313: }
                   2314: 
1.591     raeburn  2315: sub authform_kerberos {
1.32      matthew  2316:     my %in = (
                   2317:               formname => 'document.cu',
                   2318:               kerb_def_dom => 'MSU.EDU',
1.80      albertel 2319:               kerb_def_auth => 'krb4',
1.32      matthew  2320:               @_,
                   2321:               );
1.586     raeburn  2322:     my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
                   2323:         $autharg,$jscall);
                   2324:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.80      albertel 2325:     if ($in{'kerb_def_auth'} eq 'krb5') {
1.772     bisitz   2326:        $check5 = ' checked="checked"';
1.80      albertel 2327:     } else {
1.772     bisitz   2328:        $check4 = ' checked="checked"';
1.80      albertel 2329:     }
1.165     raeburn  2330:     $krbarg = $in{'kerb_def_dom'};
1.591     raeburn  2331:     if (defined($in{'curr_authtype'})) {
                   2332:         if ($in{'curr_authtype'} eq 'krb') {
1.772     bisitz   2333:             $krbcheck = ' checked="checked"';
1.623     raeburn  2334:             if (defined($in{'mode'})) {
                   2335:                 if ($in{'mode'} eq 'modifyuser') {
                   2336:                     $krbcheck = '';
                   2337:                 }
                   2338:             }
1.591     raeburn  2339:             if (defined($in{'curr_kerb_ver'})) {
                   2340:                 if ($in{'curr_krb_ver'} eq '5') {
1.772     bisitz   2341:                     $check5 = ' checked="checked"';
1.591     raeburn  2342:                     $check4 = '';
                   2343:                 } else {
1.772     bisitz   2344:                     $check4 = ' checked="checked"';
1.591     raeburn  2345:                     $check5 = '';
                   2346:                 }
1.586     raeburn  2347:             }
1.591     raeburn  2348:             if (defined($in{'curr_autharg'})) {
1.165     raeburn  2349:                 $krbarg = $in{'curr_autharg'};
                   2350:             }
1.586     raeburn  2351:             if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591     raeburn  2352:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2353:                     $result = 
                   2354:     &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
                   2355:         $in{'curr_autharg'},$krbver);
                   2356:                 } else {
                   2357:                     $result =
                   2358:     &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
                   2359:                 }
                   2360:                 return $result; 
                   2361:             }
                   2362:         }
                   2363:     } else {
                   2364:         if ($authnum == 1) {
1.784     bisitz   2365:             $authtype = '<input type="hidden" name="login" value="krb" />';
1.165     raeburn  2366:         }
                   2367:     }
1.586     raeburn  2368:     if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
                   2369:         return;
1.587     raeburn  2370:     } elsif ($authtype eq '') {
1.591     raeburn  2371:         if (defined($in{'mode'})) {
1.587     raeburn  2372:             if ($in{'mode'} eq 'modifycourse') {
                   2373:                 if ($authnum == 1) {
1.784     bisitz   2374:                     $authtype = '<input type="hidden" name="login" value="krb" />';
1.587     raeburn  2375:                 }
                   2376:             }
                   2377:         }
1.586     raeburn  2378:     }
                   2379:     $jscall = "javascript:changed_radio('krb',$in{'formname'});";
                   2380:     if ($authtype eq '') {
                   2381:         $authtype = '<input type="radio" name="login" value="krb" '.
                   2382:                     'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
                   2383:                     $krbcheck.' />';
                   2384:     }
                   2385:     if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
                   2386:         ($can_assign{'krb4'} && !$can_assign{'krb5'} && 
                   2387:          $in{'curr_authtype'} eq 'krb5') ||
                   2388:         (!$can_assign{'krb4'} && $can_assign{'krb5'} && 
                   2389:          $in{'curr_authtype'} eq 'krb4')) {
                   2390:         $result .= &mt
1.144     matthew  2391:         ('[_1] Kerberos authenticated with domain [_2] '.
1.281     albertel 2392:          '[_3] Version 4 [_4] Version 5 [_5]',
1.586     raeburn  2393:          '<label>'.$authtype,
1.281     albertel 2394:          '</label><input type="text" size="10" name="krbarg" '.
1.165     raeburn  2395:              'value="'.$krbarg.'" '.
1.144     matthew  2396:              'onchange="'.$jscall.'" />',
1.281     albertel 2397:          '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
                   2398:          '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
                   2399: 	 '</label>');
1.586     raeburn  2400:     } elsif ($can_assign{'krb4'}) {
                   2401:         $result .= &mt
                   2402:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2403:          '[_3] Version 4 [_4]',
                   2404:          '<label>'.$authtype,
                   2405:          '</label><input type="text" size="10" name="krbarg" '.
                   2406:              'value="'.$krbarg.'" '.
                   2407:              'onchange="'.$jscall.'" />',
                   2408:          '<label><input type="hidden" name="krbver" value="4" />',
                   2409:          '</label>');
                   2410:     } elsif ($can_assign{'krb5'}) {
                   2411:         $result .= &mt
                   2412:         ('[_1] Kerberos authenticated with domain [_2] '.
                   2413:          '[_3] Version 5 [_4]',
                   2414:          '<label>'.$authtype,
                   2415:          '</label><input type="text" size="10" name="krbarg" '.
                   2416:              'value="'.$krbarg.'" '.
                   2417:              'onchange="'.$jscall.'" />',
                   2418:          '<label><input type="hidden" name="krbver" value="5" />',
                   2419:          '</label>');
                   2420:     }
1.32      matthew  2421:     return $result;
                   2422: }
                   2423: 
                   2424: sub authform_internal{  
1.586     raeburn  2425:     my %in = (
1.32      matthew  2426:                 formname => 'document.cu',
                   2427:                 kerb_def_dom => 'MSU.EDU',
                   2428:                 @_,
                   2429:                 );
1.586     raeburn  2430:     my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
                   2431:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2432:     if (defined($in{'curr_authtype'})) {
                   2433:         if ($in{'curr_authtype'} eq 'int') {
1.586     raeburn  2434:             if ($can_assign{'int'}) {
1.772     bisitz   2435:                 $intcheck = 'checked="checked" ';
1.623     raeburn  2436:                 if (defined($in{'mode'})) {
                   2437:                     if ($in{'mode'} eq 'modifyuser') {
                   2438:                         $intcheck = '';
                   2439:                     }
                   2440:                 }
1.591     raeburn  2441:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2442:                     $intarg = $in{'curr_autharg'};
                   2443:                 }
                   2444:             } else {
                   2445:                 $result = &mt('Currently internally authenticated.');
                   2446:                 return $result;
1.165     raeburn  2447:             }
                   2448:         }
1.586     raeburn  2449:     } else {
                   2450:         if ($authnum == 1) {
1.784     bisitz   2451:             $authtype = '<input type="hidden" name="login" value="int" />';
1.586     raeburn  2452:         }
                   2453:     }
                   2454:     if (!$can_assign{'int'}) {
                   2455:         return;
1.587     raeburn  2456:     } elsif ($authtype eq '') {
1.591     raeburn  2457:         if (defined($in{'mode'})) {
1.587     raeburn  2458:             if ($in{'mode'} eq 'modifycourse') {
                   2459:                 if ($authnum == 1) {
1.784     bisitz   2460:                     $authtype = '<input type="hidden" name="login" value="int" />';
1.587     raeburn  2461:                 }
                   2462:             }
                   2463:         }
1.165     raeburn  2464:     }
1.586     raeburn  2465:     $jscall = "javascript:changed_radio('int',$in{'formname'});";
                   2466:     if ($authtype eq '') {
                   2467:         $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
                   2468:                     ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
                   2469:     }
1.605     bisitz   2470:     $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586     raeburn  2471:                $intarg.'" onchange="'.$jscall.'" />';
                   2472:     $result = &mt
1.144     matthew  2473:         ('[_1] Internally authenticated (with initial password [_2])',
1.586     raeburn  2474:          '<label>'.$authtype,'</label>'.$autharg);
1.824     bisitz   2475:     $result.="<label><input type=\"checkbox\" name=\"visible\" onclick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32      matthew  2476:     return $result;
                   2477: }
                   2478: 
                   2479: sub authform_local{  
                   2480:     my %in = (
                   2481:               formname => 'document.cu',
                   2482:               kerb_def_dom => 'MSU.EDU',
                   2483:               @_,
                   2484:               );
1.586     raeburn  2485:     my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
                   2486:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2487:     if (defined($in{'curr_authtype'})) {
                   2488:         if ($in{'curr_authtype'} eq 'loc') {
1.586     raeburn  2489:             if ($can_assign{'loc'}) {
1.772     bisitz   2490:                 $loccheck = 'checked="checked" ';
1.623     raeburn  2491:                 if (defined($in{'mode'})) {
                   2492:                     if ($in{'mode'} eq 'modifyuser') {
                   2493:                         $loccheck = '';
                   2494:                     }
                   2495:                 }
1.591     raeburn  2496:                 if (defined($in{'curr_autharg'})) {
1.586     raeburn  2497:                     $locarg = $in{'curr_autharg'};
                   2498:                 }
                   2499:             } else {
                   2500:                 $result = &mt('Currently using local (institutional) authentication.');
                   2501:                 return $result;
1.165     raeburn  2502:             }
                   2503:         }
1.586     raeburn  2504:     } else {
                   2505:         if ($authnum == 1) {
1.784     bisitz   2506:             $authtype = '<input type="hidden" name="login" value="loc" />';
1.586     raeburn  2507:         }
                   2508:     }
                   2509:     if (!$can_assign{'loc'}) {
                   2510:         return;
1.587     raeburn  2511:     } elsif ($authtype eq '') {
1.591     raeburn  2512:         if (defined($in{'mode'})) {
1.587     raeburn  2513:             if ($in{'mode'} eq 'modifycourse') {
                   2514:                 if ($authnum == 1) {
1.784     bisitz   2515:                     $authtype = '<input type="hidden" name="login" value="loc" />';
1.587     raeburn  2516:                 }
                   2517:             }
                   2518:         }
1.165     raeburn  2519:     }
1.586     raeburn  2520:     $jscall = "javascript:changed_radio('loc',$in{'formname'});";
                   2521:     if ($authtype eq '') {
                   2522:         $authtype = '<input type="radio" name="login" value="loc" '.
                   2523:                     $loccheck.' onchange="'.$jscall.'" onclick="'.
                   2524:                     $jscall.'" />';
                   2525:     }
                   2526:     $autharg = '<input type="text" size="10" name="locarg" value="'.
                   2527:                $locarg.'" onchange="'.$jscall.'" />';
                   2528:     $result = &mt('[_1] Local Authentication with argument [_2]',
                   2529:                   '<label>'.$authtype,'</label>'.$autharg);
1.32      matthew  2530:     return $result;
                   2531: }
                   2532: 
                   2533: sub authform_filesystem{  
                   2534:     my %in = (
                   2535:               formname => 'document.cu',
                   2536:               kerb_def_dom => 'MSU.EDU',
                   2537:               @_,
                   2538:               );
1.586     raeburn  2539:     my ($fsyscheck,$result,$authtype,$autharg,$jscall);
                   2540:     my ($authnum,%can_assign) =  &get_assignable_auth($in{'domain'});
1.591     raeburn  2541:     if (defined($in{'curr_authtype'})) {
                   2542:         if ($in{'curr_authtype'} eq 'fsys') {
1.586     raeburn  2543:             if ($can_assign{'fsys'}) {
1.772     bisitz   2544:                 $fsyscheck = 'checked="checked" ';
1.623     raeburn  2545:                 if (defined($in{'mode'})) {
                   2546:                     if ($in{'mode'} eq 'modifyuser') {
                   2547:                         $fsyscheck = '';
                   2548:                     }
                   2549:                 }
1.586     raeburn  2550:             } else {
                   2551:                 $result = &mt('Currently Filesystem Authenticated.');
                   2552:                 return $result;
                   2553:             }           
                   2554:         }
                   2555:     } else {
                   2556:         if ($authnum == 1) {
1.784     bisitz   2557:             $authtype = '<input type="hidden" name="login" value="fsys" />';
1.586     raeburn  2558:         }
                   2559:     }
                   2560:     if (!$can_assign{'fsys'}) {
                   2561:         return;
1.587     raeburn  2562:     } elsif ($authtype eq '') {
1.591     raeburn  2563:         if (defined($in{'mode'})) {
1.587     raeburn  2564:             if ($in{'mode'} eq 'modifycourse') {
                   2565:                 if ($authnum == 1) {
1.784     bisitz   2566:                     $authtype = '<input type="hidden" name="login" value="fsys" />';
1.587     raeburn  2567:                 }
                   2568:             }
                   2569:         }
1.586     raeburn  2570:     }
                   2571:     $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
                   2572:     if ($authtype eq '') {
                   2573:         $authtype = '<input type="radio" name="login" value="fsys" '.
                   2574:                     $fsyscheck.' onchange="'.$jscall.'" onclick="'.
                   2575:                     $jscall.'" />';
                   2576:     }
                   2577:     $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
                   2578:                ' onchange="'.$jscall.'" />';
                   2579:     $result = &mt
1.144     matthew  2580:         ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281     albertel 2581:          '<label><input type="radio" name="login" value="fsys" '.
1.586     raeburn  2582:          $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605     bisitz   2583:          '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144     matthew  2584:                   'onchange="'.$jscall.'" />');
1.32      matthew  2585:     return $result;
                   2586: }
                   2587: 
1.586     raeburn  2588: sub get_assignable_auth {
                   2589:     my ($dom) = @_;
                   2590:     if ($dom eq '') {
                   2591:         $dom = $env{'request.role.domain'};
                   2592:     }
                   2593:     my %can_assign = (
                   2594:                           krb4 => 1,
                   2595:                           krb5 => 1,
                   2596:                           int  => 1,
                   2597:                           loc  => 1,
                   2598:                      );
                   2599:     my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
                   2600:     if (ref($domconfig{'usercreation'}) eq 'HASH') {
                   2601:         if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
                   2602:             my $authhash = $domconfig{'usercreation'}{'authtypes'};
                   2603:             my $context;
                   2604:             if ($env{'request.role'} =~ /^au/) {
                   2605:                 $context = 'author';
                   2606:             } elsif ($env{'request.role'} =~ /^dc/) {
                   2607:                 $context = 'domain';
                   2608:             } elsif ($env{'request.course.id'}) {
                   2609:                 $context = 'course';
                   2610:             }
                   2611:             if ($context) {
                   2612:                 if (ref($authhash->{$context}) eq 'HASH') {
                   2613:                    %can_assign = %{$authhash->{$context}}; 
                   2614:                 }
                   2615:             }
                   2616:         }
                   2617:     }
                   2618:     my $authnum = 0;
                   2619:     foreach my $key (keys(%can_assign)) {
                   2620:         if ($can_assign{$key}) {
                   2621:             $authnum ++;
                   2622:         }
                   2623:     }
                   2624:     if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
                   2625:         $authnum --;
                   2626:     }
                   2627:     return ($authnum,%can_assign);
                   2628: }
                   2629: 
1.80      albertel 2630: ###############################################################
                   2631: ##    Get Kerberos Defaults for Domain                 ##
                   2632: ###############################################################
                   2633: ##
                   2634: ## Returns default kerberos version and an associated argument
                   2635: ## as listed in file domain.tab. If not listed, provides
                   2636: ## appropriate default domain and kerberos version.
                   2637: ##
                   2638: #-------------------------------------------
                   2639: 
                   2640: =pod
                   2641: 
1.648     raeburn  2642: =item * &get_kerberos_defaults()
1.80      albertel 2643: 
                   2644: get_kerberos_defaults($target_domain) returns the default kerberos
1.641     raeburn  2645: version and domain. If not found, it defaults to version 4 and the 
                   2646: domain of the server.
1.80      albertel 2647: 
1.648     raeburn  2648: =over 4
                   2649: 
1.80      albertel 2650: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
                   2651: 
1.648     raeburn  2652: =back
                   2653: 
                   2654: =back
                   2655: 
1.80      albertel 2656: =cut
                   2657: 
                   2658: #-------------------------------------------
                   2659: sub get_kerberos_defaults {
                   2660:     my $domain=shift;
1.641     raeburn  2661:     my ($krbdef,$krbdefdom);
                   2662:     my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
                   2663:     if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
                   2664:         $krbdef = $domdefaults{'auth_def'};
                   2665:         $krbdefdom = $domdefaults{'auth_arg_def'};
                   2666:     } else {
1.80      albertel 2667:         $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
                   2668:         my $krbdefdom=$1;
                   2669:         $krbdefdom=~tr/a-z/A-Z/;
                   2670:         $krbdef = "krb4";
                   2671:     }
                   2672:     return ($krbdef,$krbdefdom);
                   2673: }
1.112     bowersj2 2674: 
1.32      matthew  2675: 
1.46      matthew  2676: ###############################################################
                   2677: ##                Thesaurus Functions                        ##
                   2678: ###############################################################
1.20      www      2679: 
1.46      matthew  2680: =pod
1.20      www      2681: 
1.112     bowersj2 2682: =head1 Thesaurus Functions
                   2683: 
                   2684: =over 4
                   2685: 
1.648     raeburn  2686: =item * &initialize_keywords()
1.46      matthew  2687: 
                   2688: Initializes the package variable %Keywords if it is empty.  Uses the
                   2689: package variable $thesaurus_db_file.
                   2690: 
                   2691: =cut
                   2692: 
                   2693: ###################################################
                   2694: 
                   2695: sub initialize_keywords {
                   2696:     return 1 if (scalar keys(%Keywords));
                   2697:     # If we are here, %Keywords is empty, so fill it up
                   2698:     #   Make sure the file we need exists...
                   2699:     if (! -e $thesaurus_db_file) {
                   2700:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
                   2701:                                  " failed because it does not exist");
                   2702:         return 0;
                   2703:     }
                   2704:     #   Set up the hash as a database
                   2705:     my %thesaurus_db;
                   2706:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2707:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2708:         &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
                   2709:                                  $thesaurus_db_file);
                   2710:         return 0;
                   2711:     } 
                   2712:     #  Get the average number of appearances of a word.
                   2713:     my $avecount = $thesaurus_db{'average.count'};
                   2714:     #  Put keywords (those that appear > average) into %Keywords
                   2715:     while (my ($word,$data)=each (%thesaurus_db)) {
                   2716:         my ($count,undef) = split /:/,$data;
                   2717:         $Keywords{$word}++ if ($count > $avecount);
                   2718:     }
                   2719:     untie %thesaurus_db;
                   2720:     # Remove special values from %Keywords.
1.356     albertel 2721:     foreach my $value ('total.count','average.count') {
                   2722:         delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586     raeburn  2723:   }
1.46      matthew  2724:     return 1;
                   2725: }
                   2726: 
                   2727: ###################################################
                   2728: 
                   2729: =pod
                   2730: 
1.648     raeburn  2731: =item * &keyword($word)
1.46      matthew  2732: 
                   2733: Returns true if $word is a keyword.  A keyword is a word that appears more 
                   2734: than the average number of times in the thesaurus database.  Calls 
                   2735: &initialize_keywords
                   2736: 
                   2737: =cut
                   2738: 
                   2739: ###################################################
1.20      www      2740: 
                   2741: sub keyword {
1.46      matthew  2742:     return if (!&initialize_keywords());
                   2743:     my $word=lc(shift());
                   2744:     $word=~s/\W//g;
                   2745:     return exists($Keywords{$word});
1.20      www      2746: }
1.46      matthew  2747: 
                   2748: ###############################################################
                   2749: 
                   2750: =pod 
1.20      www      2751: 
1.648     raeburn  2752: =item * &get_related_words()
1.46      matthew  2753: 
1.160     matthew  2754: Look up a word in the thesaurus.  Takes a scalar argument and returns
1.46      matthew  2755: an array of words.  If the keyword is not in the thesaurus, an empty array
                   2756: will be returned.  The order of the words returned is determined by the
                   2757: database which holds them.
                   2758: 
                   2759: Uses global $thesaurus_db_file.
                   2760: 
                   2761: =cut
                   2762: 
                   2763: ###############################################################
                   2764: sub get_related_words {
                   2765:     my $keyword = shift;
                   2766:     my %thesaurus_db;
                   2767:     if (! -e $thesaurus_db_file) {
                   2768:         &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
                   2769:                                  "failed because the file does not exist");
                   2770:         return ();
                   2771:     }
                   2772:     if (! tie(%thesaurus_db,'GDBM_File',
1.53      albertel 2773:               $thesaurus_db_file,&GDBM_READER(),0640)){
1.46      matthew  2774:         return ();
                   2775:     } 
                   2776:     my @Words=();
1.429     www      2777:     my $count=0;
1.46      matthew  2778:     if (exists($thesaurus_db{$keyword})) {
1.356     albertel 2779: 	# The first element is the number of times
                   2780: 	# the word appears.  We do not need it now.
1.429     www      2781: 	my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
                   2782: 	my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
                   2783: 	my $threshold=$mostfrequentcount/10;
                   2784:         foreach my $possibleword (@RelatedWords) {
                   2785:             my ($word,$wordcount)=split(/\,/,$possibleword);
                   2786:             if ($wordcount>$threshold) {
                   2787: 		push(@Words,$word);
                   2788:                 $count++;
                   2789:                 if ($count>10) { last; }
                   2790: 	    }
1.20      www      2791:         }
                   2792:     }
1.46      matthew  2793:     untie %thesaurus_db;
                   2794:     return @Words;
1.14      harris41 2795: }
1.46      matthew  2796: 
1.112     bowersj2 2797: =pod
                   2798: 
                   2799: =back
                   2800: 
                   2801: =cut
1.61      www      2802: 
                   2803: # -------------------------------------------------------------- Plaintext name
1.81      albertel 2804: =pod
                   2805: 
1.112     bowersj2 2806: =head1 User Name Functions
                   2807: 
                   2808: =over 4
                   2809: 
1.648     raeburn  2810: =item * &plainname($uname,$udom,$first)
1.81      albertel 2811: 
1.112     bowersj2 2812: Takes a users logon name and returns it as a string in
1.226     albertel 2813: "first middle last generation" form 
                   2814: if $first is set to 'lastname' then it returns it as
                   2815: 'lastname generation, firstname middlename' if their is a lastname
1.81      albertel 2816: 
                   2817: =cut
1.61      www      2818: 
1.295     www      2819: 
1.81      albertel 2820: ###############################################################
1.61      www      2821: sub plainname {
1.226     albertel 2822:     my ($uname,$udom,$first)=@_;
1.537     albertel 2823:     return if (!defined($uname) || !defined($udom));
1.295     www      2824:     my %names=&getnames($uname,$udom);
1.226     albertel 2825:     my $name=&Apache::lonnet::format_name($names{'firstname'},
                   2826: 					  $names{'middlename'},
                   2827: 					  $names{'lastname'},
                   2828: 					  $names{'generation'},$first);
                   2829:     $name=~s/^\s+//;
1.62      www      2830:     $name=~s/\s+$//;
                   2831:     $name=~s/\s+/ /g;
1.353     albertel 2832:     if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62      www      2833:     return $name;
1.61      www      2834: }
1.66      www      2835: 
                   2836: # -------------------------------------------------------------------- Nickname
1.81      albertel 2837: =pod
                   2838: 
1.648     raeburn  2839: =item * &nickname($uname,$udom)
1.81      albertel 2840: 
                   2841: Gets a users name and returns it as a string as
                   2842: 
                   2843: "&quot;nickname&quot;"
1.66      www      2844: 
1.81      albertel 2845: if the user has a nickname or
                   2846: 
                   2847: "first middle last generation"
                   2848: 
                   2849: if the user does not
                   2850: 
                   2851: =cut
1.66      www      2852: 
                   2853: sub nickname {
                   2854:     my ($uname,$udom)=@_;
1.537     albertel 2855:     return if (!defined($uname) || !defined($udom));
1.295     www      2856:     my %names=&getnames($uname,$udom);
1.68      albertel 2857:     my $name=$names{'nickname'};
1.66      www      2858:     if ($name) {
                   2859:        $name='&quot;'.$name.'&quot;'; 
                   2860:     } else {
                   2861:        $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
                   2862: 	     $names{'lastname'}.' '.$names{'generation'};
                   2863:        $name=~s/\s+$//;
                   2864:        $name=~s/\s+/ /g;
                   2865:     }
                   2866:     return $name;
                   2867: }
                   2868: 
1.295     www      2869: sub getnames {
                   2870:     my ($uname,$udom)=@_;
1.537     albertel 2871:     return if (!defined($uname) || !defined($udom));
1.433     albertel 2872:     if ($udom eq 'public' && $uname eq 'public') {
                   2873: 	return ('lastname' => &mt('Public'));
                   2874:     }
1.295     www      2875:     my $id=$uname.':'.$udom;
                   2876:     my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
                   2877:     if ($cached) {
                   2878: 	return %{$names};
                   2879:     } else {
                   2880: 	my %loadnames=&Apache::lonnet::get('environment',
                   2881:                     ['firstname','middlename','lastname','generation','nickname'],
                   2882: 					 $udom,$uname);
                   2883: 	&Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
                   2884: 	return %loadnames;
                   2885:     }
                   2886: }
1.61      www      2887: 
1.542     raeburn  2888: # -------------------------------------------------------------------- getemails
1.648     raeburn  2889: 
1.542     raeburn  2890: =pod
                   2891: 
1.648     raeburn  2892: =item * &getemails($uname,$udom)
1.542     raeburn  2893: 
                   2894: Gets a user's email information and returns it as a hash with keys:
                   2895: notification, critnotification, permanentemail
                   2896: 
                   2897: For notification and critnotification, values are comma-separated lists 
1.648     raeburn  2898: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542     raeburn  2899:  
1.648     raeburn  2900: 
1.542     raeburn  2901: =cut
                   2902: 
1.648     raeburn  2903: 
1.466     albertel 2904: sub getemails {
                   2905:     my ($uname,$udom)=@_;
                   2906:     if ($udom eq 'public' && $uname eq 'public') {
                   2907: 	return;
                   2908:     }
1.467     www      2909:     if (!$udom) { $udom=$env{'user.domain'}; }
                   2910:     if (!$uname) { $uname=$env{'user.name'}; }
1.466     albertel 2911:     my $id=$uname.':'.$udom;
                   2912:     my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
                   2913:     if ($cached) {
                   2914: 	return %{$names};
                   2915:     } else {
                   2916: 	my %loadnames=&Apache::lonnet::get('environment',
                   2917:                     			   ['notification','critnotification',
                   2918: 					    'permanentemail'],
                   2919: 					   $udom,$uname);
                   2920: 	&Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
                   2921: 	return %loadnames;
                   2922:     }
                   2923: }
                   2924: 
1.551     albertel 2925: sub flush_email_cache {
                   2926:     my ($uname,$udom)=@_;
                   2927:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2928:     if (!$uname) { $uname=$env{'user.name'};   }
                   2929:     return if ($udom eq 'public' && $uname eq 'public');
                   2930:     my $id=$uname.':'.$udom;
                   2931:     &Apache::lonnet::devalidate_cache_new('emailscache',$id);
                   2932: }
                   2933: 
1.728     raeburn  2934: # -------------------------------------------------------------------- getlangs
                   2935: 
                   2936: =pod
                   2937: 
                   2938: =item * &getlangs($uname,$udom)
                   2939: 
                   2940: Gets a user's language preference and returns it as a hash with key:
                   2941: language.
                   2942: 
                   2943: =cut
                   2944: 
                   2945: 
                   2946: sub getlangs {
                   2947:     my ($uname,$udom) = @_;
                   2948:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2949:     if (!$uname) { $uname=$env{'user.name'};   }
                   2950:     my $id=$uname.':'.$udom;
                   2951:     my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
                   2952:     if ($cached) {
                   2953:         return %{$langs};
                   2954:     } else {
                   2955:         my %loadlangs=&Apache::lonnet::get('environment',['languages'],
                   2956:                                            $udom,$uname);
                   2957:         &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
                   2958:         return %loadlangs;
                   2959:     }
                   2960: }
                   2961: 
                   2962: sub flush_langs_cache {
                   2963:     my ($uname,$udom)=@_;
                   2964:     if (!$udom)  { $udom =$env{'user.domain'}; }
                   2965:     if (!$uname) { $uname=$env{'user.name'};   }
                   2966:     return if ($udom eq 'public' && $uname eq 'public');
                   2967:     my $id=$uname.':'.$udom;
                   2968:     &Apache::lonnet::devalidate_cache_new('userlangs',$id);
                   2969: }
                   2970: 
1.61      www      2971: # ------------------------------------------------------------------ Screenname
1.81      albertel 2972: 
                   2973: =pod
                   2974: 
1.648     raeburn  2975: =item * &screenname($uname,$udom)
1.81      albertel 2976: 
                   2977: Gets a users screenname and returns it as a string
                   2978: 
                   2979: =cut
1.61      www      2980: 
                   2981: sub screenname {
                   2982:     my ($uname,$udom)=@_;
1.258     albertel 2983:     if ($uname eq $env{'user.name'} &&
                   2984: 	$udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212     albertel 2985:     my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68      albertel 2986:     return $names{'screenname'};
1.62      www      2987: }
                   2988: 
1.212     albertel 2989: 
1.802     bisitz   2990: # ------------------------------------------------------------- Confirm Wrapper
                   2991: =pod
                   2992: 
                   2993: =item confirmwrapper
                   2994: 
                   2995: Wrap messages about completion of operation in box
                   2996: 
                   2997: =cut
                   2998: 
                   2999: sub confirmwrapper {
                   3000:     my ($message)=@_;
                   3001:     if ($message) {
                   3002:         return "\n".'<div class="LC_confirm_box">'."\n"
                   3003:                .$message."\n"
                   3004:                .'</div>'."\n";
                   3005:     } else {
                   3006:         return $message;
                   3007:     }
                   3008: }
                   3009: 
1.62      www      3010: # ------------------------------------------------------------- Message Wrapper
                   3011: 
                   3012: sub messagewrapper {
1.369     www      3013:     my ($link,$username,$domain,$subject,$text)=@_;
1.62      www      3014:     return 
1.441     albertel 3015:         '<a href="/adm/email?compose=individual&amp;'.
                   3016:         'recname='.$username.'&amp;recdom='.$domain.
                   3017: 	'&amp;subject='.&escape($subject).'&amp;text='.&escape($text).'" '.
1.200     matthew  3018:         'title="'.&mt('Send message').'">'.$link.'</a>';
1.74      www      3019: }
1.802     bisitz   3020: 
1.74      www      3021: # --------------------------------------------------------------- Notes Wrapper
                   3022: 
                   3023: sub noteswrapper {
                   3024:     my ($link,$un,$do)=@_;
                   3025:     return 
1.896     amueller 3026: "<a href='/adm/email?recordftf=retrieve&amp;recname=$un&amp;recdom=$do'>$link</a>";
1.62      www      3027: }
1.802     bisitz   3028: 
1.62      www      3029: # ------------------------------------------------------------- Aboutme Wrapper
                   3030: 
                   3031: sub aboutmewrapper {
1.166     www      3032:     my ($link,$username,$domain,$target)=@_;
1.447     raeburn  3033:     if (!defined($username)  && !defined($domain)) {
                   3034:         return;
                   3035:     }
1.892     amueller 3036:     return '<a href="/adm/'.$domain.'/'.$username.'/aboutme?forcestudent=1"'.
1.756     weissno  3037: 	($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62      www      3038: }
                   3039: 
                   3040: # ------------------------------------------------------------ Syllabus Wrapper
                   3041: 
                   3042: sub syllabuswrapper {
1.707     bisitz   3043:     my ($linktext,$coursedir,$domain)=@_;
1.208     matthew  3044:     return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61      www      3045: }
1.14      harris41 3046: 
1.802     bisitz   3047: # -----------------------------------------------------------------------------
                   3048: 
1.208     matthew  3049: sub track_student_link {
1.887     raeburn  3050:     my ($linktext,$sname,$sdom,$target,$start,$only_body) = @_;
1.268     albertel 3051:     my $link ="/adm/trackstudent?";
1.208     matthew  3052:     my $title = 'View recent activity';
                   3053:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3054:         defined($sdom)  && $sdom  !~ /^\s*$/) {
1.268     albertel 3055:         $link .= "selected_student=$sname:$sdom";
1.208     matthew  3056:         $title .= ' of this student';
1.268     albertel 3057:     } 
1.208     matthew  3058:     if (defined($target) && $target !~ /^\s*$/) {
                   3059:         $target = qq{target="$target"};
                   3060:     } else {
                   3061:         $target = '';
                   3062:     }
1.268     albertel 3063:     if ($start) { $link.='&amp;start='.$start; }
1.887     raeburn  3064:     if ($only_body) { $link .= '&amp;only_body=1'; }
1.554     albertel 3065:     $title = &mt($title);
                   3066:     $linktext = &mt($linktext);
1.448     albertel 3067:     return qq{<a href="$link" title="$title" $target>$linktext</a>}.
                   3068: 	&help_open_topic('View_recent_activity');
1.208     matthew  3069: }
                   3070: 
1.781     raeburn  3071: sub slot_reservations_link {
                   3072:     my ($linktext,$sname,$sdom,$target) = @_;
                   3073:     my $link ="/adm/slotrequest?command=showresv&amp;origin=aboutme";
                   3074:     my $title = 'View slot reservation history';
                   3075:     if (defined($sname) && $sname !~ /^\s*$/ &&
                   3076:         defined($sdom)  && $sdom  !~ /^\s*$/) {
                   3077:         $link .= "&amp;uname=$sname&amp;udom=$sdom";
                   3078:         $title .= ' of this student';
                   3079:     }
                   3080:     if (defined($target) && $target !~ /^\s*$/) {
                   3081:         $target = qq{target="$target"};
                   3082:     } else {
                   3083:         $target = '';
                   3084:     }
                   3085:     $title = &mt($title);
                   3086:     $linktext = &mt($linktext);
                   3087:     return qq{<a href="$link" title="$title" $target>$linktext</a>};
                   3088: # FIXME uncomment when help item created: &help_open_topic('Slot_Reservation_History');
                   3089: 
                   3090: }
                   3091: 
1.508     www      3092: # ===================================================== Display a student photo
                   3093: 
                   3094: 
1.509     albertel 3095: sub student_image_tag {
1.508     www      3096:     my ($domain,$user)=@_;
                   3097:     my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
                   3098:     if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
                   3099: 	return '<img src="'.$imgsrc.'" align="right" />';
                   3100:     } else {
                   3101: 	return '';
                   3102:     }
                   3103: }
                   3104: 
1.112     bowersj2 3105: =pod
                   3106: 
                   3107: =back
                   3108: 
                   3109: =head1 Access .tab File Data
                   3110: 
                   3111: =over 4
                   3112: 
1.648     raeburn  3113: =item * &languageids() 
1.112     bowersj2 3114: 
                   3115: returns list of all language ids
                   3116: 
                   3117: =cut
                   3118: 
1.14      harris41 3119: sub languageids {
1.16      harris41 3120:     return sort(keys(%language));
1.14      harris41 3121: }
                   3122: 
1.112     bowersj2 3123: =pod
                   3124: 
1.648     raeburn  3125: =item * &languagedescription() 
1.112     bowersj2 3126: 
                   3127: returns description of a specified language id
                   3128: 
                   3129: =cut
                   3130: 
1.14      harris41 3131: sub languagedescription {
1.125     www      3132:     my $code=shift;
                   3133:     return  ($supported_language{$code}?'* ':'').
                   3134:             $language{$code}.
1.126     www      3135: 	    ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145     www      3136: }
                   3137: 
                   3138: sub plainlanguagedescription {
                   3139:     my $code=shift;
                   3140:     return $language{$code};
                   3141: }
                   3142: 
                   3143: sub supportedlanguagecode {
                   3144:     my $code=shift;
                   3145:     return $supported_language{$code};
1.97      www      3146: }
                   3147: 
1.112     bowersj2 3148: =pod
                   3149: 
1.648     raeburn  3150: =item * &copyrightids() 
1.112     bowersj2 3151: 
                   3152: returns list of all copyrights
                   3153: 
                   3154: =cut
                   3155: 
                   3156: sub copyrightids {
                   3157:     return sort(keys(%cprtag));
                   3158: }
                   3159: 
                   3160: =pod
                   3161: 
1.648     raeburn  3162: =item * &copyrightdescription() 
1.112     bowersj2 3163: 
                   3164: returns description of a specified copyright id
                   3165: 
                   3166: =cut
                   3167: 
                   3168: sub copyrightdescription {
1.166     www      3169:     return &mt($cprtag{shift(@_)});
1.112     bowersj2 3170: }
1.197     matthew  3171: 
                   3172: =pod
                   3173: 
1.648     raeburn  3174: =item * &source_copyrightids() 
1.192     taceyjo1 3175: 
                   3176: returns list of all source copyrights
                   3177: 
                   3178: =cut
                   3179: 
                   3180: sub source_copyrightids {
                   3181:     return sort(keys(%scprtag));
                   3182: }
                   3183: 
                   3184: =pod
                   3185: 
1.648     raeburn  3186: =item * &source_copyrightdescription() 
1.192     taceyjo1 3187: 
                   3188: returns description of a specified source copyright id
                   3189: 
                   3190: =cut
                   3191: 
                   3192: sub source_copyrightdescription {
                   3193:     return &mt($scprtag{shift(@_)});
                   3194: }
1.112     bowersj2 3195: 
                   3196: =pod
                   3197: 
1.648     raeburn  3198: =item * &filecategories() 
1.112     bowersj2 3199: 
                   3200: returns list of all file categories
                   3201: 
                   3202: =cut
                   3203: 
                   3204: sub filecategories {
                   3205:     return sort(keys(%category_extensions));
                   3206: }
                   3207: 
                   3208: =pod
                   3209: 
1.648     raeburn  3210: =item * &filecategorytypes() 
1.112     bowersj2 3211: 
                   3212: returns list of file types belonging to a given file
                   3213: category
                   3214: 
                   3215: =cut
                   3216: 
                   3217: sub filecategorytypes {
1.356     albertel 3218:     my ($cat) = @_;
                   3219:     return @{$category_extensions{lc($cat)}};
1.112     bowersj2 3220: }
                   3221: 
                   3222: =pod
                   3223: 
1.648     raeburn  3224: =item * &fileembstyle() 
1.112     bowersj2 3225: 
                   3226: returns embedding style for a specified file type
                   3227: 
                   3228: =cut
                   3229: 
                   3230: sub fileembstyle {
                   3231:     return $fe{lc(shift(@_))};
1.169     www      3232: }
                   3233: 
1.351     www      3234: sub filemimetype {
                   3235:     return $fm{lc(shift(@_))};
                   3236: }
                   3237: 
1.169     www      3238: 
                   3239: sub filecategoryselect {
                   3240:     my ($name,$value)=@_;
1.189     matthew  3241:     return &select_form($value,$name,
1.169     www      3242: 			'' => &mt('Any category'),
                   3243: 			map { $_,$_ } sort(keys(%category_extensions)));
1.112     bowersj2 3244: }
                   3245: 
                   3246: =pod
                   3247: 
1.648     raeburn  3248: =item * &filedescription() 
1.112     bowersj2 3249: 
                   3250: returns description for a specified file type
                   3251: 
                   3252: =cut
                   3253: 
                   3254: sub filedescription {
1.188     matthew  3255:     my $file_description = $fd{lc(shift())};
                   3256:     $file_description =~ s:([\[\]]):~$1:g;
                   3257:     return &mt($file_description);
1.112     bowersj2 3258: }
                   3259: 
                   3260: =pod
                   3261: 
1.648     raeburn  3262: =item * &filedescriptionex() 
1.112     bowersj2 3263: 
                   3264: returns description for a specified file type with
                   3265: extra formatting
                   3266: 
                   3267: =cut
                   3268: 
                   3269: sub filedescriptionex {
                   3270:     my $ex=shift;
1.188     matthew  3271:     my $file_description = $fd{lc($ex)};
                   3272:     $file_description =~ s:([\[\]]):~$1:g;
                   3273:     return '.'.$ex.' '.&mt($file_description);
1.112     bowersj2 3274: }
                   3275: 
                   3276: # End of .tab access
                   3277: =pod
                   3278: 
                   3279: =back
                   3280: 
                   3281: =cut
                   3282: 
                   3283: # ------------------------------------------------------------------ File Types
                   3284: sub fileextensions {
                   3285:     return sort(keys(%fe));
                   3286: }
                   3287: 
1.97      www      3288: # ----------------------------------------------------------- Display Languages
                   3289: # returns a hash with all desired display languages
                   3290: #
                   3291: 
                   3292: sub display_languages {
                   3293:     my %languages=();
1.695     raeburn  3294:     foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356     albertel 3295: 	$languages{$lang}=1;
1.97      www      3296:     }
                   3297:     &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258     albertel 3298:     if ($env{'form.displaylanguage'}) {
1.356     albertel 3299: 	foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
                   3300: 	    $languages{$lang}=1;
1.97      www      3301:         }
                   3302:     }
                   3303:     return %languages;
1.14      harris41 3304: }
                   3305: 
1.582     albertel 3306: sub languages {
                   3307:     my ($possible_langs) = @_;
1.695     raeburn  3308:     my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582     albertel 3309:     if (!ref($possible_langs)) {
                   3310: 	if( wantarray ) {
                   3311: 	    return @preferred_langs;
                   3312: 	} else {
                   3313: 	    return $preferred_langs[0];
                   3314: 	}
                   3315:     }
                   3316:     my %possibilities = map { $_ => 1 } (@$possible_langs);
                   3317:     my @preferred_possibilities;
                   3318:     foreach my $preferred_lang (@preferred_langs) {
                   3319: 	if (exists($possibilities{$preferred_lang})) {
                   3320: 	    push(@preferred_possibilities, $preferred_lang);
                   3321: 	}
                   3322:     }
                   3323:     if( wantarray ) {
                   3324: 	return @preferred_possibilities;
                   3325:     }
                   3326:     return $preferred_possibilities[0];
                   3327: }
                   3328: 
1.742     raeburn  3329: sub user_lang {
                   3330:     my ($touname,$toudom,$fromcid) = @_;
                   3331:     my @userlangs;
                   3332:     if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
                   3333:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                   3334:                     $env{'course.'.$fromcid.'.languages'}));
                   3335:     } else {
                   3336:         my %langhash = &getlangs($touname,$toudom);
                   3337:         if ($langhash{'languages'} ne '') {
                   3338:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                   3339:         } else {
                   3340:             my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
                   3341:             if ($domdefs{'lang_def'} ne '') {
                   3342:                 @userlangs = ($domdefs{'lang_def'});
                   3343:             }
                   3344:         }
                   3345:     }
                   3346:     my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
                   3347:     my $user_lh = Apache::localize->get_handle(@languages);
                   3348:     return $user_lh;
                   3349: }
                   3350: 
                   3351: 
1.112     bowersj2 3352: ###############################################################
                   3353: ##               Student Answer Attempts                     ##
                   3354: ###############################################################
                   3355: 
                   3356: =pod
                   3357: 
                   3358: =head1 Alternate Problem Views
                   3359: 
                   3360: =over 4
                   3361: 
1.648     raeburn  3362: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112     bowersj2 3363:     $getattempt, $regexp, $gradesub)
                   3364: 
                   3365: Return string with previous attempt on problem. Arguments:
                   3366: 
                   3367: =over 4
                   3368: 
                   3369: =item * $symb: Problem, including path
                   3370: 
                   3371: =item * $username: username of the desired student
                   3372: 
                   3373: =item * $domain: domain of the desired student
1.14      harris41 3374: 
1.112     bowersj2 3375: =item * $course: Course ID
1.14      harris41 3376: 
1.112     bowersj2 3377: =item * $getattempt: Leave blank for all attempts, otherwise put
                   3378:     something
1.14      harris41 3379: 
1.112     bowersj2 3380: =item * $regexp: if string matches this regexp, the string will be
                   3381:     sent to $gradesub
1.14      harris41 3382: 
1.112     bowersj2 3383: =item * $gradesub: routine that processes the string if it matches $regexp
1.14      harris41 3384: 
1.112     bowersj2 3385: =back
1.14      harris41 3386: 
1.112     bowersj2 3387: The output string is a table containing all desired attempts, if any.
1.16      harris41 3388: 
1.112     bowersj2 3389: =cut
1.1       albertel 3390: 
                   3391: sub get_previous_attempt {
1.43      ng       3392:   my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1       albertel 3393:   my $prevattempts='';
1.43      ng       3394:   no strict 'refs';
1.1       albertel 3395:   if ($symb) {
1.3       albertel 3396:     my (%returnhash)=
                   3397:       &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1       albertel 3398:     if ($returnhash{'version'}) {
                   3399:       my %lasthash=();
                   3400:       my $version;
                   3401:       for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356     albertel 3402:         foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
                   3403: 	  $lasthash{$key}=$returnhash{$version.':'.$key};
1.19      harris41 3404:         }
1.1       albertel 3405:       }
1.596     albertel 3406:       $prevattempts=&start_data_table().&start_data_table_header_row();
                   3407:       $prevattempts.='<th>'.&mt('History').'</th>';
1.356     albertel 3408:       foreach my $key (sort(keys(%lasthash))) {
                   3409: 	my ($ign,@parts) = split(/\./,$key);
1.41      ng       3410: 	if ($#parts > 0) {
1.31      albertel 3411: 	  my $data=$parts[-1];
                   3412: 	  pop(@parts);
1.596     albertel 3413: 	  $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.'&nbsp;</th>';
1.31      albertel 3414: 	} else {
1.41      ng       3415: 	  if ($#parts == 0) {
                   3416: 	    $prevattempts.='<th>'.$parts[0].'</th>';
                   3417: 	  } else {
                   3418: 	    $prevattempts.='<th>'.$ign.'</th>';
                   3419: 	  }
1.31      albertel 3420: 	}
1.16      harris41 3421:       }
1.596     albertel 3422:       $prevattempts.=&end_data_table_header_row();
1.40      ng       3423:       if ($getattempt eq '') {
                   3424: 	for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596     albertel 3425: 	  $prevattempts.=&start_data_table_row().
                   3426: 	      '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356     albertel 3427: 	    foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3428: 		my $value = &format_previous_attempt_value($key,
                   3429: 							   $returnhash{$version.':'.$key});
                   3430: 		$prevattempts.='<td>'.$value.'&nbsp;</td>';   
1.40      ng       3431: 	    }
1.596     albertel 3432: 	  $prevattempts.=&end_data_table_row();
1.40      ng       3433: 	 }
1.1       albertel 3434:       }
1.596     albertel 3435:       $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356     albertel 3436:       foreach my $key (sort(keys(%lasthash))) {
1.581     albertel 3437: 	my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356     albertel 3438: 	if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40      ng       3439: 	$prevattempts.='<td>'.$value.'&nbsp;</td>';
1.16      harris41 3440:       }
1.596     albertel 3441:       $prevattempts.= &end_data_table_row().&end_data_table();
1.1       albertel 3442:     } else {
1.596     albertel 3443:       $prevattempts=
                   3444: 	  &start_data_table().&start_data_table_row().
                   3445: 	  '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
                   3446: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3447:     }
                   3448:   } else {
1.596     albertel 3449:     $prevattempts=
                   3450: 	  &start_data_table().&start_data_table_row().
                   3451: 	  '<td>'.&mt('No data.').'</td>'.
                   3452: 	  &end_data_table_row().&end_data_table();
1.1       albertel 3453:   }
1.10      albertel 3454: }
                   3455: 
1.581     albertel 3456: sub format_previous_attempt_value {
                   3457:     my ($key,$value) = @_;
                   3458:     if ($key =~ /timestamp/) {
                   3459: 	$value = &Apache::lonlocal::locallocaltime($value);
                   3460:     } elsif (ref($value) eq 'ARRAY') {
                   3461: 	$value = '('.join(', ', @{ $value }).')';
                   3462:     } else {
                   3463: 	$value = &unescape($value);
                   3464:     }
                   3465:     return $value;
                   3466: }
                   3467: 
                   3468: 
1.107     albertel 3469: sub relative_to_absolute {
                   3470:     my ($url,$output)=@_;
                   3471:     my $parser=HTML::TokeParser->new(\$output);
                   3472:     my $token;
                   3473:     my $thisdir=$url;
                   3474:     my @rlinks=();
                   3475:     while ($token=$parser->get_token) {
                   3476: 	if ($token->[0] eq 'S') {
                   3477: 	    if ($token->[1] eq 'a') {
                   3478: 		if ($token->[2]->{'href'}) {
                   3479: 		    $rlinks[$#rlinks+1]=$token->[2]->{'href'};
                   3480: 		}
                   3481: 	    } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
                   3482: 		$rlinks[$#rlinks+1]=$token->[2]->{'src'};
                   3483: 	    } elsif ($token->[1] eq 'base') {
                   3484: 		$thisdir=$token->[2]->{'href'};
                   3485: 	    }
                   3486: 	}
                   3487:     }
                   3488:     $thisdir=~s-/[^/]*$--;
1.356     albertel 3489:     foreach my $link (@rlinks) {
1.726     raeburn  3490: 	unless (($link=~/^https?\:\/\//i) ||
1.356     albertel 3491: 		($link=~/^\//) ||
                   3492: 		($link=~/^javascript:/i) ||
                   3493: 		($link=~/^mailto:/i) ||
                   3494: 		($link=~/^\#/)) {
                   3495: 	    my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
                   3496: 	    $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107     albertel 3497: 	}
                   3498:     }
                   3499: # -------------------------------------------------- Deal with Applet codebases
                   3500:     $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
                   3501:     return $output;
                   3502: }
                   3503: 
1.112     bowersj2 3504: =pod
                   3505: 
1.648     raeburn  3506: =item * &get_student_view()
1.112     bowersj2 3507: 
                   3508: show a snapshot of what student was looking at
                   3509: 
                   3510: =cut
                   3511: 
1.10      albertel 3512: sub get_student_view {
1.186     albertel 3513:   my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114     www      3514:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3515:   my (%form);
1.10      albertel 3516:   my @elements=('symb','courseid','domain','username');
                   3517:   foreach my $element (@elements) {
1.186     albertel 3518:       $form{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3519:   }
1.186     albertel 3520:   if (defined($moreenv)) {
                   3521:       %form=(%form,%{$moreenv});
                   3522:   }
1.236     albertel 3523:   if (defined($target)) { $form{'grade_target'} = $target; }
1.107     albertel 3524:   $feedurl=&Apache::lonnet::clutter($feedurl);
1.650     www      3525:   my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11      albertel 3526:   $userview=~s/\<body[^\>]*\>//gi;
                   3527:   $userview=~s/\<\/body\>//gi;
                   3528:   $userview=~s/\<html\>//gi;
                   3529:   $userview=~s/\<\/html\>//gi;
                   3530:   $userview=~s/\<head\>//gi;
                   3531:   $userview=~s/\<\/head\>//gi;
                   3532:   $userview=~s/action\s*\=/would_be_action\=/gi;
1.107     albertel 3533:   $userview=&relative_to_absolute($feedurl,$userview);
1.650     www      3534:   if (wantarray) {
                   3535:      return ($userview,$response);
                   3536:   } else {
                   3537:      return $userview;
                   3538:   }
                   3539: }
                   3540: 
                   3541: sub get_student_view_with_retries {
                   3542:   my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
                   3543: 
                   3544:     my $ok = 0;                 # True if we got a good response.
                   3545:     my $content;
                   3546:     my $response;
                   3547: 
                   3548:     # Try to get the student_view done. within the retries count:
                   3549:     
                   3550:     do {
                   3551:          ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
                   3552:          $ok      = $response->is_success;
                   3553:          if (!$ok) {
                   3554:             &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
                   3555:          }
                   3556:          $retries--;
                   3557:     } while (!$ok && ($retries > 0));
                   3558:     
                   3559:     if (!$ok) {
                   3560:        $content = '';          # On error return an empty content.
                   3561:     }
1.651     www      3562:     if (wantarray) {
                   3563:        return ($content, $response);
                   3564:     } else {
                   3565:        return $content;
                   3566:     }
1.11      albertel 3567: }
                   3568: 
1.112     bowersj2 3569: =pod
                   3570: 
1.648     raeburn  3571: =item * &get_student_answers() 
1.112     bowersj2 3572: 
                   3573: show a snapshot of how student was answering problem
                   3574: 
                   3575: =cut
                   3576: 
1.11      albertel 3577: sub get_student_answers {
1.100     sakharuk 3578:   my ($symb,$username,$domain,$courseid,%form) = @_;
1.114     www      3579:   my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186     albertel 3580:   my (%moreenv);
1.11      albertel 3581:   my @elements=('symb','courseid','domain','username');
                   3582:   foreach my $element (@elements) {
1.186     albertel 3583:     $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10      albertel 3584:   }
1.186     albertel 3585:   $moreenv{'grade_target'}='answer';
                   3586:   %moreenv=(%form,%moreenv);
1.497     raeburn  3587:   $feedurl = &Apache::lonnet::clutter($feedurl);
                   3588:   my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10      albertel 3589:   return $userview;
1.1       albertel 3590: }
1.116     albertel 3591: 
                   3592: =pod
                   3593: 
                   3594: =item * &submlink()
                   3595: 
1.242     albertel 3596: Inputs: $text $uname $udom $symb $target
1.116     albertel 3597: 
                   3598: Returns: A link to grades.pm such as to see the SUBM view of a student
                   3599: 
                   3600: =cut
                   3601: 
                   3602: ###############################################
                   3603: sub submlink {
1.242     albertel 3604:     my ($text,$uname,$udom,$symb,$target)=@_;
1.116     albertel 3605:     if (!($uname && $udom)) {
                   3606: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3607: 	    &Apache::lonnet::whichuser($symb);
1.116     albertel 3608: 	if (!$symb) { $symb=$cursymb; }
                   3609:     }
1.254     matthew  3610:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3611:     $symb=&escape($symb);
1.242     albertel 3612:     if ($target) { $target="target=\"$target\""; }
                   3613:     return '<a href="/adm/grades?&command=submission&'.
                   3614: 	'symb='.$symb.'&student='.$uname.
                   3615: 	'&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
                   3616: }
                   3617: ##############################################
                   3618: 
                   3619: =pod
                   3620: 
                   3621: =item * &pgrdlink()
                   3622: 
                   3623: Inputs: $text $uname $udom $symb $target
                   3624: 
                   3625: Returns: A link to grades.pm such as to see the PGRD view of a student
                   3626: 
                   3627: =cut
                   3628: 
                   3629: ###############################################
                   3630: sub pgrdlink {
                   3631:     my $link=&submlink(@_);
                   3632:     $link=~s/(&command=submission)/$1&showgrading=yes/;
                   3633:     return $link;
                   3634: }
                   3635: ##############################################
                   3636: 
                   3637: =pod
                   3638: 
                   3639: =item * &pprmlink()
                   3640: 
                   3641: Inputs: $text $uname $udom $symb $target
                   3642: 
                   3643: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283     albertel 3644: student and a specific resource
1.242     albertel 3645: 
                   3646: =cut
                   3647: 
                   3648: ###############################################
                   3649: sub pprmlink {
                   3650:     my ($text,$uname,$udom,$symb,$target)=@_;
                   3651:     if (!($uname && $udom)) {
                   3652: 	(my $cursymb, my $courseid,$udom,$uname)=
1.463     albertel 3653: 	    &Apache::lonnet::whichuser($symb);
1.242     albertel 3654: 	if (!$symb) { $symb=$cursymb; }
                   3655:     }
1.254     matthew  3656:     if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369     www      3657:     $symb=&escape($symb);
1.242     albertel 3658:     if ($target) { $target="target=\"$target\""; }
1.595     albertel 3659:     return '<a href="/adm/parmset?command=set&amp;'.
                   3660: 	'symb='.$symb.'&amp;uname='.$uname.
                   3661: 	'&amp;udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116     albertel 3662: }
                   3663: ##############################################
1.37      matthew  3664: 
1.112     bowersj2 3665: =pod
                   3666: 
                   3667: =back
                   3668: 
                   3669: =cut
                   3670: 
1.37      matthew  3671: ###############################################
1.51      www      3672: 
                   3673: 
                   3674: sub timehash {
1.687     raeburn  3675:     my ($thistime) = @_;
                   3676:     my $timezone = &Apache::lonlocal::gettimezone();
                   3677:     my $dt = DateTime->from_epoch(epoch => $thistime)
                   3678:                      ->set_time_zone($timezone);
                   3679:     my $wday = $dt->day_of_week();
                   3680:     if ($wday == 7) { $wday = 0; }
                   3681:     return ( 'second' => $dt->second(),
                   3682:              'minute' => $dt->minute(),
                   3683:              'hour'   => $dt->hour(),
                   3684:              'day'     => $dt->day_of_month(),
                   3685:              'month'   => $dt->month(),
                   3686:              'year'    => $dt->year(),
                   3687:              'weekday' => $wday,
                   3688:              'dayyear' => $dt->day_of_year(),
                   3689:              'dlsav'   => $dt->is_dst() );
1.51      www      3690: }
                   3691: 
1.370     www      3692: sub utc_string {
                   3693:     my ($date)=@_;
1.371     www      3694:     return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370     www      3695: }
                   3696: 
1.51      www      3697: sub maketime {
                   3698:     my %th=@_;
1.687     raeburn  3699:     my ($epoch_time,$timezone,$dt);
                   3700:     $timezone = &Apache::lonlocal::gettimezone();
                   3701:     eval {
                   3702:         $dt = DateTime->new( year   => $th{'year'},
                   3703:                              month  => $th{'month'},
                   3704:                              day    => $th{'day'},
                   3705:                              hour   => $th{'hour'},
                   3706:                              minute => $th{'minute'},
                   3707:                              second => $th{'second'},
                   3708:                              time_zone => $timezone,
                   3709:                          );
                   3710:     };
                   3711:     if (!$@) {
                   3712:         $epoch_time = $dt->epoch;
                   3713:         if ($epoch_time) {
                   3714:             return $epoch_time;
                   3715:         }
                   3716:     }
1.51      www      3717:     return POSIX::mktime(
                   3718:         ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210     www      3719:          $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70      www      3720: }
                   3721: 
                   3722: #########################################
1.51      www      3723: 
                   3724: sub findallcourses {
1.482     raeburn  3725:     my ($roles,$uname,$udom) = @_;
1.355     albertel 3726:     my %roles;
                   3727:     if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348     albertel 3728:     my %courses;
1.51      www      3729:     my $now=time;
1.482     raeburn  3730:     if (!defined($uname)) {
                   3731:         $uname = $env{'user.name'};
                   3732:     }
                   3733:     if (!defined($udom)) {
                   3734:         $udom = $env{'user.domain'};
                   3735:     }
                   3736:     if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
                   3737:         my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
                   3738:         if (!%roles) {
                   3739:             %roles = (
                   3740:                        cc => 1,
1.907     raeburn  3741:                        co => 1,
1.482     raeburn  3742:                        in => 1,
                   3743:                        ep => 1,
                   3744:                        ta => 1,
                   3745:                        cr => 1,
                   3746:                        st => 1,
                   3747:              );
                   3748:         }
                   3749:         foreach my $entry (keys(%roleshash)) {
                   3750:             my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
                   3751:             if ($trole =~ /^cr/) { 
                   3752:                 next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
                   3753:             } else {
                   3754:                 next if (!exists($roles{$trole}));
                   3755:             }
                   3756:             if ($tend) {
                   3757:                 next if ($tend < $now);
                   3758:             }
                   3759:             if ($tstart) {
                   3760:                 next if ($tstart > $now);
                   3761:             }
                   3762:             my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
                   3763:             (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
                   3764:             if ($secpart eq '') {
                   3765:                 ($cnum,$role) = split(/_/,$cnumpart); 
                   3766:                 $sec = 'none';
                   3767:                 $realsec = '';
                   3768:             } else {
                   3769:                 $cnum = $cnumpart;
                   3770:                 ($sec,$role) = split(/_/,$secpart);
                   3771:                 $realsec = $sec;
1.490     raeburn  3772:             }
1.482     raeburn  3773:             $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
                   3774:         }
                   3775:     } else {
                   3776:         foreach my $key (keys(%env)) {
1.483     albertel 3777: 	    if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
                   3778:                  $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482     raeburn  3779: 	        my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
                   3780: 	        next if ($role eq 'ca' || $role eq 'aa');
                   3781: 	        next if (%roles && !exists($roles{$role}));
                   3782: 	        my ($starttime,$endtime)=split(/\./,$env{$key});
                   3783:                 my $active=1;
                   3784:                 if ($starttime) {
                   3785: 		    if ($now<$starttime) { $active=0; }
                   3786:                 }
                   3787:                 if ($endtime) {
                   3788:                     if ($now>$endtime) { $active=0; }
                   3789:                 }
                   3790:                 if ($active) {
                   3791:                     if ($sec eq '') {
                   3792:                         $sec = 'none';
                   3793:                     }
                   3794:                     $courses{$cdom.'_'.$cnum}{$sec} = 
                   3795:                                      $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474     raeburn  3796:                 }
                   3797:             }
1.51      www      3798:         }
                   3799:     }
1.474     raeburn  3800:     return %courses;
1.51      www      3801: }
1.37      matthew  3802: 
1.54      www      3803: ###############################################
1.474     raeburn  3804: 
                   3805: sub blockcheck {
1.482     raeburn  3806:     my ($setters,$activity,$uname,$udom) = @_;
1.490     raeburn  3807: 
                   3808:     if (!defined($udom)) {
                   3809:         $udom = $env{'user.domain'};
                   3810:     }
                   3811:     if (!defined($uname)) {
                   3812:         $uname = $env{'user.name'};
                   3813:     }
                   3814: 
                   3815:     # If uname and udom are for a course, check for blocks in the course.
                   3816: 
                   3817:     if (&Apache::lonnet::is_course($udom,$uname)) {
                   3818:         my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502     raeburn  3819:         my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490     raeburn  3820:         return ($startblock,$endblock);
                   3821:     }
1.474     raeburn  3822: 
1.502     raeburn  3823:     my $startblock = 0;
                   3824:     my $endblock = 0;
1.482     raeburn  3825:     my %live_courses = &findallcourses(undef,$uname,$udom);
1.474     raeburn  3826: 
1.490     raeburn  3827:     # If uname is for a user, and activity is course-specific, i.e.,
                   3828:     # boards, chat or groups, check for blocking in current course only.
1.474     raeburn  3829: 
1.490     raeburn  3830:     if (($activity eq 'boards' || $activity eq 'chat' ||
                   3831:          $activity eq 'groups') && ($env{'request.course.id'})) {
                   3832:         foreach my $key (keys(%live_courses)) {
                   3833:             if ($key ne $env{'request.course.id'}) {
                   3834:                 delete($live_courses{$key});
                   3835:             }
                   3836:         }
                   3837:     }
                   3838: 
                   3839:     my $otheruser = 0;
                   3840:     my %own_courses;
                   3841:     if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
                   3842:         # Resource belongs to user other than current user.
                   3843:         $otheruser = 1;
                   3844:         # Gather courses for current user
                   3845:         %own_courses = 
                   3846:             &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
                   3847:     }
                   3848: 
                   3849:     # Gather active course roles - course coordinator, instructor, 
                   3850:     # exam proctor, ta, student, or custom role.
1.474     raeburn  3851: 
                   3852:     foreach my $course (keys(%live_courses)) {
1.482     raeburn  3853:         my ($cdom,$cnum);
                   3854:         if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
                   3855:             $cdom = $env{'course.'.$course.'.domain'};
                   3856:             $cnum = $env{'course.'.$course.'.num'};
                   3857:         } else {
1.490     raeburn  3858:             ($cdom,$cnum) = split(/_/,$course); 
1.482     raeburn  3859:         }
                   3860:         my $no_ownblock = 0;
                   3861:         my $no_userblock = 0;
1.533     raeburn  3862:         if ($otheruser && $activity ne 'com') {
1.490     raeburn  3863:             # Check if current user has 'evb' priv for this
                   3864:             if (defined($own_courses{$course})) {
                   3865:                 foreach my $sec (keys(%{$own_courses{$course}})) {
                   3866:                     my $checkrole = 'cm./'.$cdom.'/'.$cnum;
                   3867:                     if ($sec ne 'none') {
                   3868:                         $checkrole .= '/'.$sec;
                   3869:                     }
                   3870:                     if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3871:                         $no_ownblock = 1;
                   3872:                         last;
                   3873:                     }
                   3874:                 }
                   3875:             }
                   3876:             # if they have 'evb' priv and are currently not playing student
                   3877:             next if (($no_ownblock) &&
                   3878:                  ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
                   3879:         }
1.474     raeburn  3880:         foreach my $sec (keys(%{$live_courses{$course}})) {
1.482     raeburn  3881:             my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474     raeburn  3882:             if ($sec ne 'none') {
1.482     raeburn  3883:                 $checkrole .= '/'.$sec;
1.474     raeburn  3884:             }
1.490     raeburn  3885:             if ($otheruser) {
                   3886:                 # Resource belongs to user other than current user.
                   3887:                 # Assemble privs for that user, and check for 'evb' priv.
1.482     raeburn  3888:                 my ($trole,$tdom,$tnum,$tsec);
                   3889:                 my $entry = $live_courses{$course}{$sec};
                   3890:                 if ($entry =~ /^cr/) {
                   3891:                     ($trole,$tdom,$tnum,$tsec) = 
                   3892:                       ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
                   3893:                 } else {
                   3894:                     ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
                   3895:                 }
                   3896:                 my ($spec,$area,$trest,%allroles,%userroles);
                   3897:                 $area = '/'.$tdom.'/'.$tnum;
                   3898:                 $trest = $tnum;
                   3899:                 if ($tsec ne '') {
                   3900:                     $area .= '/'.$tsec;
                   3901:                     $trest .= '/'.$tsec;
                   3902:                 }
                   3903:                 $spec = $trole.'.'.$area;
                   3904:                 if ($trole =~ /^cr/) {
                   3905:                     &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
                   3906:                                                       $tdom,$spec,$trest,$area);
                   3907:                 } else {
                   3908:                     &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
                   3909:                                                        $tdom,$spec,$trest,$area);
                   3910:                 }
                   3911:                 my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486     raeburn  3912:                 if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
                   3913:                     if ($1) {
                   3914:                         $no_userblock = 1;
                   3915:                         last;
                   3916:                     }
                   3917:                 }
1.490     raeburn  3918:             } else {
                   3919:                 # Resource belongs to current user
                   3920:                 # Check for 'evb' priv via lonnet::allowed().
1.482     raeburn  3921:                 if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
                   3922:                     $no_ownblock = 1;
                   3923:                     last;
                   3924:                 }
1.474     raeburn  3925:             }
                   3926:         }
                   3927:         # if they have the evb priv and are currently not playing student
1.482     raeburn  3928:         next if (($no_ownblock) &&
1.491     albertel 3929:                  ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482     raeburn  3930:         next if ($no_userblock);
1.474     raeburn  3931: 
1.866     kalberla 3932:         # Retrieve blocking times and identity of locker for course
1.490     raeburn  3933:         # of specified user, unless user has 'evb' privilege.
1.502     raeburn  3934:         
                   3935:         my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
                   3936:         if (($start != 0) && 
                   3937:             (($startblock == 0) || ($startblock > $start))) {
                   3938:             $startblock = $start;
                   3939:         }
                   3940:         if (($end != 0)  &&
                   3941:             (($endblock == 0) || ($endblock < $end))) {
                   3942:             $endblock = $end;
                   3943:         }
1.490     raeburn  3944:     }
                   3945:     return ($startblock,$endblock);
                   3946: }
                   3947: 
                   3948: sub get_blocks {
                   3949:     my ($setters,$activity,$cdom,$cnum) = @_;
                   3950:     my $startblock = 0;
                   3951:     my $endblock = 0;
                   3952:     my $course = $cdom.'_'.$cnum;
                   3953:     $setters->{$course} = {};
                   3954:     $setters->{$course}{'staff'} = [];
                   3955:     $setters->{$course}{'times'} = [];
                   3956:     my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
                   3957:     foreach my $record (keys(%records)) {
                   3958:         my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
                   3959:         if ($start <= time && $end >= time) {
                   3960:             my ($staff_name,$staff_dom,$title,$blocks) =
                   3961:                 &parse_block_record($records{$record});
                   3962:             if ($blocks->{$activity} eq 'on') {
                   3963:                 push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
                   3964:                 push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491     albertel 3965:                 if ( ($startblock == 0) || ($startblock > $start) ) {
                   3966:                     $startblock = $start;
1.490     raeburn  3967:                 }
1.491     albertel 3968:                 if ( ($endblock == 0) || ($endblock < $end) ) {
                   3969:                     $endblock = $end;
1.474     raeburn  3970:                 }
                   3971:             }
                   3972:         }
                   3973:     }
                   3974:     return ($startblock,$endblock);
                   3975: }
                   3976: 
                   3977: sub parse_block_record {
                   3978:     my ($record) = @_;
                   3979:     my ($setuname,$setudom,$title,$blocks);
                   3980:     if (ref($record) eq 'HASH') {
                   3981:         ($setuname,$setudom) = split(/:/,$record->{'setter'});
                   3982:         $title = &unescape($record->{'event'});
                   3983:         $blocks = $record->{'blocks'};
                   3984:     } else {
                   3985:         my @data = split(/:/,$record,3);
                   3986:         if (scalar(@data) eq 2) {
                   3987:             $title = $data[1];
                   3988:             ($setuname,$setudom) = split(/@/,$data[0]);
                   3989:         } else {
                   3990:             ($setuname,$setudom,$title) = @data;
                   3991:         }
                   3992:         $blocks = { 'com' => 'on' };
                   3993:     }
                   3994:     return ($setuname,$setudom,$title,$blocks);
                   3995: }
                   3996: 
1.854     kalberla 3997: sub blocking_status {
                   3998:   my ($activity,$uname,$udom) = @_;
1.867     kalberla 3999:   my %setters;
1.890     droeschl 4000: 
                   4001:   # check for active blocking
1.867     kalberla 4002:   my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
1.854     kalberla 4003: 
1.890     droeschl 4004:   my $blocked = $startblock && $endblock ? 1 : 0;
                   4005: 
                   4006:   # caller just wants to know whether a block is active
                   4007:   if (!wantarray) { return $blocked; }
                   4008: 
                   4009:   # build a link to a popup window containing the details
                   4010:   my $querystring  = "?activity=$activity";
                   4011:   # $uname and $udom decide whose portfolio the user is trying to look at
                   4012:      $querystring .= "&amp;udom=$udom"      if $udom;
                   4013:      $querystring .= "&amp;uname=$uname"    if $uname;
                   4014: 
                   4015:   my $output .= <<'END_MYBLOCK';
1.854     kalberla 4016:     function openWindow(url, wdwName, w, h, toolbar,scrollbar) {
                   4017:         var options = "width=" + w + ",height=" + h + ",";
                   4018:         options += "resizable=yes,scrollbars="+scrollbar+",status=no,";
                   4019:         options += "menubar=no,toolbar="+toolbar+",location=no,directories=no";
                   4020:         var newWin = window.open(url, wdwName, options);
                   4021:         newWin.focus();
                   4022:     }
1.890     droeschl 4023: END_MYBLOCK
1.854     kalberla 4024: 
1.890     droeschl 4025:   $output = Apache::lonhtmlcommon::scripttag($output);
                   4026:   
1.854     kalberla 4027:   my $popupUrl = "/adm/blockingstatus/$querystring";
1.890     droeschl 4028:   my $text = mt('Communication Blocked');
                   4029: 
1.867     kalberla 4030:   $output .= <<"END_BLOCK";
                   4031: <div class='LC_comblock'>
1.869     kalberla 4032:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring'
1.890     droeschl 4033:   title='$text'>
                   4034:   <img class='LC_noBorder LC_middle' title='$text' src='/res/adm/pages/comblock.png' alt='$text'/></a>
1.869     kalberla 4035:   <a onclick='openWindow("$popupUrl","Blocking Table",600,300,"no","no");return false;' href='/adm/blockingstatus/$querystring' 
1.890     droeschl 4036:   title='$text'>$text</a>
1.867     kalberla 4037: </div>
                   4038: 
                   4039: END_BLOCK
1.474     raeburn  4040: 
1.854     kalberla 4041:   return ($blocked, $output);
                   4042: }
1.490     raeburn  4043: 
1.60      matthew  4044: ###############################################
                   4045: 
1.682     raeburn  4046: sub check_ip_acc {
                   4047:     my ($acc)=@_;
                   4048:     &Apache::lonxml::debug("acc is $acc");
                   4049:     if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
                   4050:         return 1;
                   4051:     }
                   4052:     my $allowed=0;
                   4053:     my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
                   4054: 
                   4055:     my $name;
                   4056:     foreach my $pattern (split(',',$acc)) {
                   4057:         $pattern =~ s/^\s*//;
                   4058:         $pattern =~ s/\s*$//;
                   4059:         if ($pattern =~ /\*$/) {
                   4060:             #35.8.*
                   4061:             $pattern=~s/\*//;
                   4062:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4063:         } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
                   4064:             #35.8.3.[34-56]
                   4065:             my $low=$2;
                   4066:             my $high=$3;
                   4067:             $pattern=$1;
                   4068:             if ($ip =~ /^\Q$pattern\E/) {
                   4069:                 my $last=(split(/\./,$ip))[3];
                   4070:                 if ($last <=$high && $last >=$low) { $allowed=1; }
                   4071:             }
                   4072:         } elsif ($pattern =~ /^\*/) {
                   4073:             #*.msu.edu
                   4074:             $pattern=~s/\*//;
                   4075:             if (!defined($name)) {
                   4076:                 use Socket;
                   4077:                 my $netaddr=inet_aton($ip);
                   4078:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4079:             }
                   4080:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4081:         } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
                   4082:             #127.0.0.1
                   4083:             if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
                   4084:         } else {
                   4085:             #some.name.com
                   4086:             if (!defined($name)) {
                   4087:                 use Socket;
                   4088:                 my $netaddr=inet_aton($ip);
                   4089:                 ($name)=gethostbyaddr($netaddr,AF_INET);
                   4090:             }
                   4091:             if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
                   4092:         }
                   4093:         if ($allowed) { last; }
                   4094:     }
                   4095:     return $allowed;
                   4096: }
                   4097: 
                   4098: ###############################################
                   4099: 
1.60      matthew  4100: =pod
                   4101: 
1.112     bowersj2 4102: =head1 Domain Template Functions
                   4103: 
                   4104: =over 4
                   4105: 
                   4106: =item * &determinedomain()
1.60      matthew  4107: 
                   4108: Inputs: $domain (usually will be undef)
                   4109: 
1.63      www      4110: Returns: Determines which domain should be used for designs
1.60      matthew  4111: 
                   4112: =cut
1.54      www      4113: 
1.60      matthew  4114: ###############################################
1.63      www      4115: sub determinedomain {
                   4116:     my $domain=shift;
1.531     albertel 4117:     if (! $domain) {
1.60      matthew  4118:         # Determine domain if we have not been given one
1.893     raeburn  4119:         $domain = &Apache::lonnet::default_login_domain();
1.258     albertel 4120:         if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
                   4121:         if ($env{'request.role.domain'}) { 
                   4122:             $domain=$env{'request.role.domain'}; 
1.60      matthew  4123:         }
                   4124:     }
1.63      www      4125:     return $domain;
                   4126: }
                   4127: ###############################################
1.517     raeburn  4128: 
1.518     albertel 4129: sub devalidate_domconfig_cache {
                   4130:     my ($udom)=@_;
                   4131:     &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
                   4132: }
                   4133: 
                   4134: # ---------------------- Get domain configuration for a domain
                   4135: sub get_domainconf {
                   4136:     my ($udom) = @_;
                   4137:     my $cachetime=1800;
                   4138:     my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
                   4139:     if (defined($cached)) { return %{$result}; }
                   4140: 
                   4141:     my %domconfig = &Apache::lonnet::get_dom('configuration',
                   4142: 					     ['login','rolecolors'],$udom);
1.632     raeburn  4143:     my (%designhash,%legacy);
1.518     albertel 4144:     if (keys(%domconfig) > 0) {
                   4145:         if (ref($domconfig{'login'}) eq 'HASH') {
1.632     raeburn  4146:             if (keys(%{$domconfig{'login'}})) {
                   4147:                 foreach my $key (keys(%{$domconfig{'login'}})) {
1.699     raeburn  4148:                     if (ref($domconfig{'login'}{$key}) eq 'HASH') {
                   4149:                         foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
                   4150:                             $designhash{$udom.'.login.'.$key.'_'.$img} = 
                   4151:                                 $domconfig{'login'}{$key}{$img};
                   4152:                         }
                   4153:                     } else {
                   4154:                         $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
                   4155:                     }
1.632     raeburn  4156:                 }
                   4157:             } else {
                   4158:                 $legacy{'login'} = 1;
1.518     albertel 4159:             }
1.632     raeburn  4160:         } else {
                   4161:             $legacy{'login'} = 1;
1.518     albertel 4162:         }
                   4163:         if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632     raeburn  4164:             if (keys(%{$domconfig{'rolecolors'}})) {
                   4165:                 foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
                   4166:                     if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
                   4167:                         foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
                   4168:                             $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
                   4169:                         }
1.518     albertel 4170:                     }
                   4171:                 }
1.632     raeburn  4172:             } else {
                   4173:                 $legacy{'rolecolors'} = 1;
1.518     albertel 4174:             }
1.632     raeburn  4175:         } else {
                   4176:             $legacy{'rolecolors'} = 1;
1.518     albertel 4177:         }
1.632     raeburn  4178:         if (keys(%legacy) > 0) {
                   4179:             my %legacyhash = &get_legacy_domconf($udom);
                   4180:             foreach my $item (keys(%legacyhash)) {
                   4181:                 if ($item =~ /^\Q$udom\E\.login/) {
                   4182:                     if ($legacy{'login'}) { 
                   4183:                         $designhash{$item} = $legacyhash{$item};
                   4184:                     }
                   4185:                 } else {
                   4186:                     if ($legacy{'rolecolors'}) {
                   4187:                         $designhash{$item} = $legacyhash{$item};
                   4188:                     }
1.518     albertel 4189:                 }
                   4190:             }
                   4191:         }
1.632     raeburn  4192:     } else {
                   4193:         %designhash = &get_legacy_domconf($udom); 
1.518     albertel 4194:     }
                   4195:     &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
                   4196: 				  $cachetime);
                   4197:     return %designhash;
                   4198: }
                   4199: 
1.632     raeburn  4200: sub get_legacy_domconf {
                   4201:     my ($udom) = @_;
                   4202:     my %legacyhash;
                   4203:     my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
                   4204:     my $designfile =  $designdir.'/'.$udom.'.tab';
                   4205:     if (-e $designfile) {
                   4206:         if ( open (my $fh,"<$designfile") ) {
                   4207:             while (my $line = <$fh>) {
                   4208:                 next if ($line =~ /^\#/);
                   4209:                 chomp($line);
                   4210:                 my ($key,$val)=(split(/\=/,$line));
                   4211:                 if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
                   4212:             }
                   4213:             close($fh);
                   4214:         }
                   4215:     }
                   4216:     if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
                   4217:         $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
                   4218:     }
                   4219:     return %legacyhash;
                   4220: }
                   4221: 
1.63      www      4222: =pod
                   4223: 
1.112     bowersj2 4224: =item * &domainlogo()
1.63      www      4225: 
                   4226: Inputs: $domain (usually will be undef)
                   4227: 
                   4228: Returns: A link to a domain logo, if the domain logo exists.
                   4229: If the domain logo does not exist, a description of the domain.
                   4230: 
                   4231: =cut
1.112     bowersj2 4232: 
1.63      www      4233: ###############################################
                   4234: sub domainlogo {
1.517     raeburn  4235:     my $domain = &determinedomain(shift);
1.518     albertel 4236:     my %designhash = &get_domainconf($domain);    
1.517     raeburn  4237:     # See if there is a logo
                   4238:     if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519     raeburn  4239:         my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538     albertel 4240:         if ($imgsrc =~ m{^/(adm|res)/}) {
                   4241: 	    if ($imgsrc =~ m{^/res/}) {
                   4242: 		my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
                   4243: 		&Apache::lonnet::repcopy($local_name);
                   4244: 	    }
                   4245: 	   $imgsrc = &lonhttpdurl($imgsrc);
1.519     raeburn  4246:         } 
                   4247:         return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514     albertel 4248:     } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
                   4249:         return &Apache::lonnet::domain($domain,'description');
1.59      www      4250:     } else {
1.60      matthew  4251:         return '';
1.59      www      4252:     }
                   4253: }
1.63      www      4254: ##############################################
                   4255: 
                   4256: =pod
                   4257: 
1.112     bowersj2 4258: =item * &designparm()
1.63      www      4259: 
                   4260: Inputs: $which parameter; $domain (usually will be undef)
                   4261: 
                   4262: Returns: value of designparamter $which
                   4263: 
                   4264: =cut
1.112     bowersj2 4265: 
1.397     albertel 4266: 
1.400     albertel 4267: ##############################################
1.397     albertel 4268: sub designparm {
                   4269:     my ($which,$domain)=@_;
                   4270:     if (exists($env{'environment.color.'.$which})) {
1.817     bisitz   4271:         return $env{'environment.color.'.$which};
1.96      www      4272:     }
1.63      www      4273:     $domain=&determinedomain($domain);
1.518     albertel 4274:     my %domdesign = &get_domainconf($domain);
1.520     raeburn  4275:     my $output;
1.517     raeburn  4276:     if ($domdesign{$domain.'.'.$which} ne '') {
1.817     bisitz   4277:         $output = $domdesign{$domain.'.'.$which};
1.63      www      4278:     } else {
1.520     raeburn  4279:         $output = $defaultdesign{$which};
                   4280:     }
                   4281:     if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635     raeburn  4282:         ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538     albertel 4283:         if ($output =~ m{^/(adm|res)/}) {
1.817     bisitz   4284:             if ($output =~ m{^/res/}) {
                   4285:                 my $local_name = &Apache::lonnet::filelocation('',$output);
                   4286:                 &Apache::lonnet::repcopy($local_name);
                   4287:             }
1.520     raeburn  4288:             $output = &lonhttpdurl($output);
                   4289:         }
1.63      www      4290:     }
1.520     raeburn  4291:     return $output;
1.63      www      4292: }
1.59      www      4293: 
1.822     bisitz   4294: ##############################################
                   4295: =pod
                   4296: 
1.832     bisitz   4297: =item * &authorspace()
                   4298: 
                   4299: Inputs: ./.
                   4300: 
                   4301: Returns: Path to the Construction Space of the current user's
                   4302:          accessed author space
                   4303:          The author space will be that of the current user
                   4304:          when accessing the own author space
                   4305:          and that of the co-author/assistent co-author
                   4306:          when accessing the co-author's/assistent co-author's
                   4307:          space
                   4308: 
                   4309: =cut
                   4310: 
                   4311: sub authorspace {
                   4312:     my $caname = '';
                   4313:     if ($env{'request.role'} =~ /^ca|^aa/) {
                   4314:         (undef,$caname) =
                   4315:             ($env{'request.role'}=~/($match_domain)\/($match_username)$/);
                   4316:     } else {
                   4317:         $caname = $env{'user.name'};
                   4318:     }
                   4319:     return '/priv/'.$caname.'/';
                   4320: }
                   4321: 
                   4322: ##############################################
                   4323: =pod
                   4324: 
1.822     bisitz   4325: =item * &head_subbox()
                   4326: 
                   4327: Inputs: $content (contains HTML code with page functions, etc.)
                   4328: 
                   4329: Returns: HTML div with $content
                   4330:          To be included in page header
                   4331: 
                   4332: =cut
                   4333: 
                   4334: sub head_subbox {
                   4335:     my ($content)=@_;
                   4336:     my $output =
1.844     bisitz   4337:         '<div id="LC_head_subbox">'
1.822     bisitz   4338:        .$content
                   4339:        .'</div>'
                   4340: }
                   4341: 
                   4342: ##############################################
                   4343: =pod
                   4344: 
                   4345: =item * &CSTR_pageheader()
                   4346: 
                   4347: Inputs: ./.
                   4348: 
                   4349: Returns: HTML div with CSTR path and recent box
                   4350:          To be included on Construction Space pages
                   4351: 
                   4352: =cut
                   4353: 
                   4354: sub CSTR_pageheader {
                   4355:     # this is for resources; directories have customtitle, and crumbs
                   4356:             # and select recent are created in lonpubdir.pm  
                   4357:     my ($uname,$thisdisfn)=
                   4358:         ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
                   4359:     my $formaction='/priv/'.$uname.'/'.$thisdisfn;
                   4360:     $formaction=~s/\/+/\//g;
                   4361: 
                   4362:     my $parentpath = '';
                   4363:     my $lastitem = '';
                   4364:     if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
                   4365:         $parentpath = $1;
                   4366:         $lastitem = $2;
                   4367:     } else {
                   4368:         $lastitem = $thisdisfn;
                   4369:     }
                   4370:     return
                   4371:          '<div>'
                   4372:         .&Apache::loncommon::help_open_menu('','',3,'Authoring') #FIXME: Broken? Where is it?
                   4373:         .'<b>'.&mt('Construction Space:').'</b> '
                   4374:         .'<form name="dirs" method="post" action="'.$formaction
                   4375:         .'" target="_top"><tt><b>' #FIXME lonpubdir: target="_parent"
                   4376:         .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."$lastitem</b></tt><br />"
                   4377:         #FIXME lonpubdir: &Apache::lonhtmlcommon::crumbs($uname.$thisdisfn.'/','_top','/priv','','+1',1)."</b></tt><br />"
                   4378:         .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
                   4379:         .'</form>'
                   4380:         .&Apache::lonmenu::constspaceform()
                   4381:         .'</div>';
                   4382: }
                   4383: 
1.60      matthew  4384: ###############################################
                   4385: ###############################################
                   4386: 
                   4387: =pod
                   4388: 
1.112     bowersj2 4389: =back
                   4390: 
1.549     albertel 4391: =head1 HTML Helpers
1.112     bowersj2 4392: 
                   4393: =over 4
                   4394: 
                   4395: =item * &bodytag()
1.60      matthew  4396: 
                   4397: Returns a uniform header for LON-CAPA web pages.
                   4398: 
                   4399: Inputs: 
                   4400: 
1.112     bowersj2 4401: =over 4
                   4402: 
                   4403: =item * $title, A title to be displayed on the page.
                   4404: 
                   4405: =item * $function, the current role (can be undef).
                   4406: 
                   4407: =item * $addentries, extra parameters for the <body> tag.
                   4408: 
                   4409: =item * $bodyonly, if defined, only return the <body> tag.
                   4410: 
                   4411: =item * $domain, if defined, force a given domain.
                   4412: 
                   4413: =item * $forcereg, if page should register as content page (relevant for 
1.86      www      4414:             text interface only)
1.60      matthew  4415: 
1.814     bisitz   4416: =item * $no_nav_bar, if true, keep the 'what is this' info but remove the
                   4417:                      navigational links
1.317     albertel 4418: 
1.338     albertel 4419: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
                   4420: 
1.361     albertel 4421: =item * $no_inline_link, if true and in remote mode, don't show the 
                   4422:          'Switch To Inline Menu' link
                   4423: 
1.460     albertel 4424: =item * $args, optional argument valid values are
                   4425:             no_auto_mt_title -> prevents &mt()ing the title arg
1.562     albertel 4426:             inherit_jsmath -> when creating popup window in a page,
                   4427:                               should it have jsmath forced on by the
                   4428:                               current page
1.460     albertel 4429: 
1.112     bowersj2 4430: =back
                   4431: 
1.60      matthew  4432: Returns: A uniform header for LON-CAPA web pages.  
                   4433: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
                   4434: If $bodyonly is undef or zero, an html string containing a <body> tag and 
                   4435: other decorations will be returned.
                   4436: 
                   4437: =cut
                   4438: 
1.54      www      4439: sub bodytag {
1.831     bisitz   4440:     my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,
1.816     bisitz   4441:         $no_nav_bar,$bgcolor,$no_inline_link,$args)=@_;
1.339     albertel 4442: 
1.460     albertel 4443:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339     albertel 4444: 
1.183     matthew  4445:     $function = &get_users_function() if (!$function);
1.339     albertel 4446:     my $img =    &designparm($function.'.img',$domain);
                   4447:     my $font =   &designparm($function.'.font',$domain);
                   4448:     my $pgbg   = $bgcolor || &designparm($function.'.pgbg',$domain);
                   4449: 
1.803     bisitz   4450:     my %design = ( 'style'   => 'margin-top: 0',
1.535     albertel 4451: 		   'bgcolor' => $pgbg,
1.339     albertel 4452: 		   'text'    => $font,
                   4453:                    'alink'   => &designparm($function.'.alink',$domain),
                   4454: 		   'vlink'   => &designparm($function.'.vlink',$domain),
                   4455: 		   'link'    => &designparm($function.'.link',$domain),);
1.438     albertel 4456:     @design{keys(%$addentries)} = @$addentries{keys(%$addentries)}; 
1.339     albertel 4457: 
1.63      www      4458:  # role and realm
1.378     raeburn  4459:     my ($role,$realm) = split(/\./,$env{'request.role'},2);
                   4460:     if ($role  eq 'ca') {
1.479     albertel 4461:         my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500     albertel 4462:         $realm = &plainname($rname,$rdom);
1.378     raeburn  4463:     } 
1.55      www      4464: # realm
1.258     albertel 4465:     if ($env{'request.course.id'}) {
1.378     raeburn  4466:         if ($env{'request.role'} !~ /^cr/) {
                   4467:             $role = &Apache::lonnet::plaintext($role,&course_type());
                   4468:         }
1.898     raeburn  4469:         if ($env{'request.course.sec'}) {
                   4470:             $role .= ('&nbsp;'x2).'-&nbsp;'.&mt('section:').'&nbsp;'.$env{'request.course.sec'};
                   4471:         }   
1.359     albertel 4472: 	$realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378     raeburn  4473:     } else {
                   4474:         $role = &Apache::lonnet::plaintext($role);
1.54      www      4475:     }
1.433     albertel 4476: 
1.359     albertel 4477:     if (!$realm) { $realm='&nbsp;'; }
1.55      www      4478: # Set messages
1.60      matthew  4479:     my $messages=&domainlogo($domain);
1.330     albertel 4480: 
1.438     albertel 4481:     my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329     albertel 4482: 
1.101     www      4483: # construct main body tag
1.359     albertel 4484:     my $bodytag = "<body $extra_body_attr>".
1.562     albertel 4485: 	&Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252     albertel 4486: 
1.530     albertel 4487:     if ($bodyonly) {
1.60      matthew  4488:         return $bodytag;
1.798     tempelho 4489:     } 
1.359     albertel 4490: 
1.410     albertel 4491:     my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433     albertel 4492:     if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
                   4493: 	undef($role);
1.434     albertel 4494:     } else {
                   4495: 	$name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433     albertel 4496:     }
1.359     albertel 4497:     
1.762     bisitz   4498:     my $titleinfo = '<h1>'.$title.'</h1>';
1.359     albertel 4499:     #
                   4500:     # Extra info if you are the DC
                   4501:     my $dc_info = '';
                   4502:     if ($env{'user.adv'} && exists($env{'user.role.dc./'.
                   4503:                         $env{'course.'.$env{'request.course.id'}.
                   4504:                                  '.domain'}.'/'})) {
                   4505:         my $cid = $env{'request.course.id'};
                   4506:         $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380     www      4507:         $dc_info =~ s/\s+$//;
1.359     albertel 4508:         $dc_info = '('.$dc_info.')';
                   4509:     }
                   4510: 
1.898     raeburn  4511:     $role = '<span class="LC_nobreak">('.$role.')</span>' if $role;
1.853     droeschl 4512:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   4513: 
1.837     bisitz   4514:     if ($env{'environment.remote'} eq 'off') {
1.359     albertel 4515:         # No Remote
1.903     droeschl 4516:         if ($no_nav_bar) { return $bodytag; } 
                   4517: 
                   4518:         if ($env{'request.state'} eq 'construct') { $forcereg=1; }
                   4519: 
                   4520:         #    if ($env{'request.state'} eq 'construct') {
                   4521:         #        $titleinfo = &CSTR_pageheader(); #FIXME: Will be removed once all scripts have their own calls
                   4522:         #    }
                   4523: 
                   4524:         $bodytag .= qq|<div id="LC_nav_bar">$name $role<br />
                   4525:             <em>$realm</em> $dc_info</div>| unless $env{'form.inhibitmenu'};
1.359     albertel 4526: 
1.903     droeschl 4527:         if (   $env{'form.inhibitmenu'} eq 'yes' 
                   4528:             || $ENV{'REQUEST_URI'} eq '/adm/logout'
                   4529:             || $env{'request.noversionuri'} =~ m{^/res/adm/pages/}) {
1.359     albertel 4530: 
1.903     droeschl 4531:             return $bodytag;
                   4532:         }
1.894     droeschl 4533: 
1.903     droeschl 4534:         $bodytag .= Apache::lonhtmlcommon::scripttag(
                   4535:             Apache::lonmenu::utilityfunctions(), 'start');
1.816     bisitz   4536: 
1.903     droeschl 4537:         $bodytag .= Apache::lonmenu::primary_menu();
1.852     droeschl 4538: 
1.903     droeschl 4539:         #don't show menus for public users
                   4540:         if($env{'user.name'} ne 'public' && $env{'user.domain'} ne 'public'){
                   4541:             $bodytag .= Apache::lonmenu::secondary_menu();
                   4542:             $bodytag .= Apache::lonmenu::serverform();
                   4543:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
                   4544:             $bodytag .= Apache::lonmenu::innerregister($forcereg) if $forcereg;
                   4545:         }else{
                   4546:             # this is to seperate menu from content when there's no secondary
                   4547:             # menu. Especially needed for public accessible ressources.
                   4548:             $bodytag .= '<hr style="clear:both" />';
                   4549:             $bodytag .= Apache::lonhtmlcommon::scripttag('', 'end'); 
1.235     raeburn  4550:         }
1.903     droeschl 4551: 
                   4552:         #SD testing
                   4553:         #$bodytag .= Apache::lonmenu::menubuttons($forcereg);
1.235     raeburn  4554:         return $bodytag;
1.94      www      4555:     }
1.95      www      4556: 
1.93      www      4557: #
1.95      www      4558: # Top frame rendering, Remote is up
1.93      www      4559: #
1.359     albertel 4560: 
1.517     raeburn  4561:     my $imgsrc = $img;
                   4562:     if ($img =~ /^\/adm/) {
1.575     albertel 4563:         $imgsrc = &lonhttpdurl($img);
1.517     raeburn  4564:     }
                   4565:     my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359     albertel 4566: 
1.305     www      4567:     # Explicit link to get inline menu
1.361     albertel 4568:     my $menu= ($no_inline_link?''
1.883     droeschl 4569: 	       :'<a href="/adm/remote?action=collapse" target="_top">'.&mt('Switch to Inline Menu Mode').'</a>');
1.853     droeschl 4570:     $bodytag .= qq|<div id="LC_nav_bar">$name $role
                   4571:             <em>$realm</em> $dc_info </div>
1.897     wenzelju 4572:             <ol class="LC_primary_menu LC_right">
1.853     droeschl 4573:                 <li>$menu</li>
                   4574:             </ol>| unless $env{'form.inhibitmenu'};
1.245     matthew  4575:     #
1.94      www      4576:     return(<<ENDBODY);
1.60      matthew  4577: $bodytag
1.359     albertel 4578: <table id="LC_title_bar" class="LC_with_remote">
1.791     tempelho 4579: <tr><td>$upperleft</td>
                   4580:     <td>$messages&nbsp;</td>
1.54      www      4581: </tr>
1.359     albertel 4582: <tr><td>$titleinfo $dc_info $menu</td>
1.368     albertel 4583: </tr>
1.356     albertel 4584: </table>
1.54      www      4585: ENDBODY
1.182     matthew  4586: }
                   4587: 
1.330     albertel 4588: sub make_attr_string {
                   4589:     my ($register,$attr_ref) = @_;
                   4590: 
                   4591:     if ($attr_ref && !ref($attr_ref)) {
                   4592: 	die("addentries Must be a hash ref ".
                   4593: 	    join(':',caller(1))." ".
                   4594: 	    join(':',caller(0))." ");
                   4595:     }
                   4596: 
                   4597:     if ($register) {
1.339     albertel 4598: 	my ($on_load,$on_unload);
                   4599: 	foreach my $key (keys(%{$attr_ref})) {
                   4600: 	    if      (lc($key) eq 'onload') {
                   4601: 		$on_load.=$attr_ref->{$key}.';';
                   4602: 		delete($attr_ref->{$key});
                   4603: 
                   4604: 	    } elsif (lc($key) eq 'onunload') {
                   4605: 		$on_unload.=$attr_ref->{$key}.';';
                   4606: 		delete($attr_ref->{$key});
                   4607: 	    }
                   4608: 	}
                   4609: 	$attr_ref->{'onload'}  =
                   4610: 	    &Apache::lonmenu::loadevents().  $on_load;
                   4611: 	$attr_ref->{'onunload'}=
                   4612: 	    &Apache::lonmenu::unloadevents().$on_unload;
                   4613:     }
                   4614: 
                   4615: # Accessibility font enhance
                   4616:     if ($env{'browser.fontenhance'} eq 'on') {
                   4617: 	my $style;
                   4618: 	foreach my $key (keys(%{$attr_ref})) {
                   4619: 	    if (lc($key) eq 'style') {
                   4620: 		$style.=$attr_ref->{$key}.';';
                   4621: 		delete($attr_ref->{$key});
                   4622: 	    }
                   4623: 	}
                   4624: 	$attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330     albertel 4625:     }
1.339     albertel 4626: 
1.330     albertel 4627:     my $attr_string;
                   4628:     foreach my $attr (keys(%$attr_ref)) {
                   4629: 	$attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
                   4630:     }
                   4631:     return $attr_string;
                   4632: }
                   4633: 
                   4634: 
1.182     matthew  4635: ###############################################
1.251     albertel 4636: ###############################################
                   4637: 
                   4638: =pod
                   4639: 
                   4640: =item * &endbodytag()
                   4641: 
                   4642: Returns a uniform footer for LON-CAPA web pages.
                   4643: 
1.635     raeburn  4644: Inputs: 1 - optional reference to an args hash
                   4645: If in the hash, key for noredirectlink has a value which evaluates to true,
                   4646: a 'Continue' link is not displayed if the page contains an
                   4647: internal redirect in the <head></head> section,
                   4648: i.e., $env{'internal.head.redirect'} exists   
1.251     albertel 4649: 
                   4650: =cut
                   4651: 
                   4652: sub endbodytag {
1.635     raeburn  4653:     my ($args) = @_;
1.251     albertel 4654:     my $endbodytag='</body>';
1.269     albertel 4655:     $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315     albertel 4656:     if ( exists( $env{'internal.head.redirect'} ) ) {
1.635     raeburn  4657:         if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
                   4658: 	    $endbodytag=
                   4659: 	        "<br /><a href=\"$env{'internal.head.redirect'}\">".
                   4660: 	        &mt('Continue').'</a>'.
                   4661: 	        $endbodytag;
                   4662:         }
1.315     albertel 4663:     }
1.251     albertel 4664:     return $endbodytag;
                   4665: }
                   4666: 
1.352     albertel 4667: =pod
                   4668: 
                   4669: =item * &standard_css()
                   4670: 
                   4671: Returns a style sheet
                   4672: 
                   4673: Inputs: (all optional)
                   4674:             domain         -> force to color decorate a page for a specific
                   4675:                                domain
                   4676:             function       -> force usage of a specific rolish color scheme
                   4677:             bgcolor        -> override the default page bgcolor
                   4678: 
                   4679: =cut
                   4680: 
1.343     albertel 4681: sub standard_css {
1.345     albertel 4682:     my ($function,$domain,$bgcolor) = @_;
1.352     albertel 4683:     $function  = &get_users_function() if (!$function);
                   4684:     my $img    = &designparm($function.'.img',   $domain);
                   4685:     my $tabbg  = &designparm($function.'.tabbg', $domain);
                   4686:     my $font   = &designparm($function.'.font',  $domain);
1.801     tempelho 4687:     my $fontmenu = &designparm($function.'.fontmenu', $domain);
1.791     tempelho 4688: #second colour for later usage
1.345     albertel 4689:     my $sidebg = &designparm($function.'.sidebg',$domain);
1.382     albertel 4690:     my $pgbg_or_bgcolor =
                   4691: 	         $bgcolor ||
1.352     albertel 4692: 	         &designparm($function.'.pgbg',  $domain);
1.382     albertel 4693:     my $pgbg   = &designparm($function.'.pgbg',  $domain);
1.352     albertel 4694:     my $alink  = &designparm($function.'.alink', $domain);
                   4695:     my $vlink  = &designparm($function.'.vlink', $domain);
                   4696:     my $link   = &designparm($function.'.link',  $domain);
                   4697: 
1.704     muellerd 4698:     my $loginbg = &designparm('login.sidebg',$domain);
1.712     muellerd 4699:     my $bgcol = &designparm('login.bgcol',$domain);
                   4700:     my $textcol = &designparm('login.textcol',$domain);
1.704     muellerd 4701: 
1.602     albertel 4702:     my $sans                 = 'Verdana,Arial,Helvetica,sans-serif';
1.395     albertel 4703:     my $mono                 = 'monospace';
1.850     bisitz   4704:     my $data_table_head      = $sidebg;
                   4705:     my $data_table_light     = '#FAFAFA';
                   4706:     my $data_table_dark      = '#F0F0F0';
1.470     banghart 4707:     my $data_table_darker    = '#CCCCCC';
1.349     albertel 4708:     my $data_table_highlight = '#FFFF00';
1.352     albertel 4709:     my $mail_new             = '#FFBB77';
                   4710:     my $mail_new_hover       = '#DD9955';
                   4711:     my $mail_read            = '#BBBB77';
                   4712:     my $mail_read_hover      = '#999944';
                   4713:     my $mail_replied         = '#AAAA88';
                   4714:     my $mail_replied_hover   = '#888855';
                   4715:     my $mail_other           = '#99BBBB';
                   4716:     my $mail_other_hover     = '#669999';
1.391     albertel 4717:     my $table_header         = '#DDDDDD';
1.489     raeburn  4718:     my $feedback_link_bg     = '#BBBBBB';
1.911     bisitz   4719:     my $lg_border_color      = '#C8C8C8';
1.392     albertel 4720: 
1.608     albertel 4721:     my $border = ($env{'browser.type'} eq 'explorer' ||
1.911     bisitz   4722:       $env{'browser.type'} eq 'safari'     ) ? '0 2px 0 2px'
                   4723:                                              : '0 3px 0 4px';
1.448     albertel 4724: 
1.523     albertel 4725: 
1.343     albertel 4726:     return <<END;
1.795     www      4727: body {
1.911     bisitz   4728:   font-family: $sans;
                   4729:   line-height:130%;
                   4730:   font-size:0.83em;
                   4731:   color:$font;
1.795     www      4732: }
                   4733: 
1.911     bisitz   4734: a:link,
                   4735: a:visited {
                   4736:   font-size:100%;
1.795     www      4737: }
                   4738: 
1.911     bisitz   4739: a:focus {
1.795     www      4740:   color: red;
1.911     bisitz   4741:   background: yellow;
1.795     www      4742: }
1.698     harmsja  4743: 
1.911     bisitz   4744: form, .inline {
                   4745:   display: inline;
1.795     www      4746: }
1.721     harmsja  4747: 
1.795     www      4748: .LC_right {
1.911     bisitz   4749:   text-align:right;
1.795     www      4750: }
                   4751: 
                   4752: .LC_middle {
1.911     bisitz   4753:   vertical-align:middle;
1.795     www      4754: }
1.721     harmsja  4755: 
                   4756: /* just for tests */
1.911     bisitz   4757: .LC_400Box {
                   4758:   width:400px;
                   4759: }
1.721     harmsja  4760: /* end */
                   4761: 
1.778     bisitz   4762: .LC_filename {
                   4763:   font-family: $mono;
                   4764:   white-space:pre;
                   4765: }
                   4766: 
                   4767: .LC_fileicon {
                   4768:   border: none;
                   4769:   height: 1.3em;
                   4770:   vertical-align: text-bottom;
                   4771:   margin-right: 0.3em;
                   4772:   text-decoration:none;
                   4773: }
                   4774: 
1.350     albertel 4775: .LC_error {
                   4776:   color: red;
                   4777:   font-size: larger;
                   4778: }
1.795     www      4779: 
1.457     albertel 4780: .LC_warning,
                   4781: .LC_diff_removed {
1.733     bisitz   4782:   color: red;
1.394     albertel 4783: }
1.532     albertel 4784: 
                   4785: .LC_info,
1.457     albertel 4786: .LC_success,
                   4787: .LC_diff_added {
1.350     albertel 4788:   color: green;
                   4789: }
1.795     www      4790: 
1.802     bisitz   4791: div.LC_confirm_box {
                   4792:   background-color: #FAFAFA;
                   4793:   border: 1px solid $lg_border_color;
                   4794:   margin-right: 0;
                   4795:   padding: 5px;
                   4796: }
                   4797: 
                   4798: div.LC_confirm_box .LC_error img,
                   4799: div.LC_confirm_box .LC_success img {
                   4800:   vertical-align: middle;
                   4801: }
                   4802: 
1.440     albertel 4803: .LC_icon {
1.771     droeschl 4804:   border: none;
1.790     droeschl 4805:   vertical-align: middle;
1.771     droeschl 4806: }
                   4807: 
1.543     albertel 4808: .LC_docs_spacer {
                   4809:   width: 25px;
                   4810:   height: 1px;
1.771     droeschl 4811:   border: none;
1.543     albertel 4812: }
1.346     albertel 4813: 
1.532     albertel 4814: .LC_internal_info {
1.735     bisitz   4815:   color: #999999;
1.532     albertel 4816: }
                   4817: 
1.794     www      4818: .LC_discussion {
1.911     bisitz   4819:   background: $tabbg;
                   4820:   border: 1px solid black;
                   4821:   margin: 2px;
1.794     www      4822: }
                   4823: 
                   4824: .LC_disc_action_links_bar {
1.911     bisitz   4825:   background: $tabbg;
                   4826:   border: none;
                   4827:   margin: 4px;
1.794     www      4828: }
                   4829: 
                   4830: .LC_disc_action_left {
1.911     bisitz   4831:   text-align: left;
1.794     www      4832: }
                   4833: 
                   4834: .LC_disc_action_right {
1.911     bisitz   4835:   text-align: right;
1.794     www      4836: }
                   4837: 
                   4838: .LC_disc_new_item {
1.911     bisitz   4839:   background: white;
                   4840:   border: 2px solid red;
                   4841:   margin: 2px;
1.794     www      4842: }
                   4843: 
                   4844: .LC_disc_old_item {
1.911     bisitz   4845:   background: white;
                   4846:   border: 1px solid black;
                   4847:   margin: 2px;
1.794     www      4848: }
                   4849: 
1.458     albertel 4850: table.LC_pastsubmission {
                   4851:   border: 1px solid black;
                   4852:   margin: 2px;
                   4853: }
                   4854: 
1.795     www      4855: table#LC_top_nav,
                   4856: table#LC_menubuttons,
                   4857: table#LC_nav_location {
1.345     albertel 4858:   width: 100%;
                   4859:   background: $pgbg;
1.392     albertel 4860:   border: 2px;
1.402     albertel 4861:   border-collapse: separate;
1.803     bisitz   4862:   padding: 0;
1.345     albertel 4863: }
1.392     albertel 4864: 
1.801     tempelho 4865: table#LC_title_bar a {
                   4866:   color: $fontmenu;
                   4867: }
1.836     bisitz   4868: 
1.807     droeschl 4869: table#LC_title_bar {
1.819     tempelho 4870:   clear: both;
1.836     bisitz   4871:   display: none;
1.807     droeschl 4872: }
                   4873: 
1.795     www      4874: table#LC_title_bar,
                   4875: table.LC_breadcrumbs,
1.393     albertel 4876: table#LC_title_bar.LC_with_remote {
1.359     albertel 4877:   width: 100%;
1.392     albertel 4878:   border-color: $pgbg;
                   4879:   border-style: solid;
                   4880:   border-width: $border;
1.379     albertel 4881:   background: $pgbg;
1.801     tempelho 4882:   color: $fontmenu;
1.392     albertel 4883:   border-collapse: collapse;
1.803     bisitz   4884:   padding: 0;
1.819     tempelho 4885:   margin: 0;
1.359     albertel 4886: }
1.795     www      4887: 
1.913     droeschl 4888: /* #SD START (work in progress)*/
                   4889: 
                   4890: ul.LC_bct {
                   4891:     margin: 0;
                   4892:     padding: 0;
                   4893: }
                   4894: ul.LC_bct ol {
                   4895:     display: inline;
                   4896: }
                   4897: ul.LC_bct ul {
                   4898:     display: inline;
                   4899:     padding: 0;
                   4900: }
                   4901: ul.LC_bct li {
                   4902:     list-style-type: none;
                   4903:     display: inline;
                   4904: }
                   4905: 
                   4906: 
                   4907: ul.LC_breadcrumb_tools {
                   4908: }
                   4909: 
                   4910: li.LC_breadcrumb_tools {
                   4911: }
                   4912: li.LC_breadcrumb_tools img{
                   4913:     vertical-align: middle;
                   4914: }
                   4915: 
                   4916: .LC_breadcrumb_tools_A {
                   4917:     margin: 0 0 0 1em;
                   4918: }
                   4919: .LC_breadcrumb_tools_B {
                   4920:     float: right;
                   4921:     margin-top: 0.4em;
                   4922: }
                   4923: .LC_breadcrumb_tools_C {
                   4924:     margin: 0 1em 0 0;
                   4925:     float: right;
                   4926: }
                   4927: /* #SD END */
                   4928: 
1.359     albertel 4929: table#LC_title_bar td {
                   4930:   background: $tabbg;
                   4931: }
1.795     www      4932: 
1.911     bisitz   4933: table#LC_menubuttons img {
1.803     bisitz   4934:   border: none;
1.346     albertel 4935: }
1.795     www      4936: 
1.345     albertel 4937: table#LC_top_nav td {
                   4938:   background: $tabbg;
1.803     bisitz   4939:   border: none;
1.407     albertel 4940:   font-size: small;
1.706     harmsja  4941:   vertical-align:top;
                   4942:   padding:2px 5px 2px 5px;
1.345     albertel 4943: }
1.795     www      4944: 
                   4945: table#LC_top_nav td a,
                   4946: div#LC_top_nav a {
1.345     albertel 4947:   color: $font;
                   4948: }
1.795     www      4949: 
1.364     albertel 4950: table#LC_top_nav td.LC_top_nav_logo {
                   4951:   background: $tabbg;
1.432     albertel 4952:   text-align: left;
1.408     albertel 4953:   white-space: nowrap;
1.432     albertel 4954:   width: 31px;
1.408     albertel 4955: }
1.795     www      4956: 
1.408     albertel 4957: table#LC_top_nav td.LC_top_nav_logo img {
1.803     bisitz   4958:   border: none;
1.408     albertel 4959:   vertical-align: bottom;
1.364     albertel 4960: }
1.795     www      4961: 
1.777     tempelho 4962: table#LC_top_nav td.LC_top_nav_exit,
1.779     bisitz   4963: table#LC_top_nav td.LC_top_nav_help {
1.777     tempelho 4964:   width: 2.0em;
                   4965: }
1.795     www      4966: 
1.442     albertel 4967: table#LC_top_nav td.LC_top_nav_login {
                   4968:   width: 4.0em;
                   4969:   text-align: center;
                   4970: }
1.795     www      4971: 
1.842     droeschl 4972: .LC_breadcrumbs_component {
1.911     bisitz   4973:   float: right;
                   4974:   margin: 0 1em;
1.357     albertel 4975: }
1.842     droeschl 4976: .LC_breadcrumbs_component img {
1.911     bisitz   4977:   vertical-align: middle;
1.777     tempelho 4978: }
1.795     www      4979: 
1.383     albertel 4980: td.LC_table_cell_checkbox {
                   4981:   text-align: center;
                   4982: }
1.795     www      4983: 
1.779     bisitz   4984: table#LC_mainmenu td.LC_mainmenu_column {
1.911     bisitz   4985:   vertical-align: top;
1.777     tempelho 4986: }
1.522     albertel 4987: 
1.795     www      4988: .LC_fontsize_small {
1.911     bisitz   4989:   font-size: 70%;
1.705     tempelho 4990: }
                   4991: 
1.844     bisitz   4992: #LC_breadcrumbs {
1.911     bisitz   4993:   clear:both;
                   4994:   background: $sidebg;
                   4995:   border-bottom: 1px solid $lg_border_color;
                   4996:   line-height: 2.5em;
1.915   ! droeschl 4997:      /* SD working here 
        !          4998:      height: 2.5em;
        !          4999:      overflow: hidden; */
1.911     bisitz   5000:   margin: 0;
                   5001:   padding: 0;
1.819     tempelho 5002: }
1.862     bisitz   5003: 
1.839     droeschl 5004: /* Preliminary fix to hide breadcrumbs inside remote control window */
1.844     bisitz   5005: #LC_remote #LC_breadcrumbs {
1.911     bisitz   5006:   display:none;
1.839     droeschl 5007: }
1.819     tempelho 5008: 
1.844     bisitz   5009: #LC_head_subbox {
1.911     bisitz   5010:   clear:both;
                   5011:   background: #F8F8F8; /* $sidebg; */
1.915   ! droeschl 5012:   border: 1px solid $sidebg;
        !          5013:   margin: 0 0 10px 0;      
1.822     bisitz   5014: }
                   5015: 
1.795     www      5016: .LC_fontsize_medium {
1.911     bisitz   5017:   font-size: 85%;
1.705     tempelho 5018: }
                   5019: 
1.795     www      5020: .LC_fontsize_large {
1.911     bisitz   5021:   font-size: 120%;
1.705     tempelho 5022: }
                   5023: 
1.346     albertel 5024: .LC_menubuttons_inline_text {
                   5025:   color: $font;
1.698     harmsja  5026:   font-size: 90%;
1.701     harmsja  5027:   padding-left:3px;
1.346     albertel 5028: }
                   5029: 
1.526     www      5030: .LC_menubuttons_link {
                   5031:   text-decoration: none;
                   5032: }
1.795     www      5033: 
1.522     albertel 5034: .LC_menubuttons_category {
1.521     www      5035:   color: $font;
1.526     www      5036:   background: $pgbg;
1.521     www      5037:   font-size: larger;
                   5038:   font-weight: bold;
                   5039: }
                   5040: 
1.346     albertel 5041: td.LC_menubuttons_text {
1.911     bisitz   5042:   color: $font;
1.346     albertel 5043: }
1.706     harmsja  5044: 
1.346     albertel 5045: .LC_current_location {
                   5046:   background: $tabbg;
                   5047: }
1.795     www      5048: 
1.346     albertel 5049: .LC_new_mail {
1.634     www      5050:   background: $tabbg;
1.346     albertel 5051:   font-weight: bold;
                   5052: }
1.347     albertel 5053: 
1.795     www      5054: table.LC_data_table,
                   5055: table.LC_mail_list {
1.347     albertel 5056:   border: 1px solid #000000;
1.402     albertel 5057:   border-collapse: separate;
1.426     albertel 5058:   border-spacing: 1px;
1.610     albertel 5059:   background: $pgbg;
1.347     albertel 5060: }
1.795     www      5061: 
1.422     albertel 5062: .LC_data_table_dense {
                   5063:   font-size: small;
                   5064: }
1.795     www      5065: 
1.507     raeburn  5066: table.LC_nested_outer {
                   5067:   border: 1px solid #000000;
1.589     raeburn  5068:   border-collapse: collapse;
1.803     bisitz   5069:   border-spacing: 0;
1.507     raeburn  5070:   width: 100%;
                   5071: }
1.795     www      5072: 
1.879     raeburn  5073: table.LC_innerpickbox,
1.507     raeburn  5074: table.LC_nested {
1.803     bisitz   5075:   border: none;
1.589     raeburn  5076:   border-collapse: collapse;
1.803     bisitz   5077:   border-spacing: 0;
1.507     raeburn  5078:   width: 100%;
                   5079: }
1.795     www      5080: 
1.911     bisitz   5081: table.LC_data_table tr th,
                   5082: table.LC_calendar tr th,
1.795     www      5083: table.LC_mail_list tr th,
1.879     raeburn  5084: table.LC_prior_tries tr th,
                   5085: table.LC_innerpickbox tr th {
1.349     albertel 5086:   font-weight: bold;
                   5087:   background-color: $data_table_head;
1.801     tempelho 5088:   color:$fontmenu;
1.701     harmsja  5089:   font-size:90%;
1.347     albertel 5090: }
1.795     www      5091: 
1.879     raeburn  5092: table.LC_innerpickbox tr th,
                   5093: table.LC_innerpickbox tr td {
                   5094:   vertical-align: top;
                   5095: }
                   5096: 
1.711     raeburn  5097: table.LC_data_table tr.LC_info_row > td {
1.735     bisitz   5098:   background-color: #CCCCCC;
1.711     raeburn  5099:   font-weight: bold;
                   5100:   text-align: left;
                   5101: }
1.795     www      5102: 
1.912     bisitz   5103: table.LC_data_table tr.LC_odd_row > td {
                   5104:   background-color: $data_table_light;
                   5105:   padding: 2px;
                   5106:   vertical-align: top;
                   5107: }
                   5108: 
1.809     bisitz   5109: table.LC_pick_box tr > td.LC_odd_row {
1.349     albertel 5110:   background-color: $data_table_light;
1.912     bisitz   5111:   vertical-align: top;
                   5112: }
                   5113: 
                   5114: table.LC_data_table tr.LC_even_row > td {
                   5115:   background-color: $data_table_dark;
1.425     albertel 5116:   padding: 2px;
1.900     bisitz   5117:   vertical-align: top;
1.347     albertel 5118: }
1.795     www      5119: 
1.809     bisitz   5120: table.LC_pick_box tr > td.LC_even_row {
1.349     albertel 5121:   background-color: $data_table_dark;
1.900     bisitz   5122:   vertical-align: top;
1.347     albertel 5123: }
1.795     www      5124: 
1.425     albertel 5125: table.LC_data_table tr.LC_data_table_highlight td {
                   5126:   background-color: $data_table_darker;
                   5127: }
1.795     www      5128: 
1.639     raeburn  5129: table.LC_data_table tr td.LC_leftcol_header {
                   5130:   background-color: $data_table_head;
                   5131:   font-weight: bold;
                   5132: }
1.795     www      5133: 
1.451     albertel 5134: table.LC_data_table tr.LC_empty_row td,
1.507     raeburn  5135: table.LC_nested tr.LC_empty_row td {
1.347     albertel 5136:   background-color: #FFFFFF;
1.421     albertel 5137:   font-weight: bold;
                   5138:   font-style: italic;
                   5139:   text-align: center;
                   5140:   padding: 8px;
1.347     albertel 5141: }
1.795     www      5142: 
1.890     droeschl 5143: table.LC_caption {
                   5144: }
                   5145: 
1.507     raeburn  5146: table.LC_nested tr.LC_empty_row td {
1.465     albertel 5147:   padding: 4ex
                   5148: }
1.795     www      5149: 
1.507     raeburn  5150: table.LC_nested_outer tr th {
                   5151:   font-weight: bold;
1.801     tempelho 5152:   color:$fontmenu;
1.507     raeburn  5153:   background-color: $data_table_head;
1.701     harmsja  5154:   font-size: small;
1.507     raeburn  5155:   border-bottom: 1px solid #000000;
                   5156: }
1.795     www      5157: 
1.507     raeburn  5158: table.LC_nested_outer tr td.LC_subheader {
                   5159:   background-color: $data_table_head;
                   5160:   font-weight: bold;
                   5161:   font-size: small;
                   5162:   border-bottom: 1px solid #000000;
                   5163:   text-align: right;
1.451     albertel 5164: }
1.795     www      5165: 
1.507     raeburn  5166: table.LC_nested tr.LC_info_row td {
1.735     bisitz   5167:   background-color: #CCCCCC;
1.451     albertel 5168:   font-weight: bold;
                   5169:   font-size: small;
1.507     raeburn  5170:   text-align: center;
                   5171: }
1.795     www      5172: 
1.589     raeburn  5173: table.LC_nested tr.LC_info_row td.LC_left_item,
                   5174: table.LC_nested_outer tr th.LC_left_item {
1.507     raeburn  5175:   text-align: left;
1.451     albertel 5176: }
1.795     www      5177: 
1.507     raeburn  5178: table.LC_nested td {
1.735     bisitz   5179:   background-color: #FFFFFF;
1.451     albertel 5180:   font-size: small;
1.507     raeburn  5181: }
1.795     www      5182: 
1.507     raeburn  5183: table.LC_nested_outer tr th.LC_right_item,
                   5184: table.LC_nested tr.LC_info_row td.LC_right_item,
                   5185: table.LC_nested tr.LC_odd_row td.LC_right_item,
                   5186: table.LC_nested tr td.LC_right_item {
1.451     albertel 5187:   text-align: right;
                   5188: }
                   5189: 
1.507     raeburn  5190: table.LC_nested tr.LC_odd_row td {
1.735     bisitz   5191:   background-color: #EEEEEE;
1.451     albertel 5192: }
                   5193: 
1.473     raeburn  5194: table.LC_createuser {
                   5195: }
                   5196: 
                   5197: table.LC_createuser tr.LC_section_row td {
1.701     harmsja  5198:   font-size: small;
1.473     raeburn  5199: }
                   5200: 
                   5201: table.LC_createuser tr.LC_info_row td  {
1.735     bisitz   5202:   background-color: #CCCCCC;
1.473     raeburn  5203:   font-weight: bold;
                   5204:   text-align: center;
                   5205: }
                   5206: 
1.349     albertel 5207: table.LC_calendar {
                   5208:   border: 1px solid #000000;
                   5209:   border-collapse: collapse;
                   5210: }
1.795     www      5211: 
1.349     albertel 5212: table.LC_calendar_pickdate {
                   5213:   font-size: xx-small;
                   5214: }
1.795     www      5215: 
1.349     albertel 5216: table.LC_calendar tr td {
                   5217:   border: 1px solid #000000;
                   5218:   vertical-align: top;
                   5219: }
1.795     www      5220: 
1.349     albertel 5221: table.LC_calendar tr td.LC_calendar_day_empty {
                   5222:   background-color: $data_table_dark;
                   5223: }
1.795     www      5224: 
1.779     bisitz   5225: table.LC_calendar tr td.LC_calendar_day_current {
                   5226:   background-color: $data_table_highlight;
1.777     tempelho 5227: }
1.795     www      5228: 
1.349     albertel 5229: table.LC_mail_list tr.LC_mail_new {
                   5230:   background-color: $mail_new;
                   5231: }
1.795     www      5232: 
1.349     albertel 5233: table.LC_mail_list tr.LC_mail_new:hover {
                   5234:   background-color: $mail_new_hover;
                   5235: }
1.795     www      5236: 
                   5237: table.LC_mail_list tr.LC_mail_even {
1.777     tempelho 5238: }
1.795     www      5239: 
                   5240: table.LC_mail_list tr.LC_mail_odd {
1.777     tempelho 5241: }
1.795     www      5242: 
1.349     albertel 5243: table.LC_mail_list tr.LC_mail_read {
                   5244:   background-color: $mail_read;
                   5245: }
1.795     www      5246: 
1.349     albertel 5247: table.LC_mail_list tr.LC_mail_read:hover {
                   5248:   background-color: $mail_read_hover;
                   5249: }
1.795     www      5250: 
1.349     albertel 5251: table.LC_mail_list tr.LC_mail_replied {
                   5252:   background-color: $mail_replied;
                   5253: }
1.795     www      5254: 
1.349     albertel 5255: table.LC_mail_list tr.LC_mail_replied:hover {
                   5256:   background-color: $mail_replied_hover;
                   5257: }
1.795     www      5258: 
1.349     albertel 5259: table.LC_mail_list tr.LC_mail_other {
                   5260:   background-color: $mail_other;
                   5261: }
1.795     www      5262: 
1.349     albertel 5263: table.LC_mail_list tr.LC_mail_other:hover {
                   5264:   background-color: $mail_other_hover;
                   5265: }
1.494     raeburn  5266: 
1.777     tempelho 5267: table.LC_data_table tr > td.LC_browser_file,
                   5268: table.LC_data_table tr > td.LC_browser_file_published {
1.899     bisitz   5269:   background: #AAEE77;
1.389     albertel 5270: }
1.795     www      5271: 
1.777     tempelho 5272: table.LC_data_table tr > td.LC_browser_file_locked,
                   5273: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389     albertel 5274:   background: #FFAA99;
1.387     albertel 5275: }
1.795     www      5276: 
1.777     tempelho 5277: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.899     bisitz   5278:   background: #888888;
1.779     bisitz   5279: }
1.795     www      5280: 
1.777     tempelho 5281: table.LC_data_table tr > td.LC_browser_file_modified,
1.779     bisitz   5282: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.899     bisitz   5283:   background: #F8F866;
1.777     tempelho 5284: }
1.795     www      5285: 
1.696     bisitz   5286: table.LC_data_table tr.LC_browser_folder > td {
1.899     bisitz   5287:   background: #E0E8FF;
1.387     albertel 5288: }
1.696     bisitz   5289: 
1.707     bisitz   5290: table.LC_data_table tr > td.LC_roles_is {
1.911     bisitz   5291:   /* background: #77FF77; */
1.707     bisitz   5292: }
1.795     www      5293: 
1.707     bisitz   5294: table.LC_data_table tr > td.LC_roles_future {
                   5295:   background: #FFFF77;
                   5296: }
1.795     www      5297: 
1.707     bisitz   5298: table.LC_data_table tr > td.LC_roles_will {
                   5299:   background: #FFAA77;
                   5300: }
1.795     www      5301: 
1.707     bisitz   5302: table.LC_data_table tr > td.LC_roles_expired {
                   5303:   background: #FF7777;
                   5304: }
1.795     www      5305: 
1.707     bisitz   5306: table.LC_data_table tr > td.LC_roles_will_not {
                   5307:   background: #AAFF77;
                   5308: }
1.795     www      5309: 
1.707     bisitz   5310: table.LC_data_table tr > td.LC_roles_selected {
                   5311:   background: #11CC55;
                   5312: }
                   5313: 
1.388     albertel 5314: span.LC_current_location {
1.701     harmsja  5315:   font-size:larger;
1.388     albertel 5316:   background: $pgbg;
                   5317: }
1.387     albertel 5318: 
1.395     albertel 5319: span.LC_parm_menu_item {
                   5320:   font-size: larger;
                   5321: }
1.795     www      5322: 
1.395     albertel 5323: span.LC_parm_scope_all {
                   5324:   color: red;
                   5325: }
1.795     www      5326: 
1.395     albertel 5327: span.LC_parm_scope_folder {
                   5328:   color: green;
                   5329: }
1.795     www      5330: 
1.395     albertel 5331: span.LC_parm_scope_resource {
                   5332:   color: orange;
                   5333: }
1.795     www      5334: 
1.395     albertel 5335: span.LC_parm_part {
                   5336:   color: blue;
                   5337: }
1.795     www      5338: 
1.911     bisitz   5339: span.LC_parm_folder,
                   5340: span.LC_parm_symb {
1.395     albertel 5341:   font-size: x-small;
                   5342:   font-family: $mono;
                   5343:   color: #AAAAAA;
                   5344: }
                   5345: 
1.795     www      5346: td.LC_parm_overview_level_menu,
                   5347: td.LC_parm_overview_map_menu,
                   5348: td.LC_parm_overview_parm_selectors,
                   5349: td.LC_parm_overview_restrictions  {
1.396     albertel 5350:   border: 1px solid black;
                   5351:   border-collapse: collapse;
                   5352: }
1.795     www      5353: 
1.396     albertel 5354: table.LC_parm_overview_restrictions td {
                   5355:   border-width: 1px 4px 1px 4px;
                   5356:   border-style: solid;
                   5357:   border-color: $pgbg;
                   5358:   text-align: center;
                   5359: }
1.795     www      5360: 
1.396     albertel 5361: table.LC_parm_overview_restrictions th {
                   5362:   background: $tabbg;
                   5363:   border-width: 1px 4px 1px 4px;
                   5364:   border-style: solid;
                   5365:   border-color: $pgbg;
                   5366: }
1.795     www      5367: 
1.398     albertel 5368: table#LC_helpmenu {
1.803     bisitz   5369:   border: none;
1.398     albertel 5370:   height: 55px;
1.803     bisitz   5371:   border-spacing: 0;
1.398     albertel 5372: }
                   5373: 
                   5374: table#LC_helpmenu fieldset legend {
                   5375:   font-size: larger;
                   5376: }
1.795     www      5377: 
1.397     albertel 5378: table#LC_helpmenu_links {
                   5379:   width: 100%;
                   5380:   border: 1px solid black;
                   5381:   background: $pgbg;
1.803     bisitz   5382:   padding: 0;
1.397     albertel 5383:   border-spacing: 1px;
                   5384: }
1.795     www      5385: 
1.397     albertel 5386: table#LC_helpmenu_links tr td {
                   5387:   padding: 1px;
                   5388:   background: $tabbg;
1.399     albertel 5389:   text-align: center;
                   5390:   font-weight: bold;
1.397     albertel 5391: }
1.396     albertel 5392: 
1.795     www      5393: table#LC_helpmenu_links a:link,
                   5394: table#LC_helpmenu_links a:visited,
1.397     albertel 5395: table#LC_helpmenu_links a:active {
                   5396:   text-decoration: none;
                   5397:   color: $font;
                   5398: }
1.795     www      5399: 
1.397     albertel 5400: table#LC_helpmenu_links a:hover {
                   5401:   text-decoration: underline;
                   5402:   color: $vlink;
                   5403: }
1.396     albertel 5404: 
1.417     albertel 5405: .LC_chrt_popup_exists {
                   5406:   border: 1px solid #339933;
                   5407:   margin: -1px;
                   5408: }
1.795     www      5409: 
1.417     albertel 5410: .LC_chrt_popup_up {
                   5411:   border: 1px solid yellow;
                   5412:   margin: -1px;
                   5413: }
1.795     www      5414: 
1.417     albertel 5415: .LC_chrt_popup {
                   5416:   border: 1px solid #8888FF;
                   5417:   background: #CCCCFF;
                   5418: }
1.795     www      5419: 
1.421     albertel 5420: table.LC_pick_box {
                   5421:   border-collapse: separate;
                   5422:   background: white;
                   5423:   border: 1px solid black;
                   5424:   border-spacing: 1px;
                   5425: }
1.795     www      5426: 
1.421     albertel 5427: table.LC_pick_box td.LC_pick_box_title {
1.850     bisitz   5428:   background: $sidebg;
1.421     albertel 5429:   font-weight: bold;
1.900     bisitz   5430:   text-align: left;
1.740     bisitz   5431:   vertical-align: top;
1.421     albertel 5432:   width: 184px;
                   5433:   padding: 8px;
                   5434: }
1.795     www      5435: 
1.579     raeburn  5436: table.LC_pick_box td.LC_pick_box_value {
                   5437:   text-align: left;
                   5438:   padding: 8px;
                   5439: }
1.795     www      5440: 
1.579     raeburn  5441: table.LC_pick_box td.LC_pick_box_select {
                   5442:   text-align: left;
                   5443:   padding: 8px;
                   5444: }
1.795     www      5445: 
1.424     albertel 5446: table.LC_pick_box td.LC_pick_box_separator {
1.803     bisitz   5447:   padding: 0;
1.421     albertel 5448:   height: 1px;
                   5449:   background: black;
                   5450: }
1.795     www      5451: 
1.421     albertel 5452: table.LC_pick_box td.LC_pick_box_submit {
                   5453:   text-align: right;
                   5454: }
1.795     www      5455: 
1.579     raeburn  5456: table.LC_pick_box td.LC_evenrow_value {
                   5457:   text-align: left;
                   5458:   padding: 8px;
                   5459:   background-color: $data_table_light;
                   5460: }
1.795     www      5461: 
1.579     raeburn  5462: table.LC_pick_box td.LC_oddrow_value {
                   5463:   text-align: left;
                   5464:   padding: 8px;
                   5465:   background-color: $data_table_light;
                   5466: }
1.795     www      5467: 
1.579     raeburn  5468: span.LC_helpform_receipt_cat {
                   5469:   font-weight: bold;
                   5470: }
1.795     www      5471: 
1.424     albertel 5472: table.LC_group_priv_box {
                   5473:   background: white;
                   5474:   border: 1px solid black;
                   5475:   border-spacing: 1px;
                   5476: }
1.795     www      5477: 
1.424     albertel 5478: table.LC_group_priv_box td.LC_pick_box_title {
                   5479:   background: $tabbg;
                   5480:   font-weight: bold;
                   5481:   text-align: right;
                   5482:   width: 184px;
                   5483: }
1.795     www      5484: 
1.424     albertel 5485: table.LC_group_priv_box td.LC_groups_fixed {
                   5486:   background: $data_table_light;
                   5487:   text-align: center;
                   5488: }
1.795     www      5489: 
1.424     albertel 5490: table.LC_group_priv_box td.LC_groups_optional {
                   5491:   background: $data_table_dark;
                   5492:   text-align: center;
                   5493: }
1.795     www      5494: 
1.424     albertel 5495: table.LC_group_priv_box td.LC_groups_functionality {
                   5496:   background: $data_table_darker;
                   5497:   text-align: center;
                   5498:   font-weight: bold;
                   5499: }
1.795     www      5500: 
1.424     albertel 5501: table.LC_group_priv td {
                   5502:   text-align: left;
1.803     bisitz   5503:   padding: 0;
1.424     albertel 5504: }
                   5505: 
1.421     albertel 5506: table.LC_notify_front_page {
                   5507:   background: white;
                   5508:   border: 1px solid black;
                   5509:   padding: 8px;
                   5510: }
1.795     www      5511: 
1.421     albertel 5512: table.LC_notify_front_page td {
                   5513:   padding: 8px;
                   5514: }
1.795     www      5515: 
1.424     albertel 5516: .LC_navbuttons {
                   5517:   margin: 2ex 0ex 2ex 0ex;
                   5518: }
1.795     www      5519: 
1.423     albertel 5520: .LC_topic_bar {
                   5521:   font-weight: bold;
                   5522:   width: 100%;
                   5523:   background: $tabbg;
                   5524:   vertical-align: middle;
                   5525:   margin: 2ex 0ex 2ex 0ex;
1.805     bisitz   5526:   padding: 3px;
1.423     albertel 5527: }
1.795     www      5528: 
1.423     albertel 5529: .LC_topic_bar span {
                   5530:   vertical-align: middle;
                   5531: }
1.795     www      5532: 
1.423     albertel 5533: .LC_topic_bar img {
                   5534:   vertical-align: bottom;
                   5535: }
1.795     www      5536: 
1.423     albertel 5537: table.LC_course_group_status {
                   5538:   margin: 20px;
                   5539: }
1.795     www      5540: 
1.423     albertel 5541: table.LC_status_selector td {
                   5542:   vertical-align: top;
                   5543:   text-align: center;
1.424     albertel 5544:   padding: 4px;
                   5545: }
1.795     www      5546: 
1.599     albertel 5547: div.LC_feedback_link {
1.616     albertel 5548:   clear: both;
1.829     kalberla 5549:   background: $sidebg;
1.779     bisitz   5550:   width: 100%;
1.829     kalberla 5551:   padding-bottom: 10px;
                   5552:   border: 1px $tabbg solid;
1.833     kalberla 5553:   height: 22px;
                   5554:   line-height: 22px;
                   5555:   padding-top: 5px;
                   5556: }
                   5557: 
                   5558: div.LC_feedback_link img {
                   5559:   height: 22px;
1.867     kalberla 5560:   vertical-align:middle;
1.829     kalberla 5561: }
                   5562: 
1.911     bisitz   5563: div.LC_feedback_link a {
1.829     kalberla 5564:   text-decoration: none;
1.489     raeburn  5565: }
1.795     www      5566: 
1.867     kalberla 5567: div.LC_comblock {
1.911     bisitz   5568:   display:inline;
1.867     kalberla 5569:   color:$font;
                   5570:   font-size:90%;
                   5571: }
                   5572: 
                   5573: div.LC_feedback_link div.LC_comblock {
                   5574:   padding-left:5px;
                   5575: }
                   5576: 
                   5577: div.LC_feedback_link div.LC_comblock a {
                   5578:   color:$font;
                   5579: }
                   5580: 
1.489     raeburn  5581: span.LC_feedback_link {
1.858     bisitz   5582:   /* background: $feedback_link_bg; */
1.599     albertel 5583:   font-size: larger;
                   5584: }
1.795     www      5585: 
1.599     albertel 5586: span.LC_message_link {
1.858     bisitz   5587:   /* background: $feedback_link_bg; */
1.599     albertel 5588:   font-size: larger;
                   5589:   position: absolute;
                   5590:   right: 1em;
1.489     raeburn  5591: }
1.421     albertel 5592: 
1.515     albertel 5593: table.LC_prior_tries {
1.524     albertel 5594:   border: 1px solid #000000;
                   5595:   border-collapse: separate;
                   5596:   border-spacing: 1px;
1.515     albertel 5597: }
1.523     albertel 5598: 
1.515     albertel 5599: table.LC_prior_tries td {
1.524     albertel 5600:   padding: 2px;
1.515     albertel 5601: }
1.523     albertel 5602: 
                   5603: .LC_answer_correct {
1.795     www      5604:   background: lightgreen;
                   5605:   color: darkgreen;
                   5606:   padding: 6px;
1.523     albertel 5607: }
1.795     www      5608: 
1.523     albertel 5609: .LC_answer_charged_try {
1.797     www      5610:   background: #FFAAAA;
1.795     www      5611:   color: darkred;
                   5612:   padding: 6px;
1.523     albertel 5613: }
1.795     www      5614: 
1.779     bisitz   5615: .LC_answer_not_charged_try,
1.523     albertel 5616: .LC_answer_no_grade,
                   5617: .LC_answer_late {
1.795     www      5618:   background: lightyellow;
1.523     albertel 5619:   color: black;
1.795     www      5620:   padding: 6px;
1.523     albertel 5621: }
1.795     www      5622: 
1.523     albertel 5623: .LC_answer_previous {
1.795     www      5624:   background: lightblue;
                   5625:   color: darkblue;
                   5626:   padding: 6px;
1.523     albertel 5627: }
1.795     www      5628: 
1.779     bisitz   5629: .LC_answer_no_message {
1.777     tempelho 5630:   background: #FFFFFF;
                   5631:   color: black;
1.795     www      5632:   padding: 6px;
1.779     bisitz   5633: }
1.795     www      5634: 
1.779     bisitz   5635: .LC_answer_unknown {
                   5636:   background: orange;
                   5637:   color: black;
1.795     www      5638:   padding: 6px;
1.777     tempelho 5639: }
1.795     www      5640: 
1.529     albertel 5641: span.LC_prior_numerical,
                   5642: span.LC_prior_string,
                   5643: span.LC_prior_custom,
                   5644: span.LC_prior_reaction,
                   5645: span.LC_prior_math {
1.523     albertel 5646:   font-family: monospace;
                   5647:   white-space: pre;
                   5648: }
                   5649: 
1.525     albertel 5650: span.LC_prior_string {
                   5651:   font-family: monospace;
                   5652:   white-space: pre;
                   5653: }
                   5654: 
1.523     albertel 5655: table.LC_prior_option {
                   5656:   width: 100%;
                   5657:   border-collapse: collapse;
                   5658: }
1.795     www      5659: 
1.911     bisitz   5660: table.LC_prior_rank,
1.795     www      5661: table.LC_prior_match {
1.528     albertel 5662:   border-collapse: collapse;
                   5663: }
1.795     www      5664: 
1.528     albertel 5665: table.LC_prior_option tr td,
                   5666: table.LC_prior_rank tr td,
                   5667: table.LC_prior_match tr td {
1.524     albertel 5668:   border: 1px solid #000000;
1.515     albertel 5669: }
                   5670: 
1.855     bisitz   5671: .LC_nobreak {
1.544     albertel 5672:   white-space: nowrap;
1.519     raeburn  5673: }
                   5674: 
1.576     raeburn  5675: span.LC_cusr_emph {
                   5676:   font-style: italic;
                   5677: }
                   5678: 
1.633     raeburn  5679: span.LC_cusr_subheading {
                   5680:   font-weight: normal;
                   5681:   font-size: 85%;
                   5682: }
                   5683: 
1.545     albertel 5684: table.LC_docs_documents {
                   5685:   background: #BBBBBB;
1.803     bisitz   5686:   border-width: 0;
1.545     albertel 5687:   border-collapse: collapse;
                   5688: }
1.795     www      5689: 
1.777     tempelho 5690: table.LC_docs_documents td.LC_docs_document {
1.779     bisitz   5691:   border: 2px solid black;
                   5692:   padding: 4px;
1.777     tempelho 5693: }
1.795     www      5694: 
1.861     bisitz   5695: div.LC_docs_entry_move {
1.859     bisitz   5696:   border: 1px solid #BBBBBB;
1.545     albertel 5697:   background: #DDDDDD;
1.861     bisitz   5698:   width: 22px;
1.859     bisitz   5699:   padding: 1px;
                   5700:   margin: 0;
1.545     albertel 5701: }
                   5702: 
1.861     bisitz   5703: table.LC_data_table tr > td.LC_docs_entry_commands,
                   5704: table.LC_data_table tr > td.LC_docs_entry_parameter {
1.545     albertel 5705:   background: #DDDDDD;
                   5706:   font-size: x-small;
                   5707: }
1.795     www      5708: 
1.861     bisitz   5709: .LC_docs_entry_parameter {
                   5710:   white-space: nowrap;
                   5711: }
                   5712: 
1.544     albertel 5713: .LC_docs_copy {
1.545     albertel 5714:   color: #000099;
1.544     albertel 5715: }
1.795     www      5716: 
1.544     albertel 5717: .LC_docs_cut {
1.545     albertel 5718:   color: #550044;
1.544     albertel 5719: }
1.795     www      5720: 
1.544     albertel 5721: .LC_docs_rename {
1.545     albertel 5722:   color: #009900;
1.544     albertel 5723: }
1.795     www      5724: 
1.544     albertel 5725: .LC_docs_remove {
1.545     albertel 5726:   color: #990000;
                   5727: }
                   5728: 
1.547     albertel 5729: .LC_docs_reinit_warn,
                   5730: .LC_docs_ext_edit {
                   5731:   font-size: x-small;
                   5732: }
                   5733: 
1.545     albertel 5734: table.LC_docs_adddocs td,
                   5735: table.LC_docs_adddocs th {
                   5736:   border: 1px solid #BBBBBB;
                   5737:   padding: 4px;
                   5738:   background: #DDDDDD;
1.543     albertel 5739: }
                   5740: 
1.584     albertel 5741: table.LC_sty_begin {
                   5742:   background: #BBFFBB;
                   5743: }
1.795     www      5744: 
1.584     albertel 5745: table.LC_sty_end {
                   5746:   background: #FFBBBB;
                   5747: }
                   5748: 
1.589     raeburn  5749: table.LC_double_column {
1.803     bisitz   5750:   border-width: 0;
1.589     raeburn  5751:   border-collapse: collapse;
                   5752:   width: 100%;
                   5753:   padding: 2px;
                   5754: }
                   5755: 
                   5756: table.LC_double_column tr td.LC_left_col {
1.590     raeburn  5757:   top: 2px;
1.589     raeburn  5758:   left: 2px;
                   5759:   width: 47%;
                   5760:   vertical-align: top;
                   5761: }
                   5762: 
                   5763: table.LC_double_column tr td.LC_right_col {
                   5764:   top: 2px;
1.779     bisitz   5765:   right: 2px;
1.589     raeburn  5766:   width: 47%;
                   5767:   vertical-align: top;
                   5768: }
                   5769: 
1.591     raeburn  5770: div.LC_left_float {
                   5771:   float: left;
                   5772:   padding-right: 5%;
1.597     albertel 5773:   padding-bottom: 4px;
1.591     raeburn  5774: }
                   5775: 
                   5776: div.LC_clear_float_header {
1.597     albertel 5777:   padding-bottom: 2px;
1.591     raeburn  5778: }
                   5779: 
                   5780: div.LC_clear_float_footer {
1.597     albertel 5781:   padding-top: 10px;
1.591     raeburn  5782:   clear: both;
                   5783: }
                   5784: 
1.597     albertel 5785: div.LC_grade_show_user {
                   5786:   margin-top: 20px;
                   5787:   border: 1px solid black;
                   5788: }
1.795     www      5789: 
1.597     albertel 5790: div.LC_grade_user_name {
                   5791:   background: #DDDDEE;
                   5792:   border-bottom: 1px solid black;
1.705     tempelho 5793:   font-weight: bold;
                   5794:   font-size: large;
1.597     albertel 5795: }
1.795     www      5796: 
1.597     albertel 5797: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
                   5798:   background: #DDEEDD;
                   5799: }
                   5800: 
                   5801: div.LC_grade_show_problem,
                   5802: div.LC_grade_submissions,
                   5803: div.LC_grade_message_center,
                   5804: div.LC_grade_info_links,
                   5805: div.LC_grade_assign {
                   5806:   margin: 5px;
                   5807:   width: 99%;
                   5808:   background: #FFFFFF;
                   5809: }
1.795     www      5810: 
1.597     albertel 5811: div.LC_grade_show_problem_header,
                   5812: div.LC_grade_submissions_header,
                   5813: div.LC_grade_message_center_header,
                   5814: div.LC_grade_assign_header {
1.705     tempelho 5815:   font-weight: bold;
                   5816:   font-size: large;
1.597     albertel 5817: }
1.795     www      5818: 
1.597     albertel 5819: div.LC_grade_show_problem_problem,
                   5820: div.LC_grade_submissions_body,
                   5821: div.LC_grade_message_center_body,
                   5822: div.LC_grade_assign_body {
                   5823:   border: 1px solid black;
                   5824:   width: 99%;
                   5825:   background: #FFFFFF;
                   5826: }
1.795     www      5827: 
1.598     albertel 5828: span.LC_grade_check_note {
1.705     tempelho 5829:   font-weight: normal;
                   5830:   font-size: medium;
1.598     albertel 5831:   display: inline;
                   5832:   position: absolute;
                   5833:   right: 1em;
                   5834: }
1.597     albertel 5835: 
1.613     albertel 5836: table.LC_scantron_action {
                   5837:   width: 100%;
                   5838: }
1.795     www      5839: 
1.613     albertel 5840: table.LC_scantron_action tr th {
1.698     harmsja  5841:   font-weight:bold;
                   5842:   font-style:normal;
1.613     albertel 5843: }
1.795     www      5844: 
1.779     bisitz   5845: .LC_edit_problem_header,
1.614     albertel 5846: div.LC_edit_problem_footer {
1.705     tempelho 5847:   font-weight: normal;
                   5848:   font-size:  medium;
1.602     albertel 5849:   margin: 2px;
1.600     albertel 5850: }
1.795     www      5851: 
1.600     albertel 5852: div.LC_edit_problem_header,
1.602     albertel 5853: div.LC_edit_problem_header div,
1.614     albertel 5854: div.LC_edit_problem_footer,
                   5855: div.LC_edit_problem_footer div,
1.602     albertel 5856: div.LC_edit_problem_editxml_header,
                   5857: div.LC_edit_problem_editxml_header div {
1.600     albertel 5858:   margin-top: 5px;
                   5859: }
1.795     www      5860: 
1.600     albertel 5861: div.LC_edit_problem_header_title {
1.705     tempelho 5862:   font-weight: bold;
                   5863:   font-size: larger;
1.602     albertel 5864:   background: $tabbg;
                   5865:   padding: 3px;
                   5866: }
1.795     www      5867: 
1.602     albertel 5868: table.LC_edit_problem_header_title {
1.705     tempelho 5869:   font-size: larger;
                   5870:   font-weight:  bold;
1.602     albertel 5871:   width: 100%;
                   5872:   border-color: $pgbg;
                   5873:   border-style: solid;
                   5874:   border-width: $border;
1.600     albertel 5875:   background: $tabbg;
1.602     albertel 5876:   border-collapse: collapse;
1.803     bisitz   5877:   padding: 0;
1.602     albertel 5878: }
                   5879: 
                   5880: div.LC_edit_problem_discards {
                   5881:   float: left;
                   5882:   padding-bottom: 5px;
                   5883: }
1.795     www      5884: 
1.602     albertel 5885: div.LC_edit_problem_saves {
                   5886:   float: right;
                   5887:   padding-bottom: 5px;
1.600     albertel 5888: }
1.795     www      5889: 
1.911     bisitz   5890: img.stift {
1.803     bisitz   5891:   border-width: 0;
                   5892:   vertical-align: middle;
1.677     riegler  5893: }
1.680     riegler  5894: 
1.911     bisitz   5895: table#LC_mainmenu {
                   5896:   margin-top:10px;
                   5897:   width:80%;
1.681     riegler  5898: }
                   5899: 
1.911     bisitz   5900: table#LC_mainmenu td.LC_mainmenu_col_fieldset {
1.680     riegler  5901:   vertical-align: top;
                   5902:   width: 45%;
                   5903: }
1.795     www      5904: 
1.779     bisitz   5905: .LC_mainmenu_fieldset_category {
                   5906:   color: $font;
                   5907:   background: $pgbg;
                   5908:   font-size: small;
                   5909:   font-weight: bold;
1.777     tempelho 5910: }
1.795     www      5911: 
1.716     raeburn  5912: div.LC_createcourse {
1.911     bisitz   5913:   margin: 10px 10px 10px 10px;
1.716     raeburn  5914: }
                   5915: 
1.693     droeschl 5916: /* ---- Remove when done ----
                   5917: # The following styles is part of the redesign of LON-CAPA and are
                   5918: # subject to change during this project.
                   5919: # Don't rely on their current functionality as they might be 
                   5920: # changed or removed.
                   5921: # --------------------------*/
                   5922: 
1.698     harmsja  5923: a:hover,
1.897     wenzelju 5924: ol.LC_primary_menu a:hover,
1.721     harmsja  5925: ol#LC_MenuBreadcrumbs a:hover,
                   5926: ol#LC_PathBreadcrumbs a:hover,
1.897     wenzelju 5927: ul#LC_secondary_menu a:hover,
1.721     harmsja  5928: .LC_FormSectionClearButton input:hover
1.795     www      5929: ul.LC_TabContent   li:hover a {
1.911     bisitz   5930:   color:#BF2317;
                   5931:   text-decoration:none;
1.693     droeschl 5932: }
                   5933: 
1.779     bisitz   5934: h1 {
1.911     bisitz   5935:   padding: 0;
                   5936:   line-height:130%;
1.693     droeschl 5937: }
1.698     harmsja  5938: 
1.911     bisitz   5939: h2,
                   5940: h3,
                   5941: h4,
                   5942: h5,
                   5943: h6 {
                   5944:   margin: 5px 0 5px 0;
                   5945:   padding: 0;
                   5946:   line-height:130%;
1.693     droeschl 5947: }
1.795     www      5948: 
                   5949: .LC_hcell {
1.911     bisitz   5950:   padding:3px 15px 3px 15px;
                   5951:   margin: 0;
                   5952:   background-color:$tabbg;
                   5953:   color:$fontmenu;
                   5954:   border-bottom:solid 1px $lg_border_color;
1.693     droeschl 5955: }
1.795     www      5956: 
1.840     bisitz   5957: .LC_Box > .LC_hcell {
1.911     bisitz   5958:   margin: 0 -10px 10px -10px;
1.835     bisitz   5959: }
                   5960: 
1.721     harmsja  5961: .LC_noBorder {
1.911     bisitz   5962:   border: 0;
1.698     harmsja  5963: }
1.693     droeschl 5964: 
1.761     tempelho 5965: .LC_Right {
1.911     bisitz   5966:   float: right;
                   5967:   margin: 0;
                   5968:   padding: 0;
1.761     tempelho 5969: }
                   5970: 
1.721     harmsja  5971: .LC_FormSectionClearButton input {
1.911     bisitz   5972:   background-color:transparent;
                   5973:   border: none;
                   5974:   cursor:pointer;
                   5975:   text-decoration:underline;
1.693     droeschl 5976: }
1.763     bisitz   5977: 
                   5978: .LC_help_open_topic {
1.911     bisitz   5979:   color: #FFFFFF;
                   5980:   background-color: #EEEEFF;
                   5981:   margin: 1px;
                   5982:   padding: 4px;
                   5983:   border: 1px solid #000033;
                   5984:   white-space: nowrap;
                   5985:   /* vertical-align: middle; */
1.759     neumanie 5986: }
1.693     droeschl 5987: 
1.911     bisitz   5988: dl,
                   5989: ul,
                   5990: div,
                   5991: fieldset {
                   5992:   margin: 10px 10px 10px 0;
                   5993:   /* overflow: hidden; */
1.693     droeschl 5994: }
1.795     www      5995: 
1.838     bisitz   5996: fieldset > legend {
1.911     bisitz   5997:   font-weight: bold;
                   5998:   padding: 0 5px 0 5px;
1.838     bisitz   5999: }
                   6000: 
1.813     bisitz   6001: #LC_nav_bar {
1.911     bisitz   6002:   float: left;
                   6003:   margin: 0.2em 0 0 0;
1.807     droeschl 6004: }
                   6005: 
1.911     bisitz   6006: #LC_nav_bar em {
                   6007:   font-weight: bold;
                   6008:   font-style: normal;
1.807     droeschl 6009: }
                   6010: 
1.897     wenzelju 6011: ol.LC_primary_menu {
1.911     bisitz   6012:   float: right;
                   6013:   margin: 0.2em 0 0 0;
1.807     droeschl 6014: }
                   6015: 
1.852     droeschl 6016: ol#LC_PathBreadcrumbs {
1.911     bisitz   6017:   margin: 0;
1.693     droeschl 6018: }
                   6019: 
1.897     wenzelju 6020: ol.LC_primary_menu li {
1.911     bisitz   6021:   display: inline;
                   6022:   padding: 5px 5px 0 10px;
                   6023:   vertical-align: top;
1.693     droeschl 6024: }
                   6025: 
1.897     wenzelju 6026: ol.LC_primary_menu li img {
1.911     bisitz   6027:   vertical-align: bottom;
1.693     droeschl 6028: }
                   6029: 
1.897     wenzelju 6030: ol.LC_primary_menu a {
1.911     bisitz   6031:   font-size: 90%;
                   6032:   color: RGB(80, 80, 80);
                   6033:   text-decoration: none;
1.693     droeschl 6034: }
1.795     www      6035: 
1.897     wenzelju 6036: ul#LC_secondary_menu {
1.911     bisitz   6037:   clear: both;
                   6038:   color: $fontmenu;
                   6039:   background: $tabbg;
                   6040:   list-style: none;
                   6041:   padding: 0;
                   6042:   margin: 0;
                   6043:   width: 100%;
1.808     droeschl 6044: }
                   6045: 
1.897     wenzelju 6046: ul#LC_secondary_menu li {
1.911     bisitz   6047:   font-weight: bold;
                   6048:   line-height: 1.8em;
                   6049:   padding: 0 0.8em;
                   6050:   border-right: 1px solid black;
                   6051:   display: inline;
                   6052:   vertical-align: middle;
1.807     droeschl 6053: }
                   6054: 
1.847     tempelho 6055: ul.LC_TabContent {
1.911     bisitz   6056:   display:block;
                   6057:   background: $sidebg;
                   6058:   border-bottom: solid 1px $lg_border_color;
                   6059:   list-style:none;
                   6060:   margin: 0 -10px;
                   6061:   padding: 0;
1.693     droeschl 6062: }
                   6063: 
1.795     www      6064: ul.LC_TabContent li,
                   6065: ul.LC_TabContentBigger li {
1.911     bisitz   6066:   float:left;
1.741     harmsja  6067: }
1.795     www      6068: 
1.897     wenzelju 6069: ul#LC_secondary_menu li a {
1.911     bisitz   6070:   color: $fontmenu;
                   6071:   text-decoration: none;
1.693     droeschl 6072: }
1.795     www      6073: 
1.721     harmsja  6074: ul.LC_TabContent {
1.911     bisitz   6075:   min-height:1.5em;
1.721     harmsja  6076: }
1.795     www      6077: 
                   6078: ul.LC_TabContent li {
1.911     bisitz   6079:   vertical-align:middle;
                   6080:   padding: 0 10px 0 10px;
                   6081:   background-color:$tabbg;
                   6082:   border-bottom:solid 1px $lg_border_color;
1.721     harmsja  6083: }
1.795     www      6084: 
1.847     tempelho 6085: ul.LC_TabContent .right {
1.911     bisitz   6086:   float:right;
1.847     tempelho 6087: }
                   6088: 
1.911     bisitz   6089: ul.LC_TabContent li a,
                   6090: ul.LC_TabContent li {
                   6091:   color:rgb(47,47,47);
                   6092:   text-decoration:none;
                   6093:   font-size:95%;
                   6094:   font-weight:bold;
                   6095:   padding-right: 16px;
1.721     harmsja  6096: }
1.795     www      6097: 
1.911     bisitz   6098: ul.LC_TabContent li:hover,
                   6099: ul.LC_TabContent li.active {
                   6100:   background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
                   6101:   border-bottom:solid 2px #FFFFFF;
                   6102:   padding-right: 16px;
1.744     ehlerst  6103: }
1.795     www      6104: 
1.870     tempelho 6105: #maincoursedoc {
1.911     bisitz   6106:   clear:both;
1.870     tempelho 6107: }
                   6108: 
                   6109: ul.LC_TabContentBigger {
1.911     bisitz   6110:   display:block;
                   6111:   list-style:none;
                   6112:   padding: 0;
1.870     tempelho 6113: }
                   6114: 
1.795     www      6115: ul.LC_TabContentBigger li {
1.911     bisitz   6116:   vertical-align:bottom;
                   6117:   height: 30px;
                   6118:   font-size:110%;
                   6119:   font-weight:bold;
                   6120:   color: #737373;
1.841     tempelho 6121: }
                   6122: 
1.870     tempelho 6123: 
                   6124: ul.LC_TabContentBigger li a {
1.911     bisitz   6125:   background:url('/adm/lonIcons/tabbgleft.gif') left bottom no-repeat;
                   6126:   height: 30px;
                   6127:   line-height: 30px;
                   6128:   text-align: center;
                   6129:   display: block;
                   6130:   text-decoration: none;
1.741     harmsja  6131: }
1.795     www      6132: 
1.911     bisitz   6133: ul.LC_TabContentBigger li:hover a,
1.870     tempelho 6134: ul.LC_TabContentBigger li.active a {
1.911     bisitz   6135:   background:url('/adm/lonIcons/tabbgleft.gif') left top no-repeat;
                   6136:   color:$font;
                   6137:   text-decoration: underline;
1.744     ehlerst  6138: }
1.795     www      6139: 
1.870     tempelho 6140: 
                   6141: ul.LC_TabContentBigger li b {
1.911     bisitz   6142:   background: url('/adm/lonIcons/tabbgright.gif') no-repeat right bottom;
                   6143:   display: block;
                   6144:   float: left;
                   6145:   padding: 0 30px;
1.870     tempelho 6146: }
                   6147: 
                   6148: ul.LC_TabContentBigger li:hover b,
                   6149: ul.LC_TabContentBigger li.active b {
1.911     bisitz   6150:   background:url('/adm/lonIcons/tabbgright.gif') right top no-repeat;
                   6151:   color:$font;
                   6152:   border-bottom: 1px solid #FFFFFF;
1.741     harmsja  6153: }
1.693     droeschl 6154: 
1.870     tempelho 6155: 
1.862     bisitz   6156: ul.LC_CourseBreadcrumbs {
                   6157:   background: $sidebg;
                   6158:   line-height: 32px;
                   6159:   padding-left: 10px;
                   6160:   margin: 0 0 10px 0;
                   6161:   list-style-position: inside;
                   6162: 
                   6163: }
                   6164: 
1.911     bisitz   6165: ol#LC_MenuBreadcrumbs,
1.862     bisitz   6166: ol#LC_PathBreadcrumbs {
1.911     bisitz   6167:   padding-left: 10px;
                   6168:   margin: 0;
                   6169:   list-style-position: inside;
1.915   ! droeschl 6170:     /* SD working here 
1.904     droeschl 6171:     white-space: nowrap; */
1.693     droeschl 6172: }
                   6173: 
1.911     bisitz   6174: ol#LC_MenuBreadcrumbs li,
                   6175: ol#LC_PathBreadcrumbs li,
1.862     bisitz   6176: ul.LC_CourseBreadcrumbs li {
1.911     bisitz   6177:   display: inline;
                   6178:   white-space: nowrap;
1.915   ! droeschl 6179:     /* SD working here  
        !          6180:     white-space: normal; */ 
1.693     droeschl 6181: }
                   6182: 
1.823     bisitz   6183: ol#LC_MenuBreadcrumbs li a,
1.862     bisitz   6184: ul.LC_CourseBreadcrumbs li a {
1.911     bisitz   6185:   text-decoration: none;
                   6186:   font-size:90%;
1.693     droeschl 6187: }
1.795     www      6188: 
                   6189: ol#LC_PathBreadcrumbs li a {
1.911     bisitz   6190:   text-decoration:none;
                   6191:   font-size:100%;
                   6192:   font-weight:bold;
1.693     droeschl 6193: }
1.795     www      6194: 
1.840     bisitz   6195: .LC_Box {
1.911     bisitz   6196:   border: solid 1px $lg_border_color;
                   6197:   padding: 0 10px 10px 10px;
1.746     neumanie 6198: }
1.795     www      6199: 
                   6200: .LC_AboutMe_Image {
1.911     bisitz   6201:   float:left;
                   6202:   margin-right:10px;
1.747     neumanie 6203: }
1.795     www      6204: 
                   6205: .LC_Clear_AboutMe_Image {
1.911     bisitz   6206:   clear:left;
1.747     neumanie 6207: }
1.795     www      6208: 
1.721     harmsja  6209: dl.LC_ListStyleClean dt {
1.911     bisitz   6210:   padding-right: 5px;
                   6211:   display: table-header-group;
1.693     droeschl 6212: }
                   6213: 
1.721     harmsja  6214: dl.LC_ListStyleClean dd {
1.911     bisitz   6215:   display: table-row;
1.693     droeschl 6216: }
                   6217: 
1.721     harmsja  6218: .LC_ListStyleClean,
                   6219: .LC_ListStyleSimple,
                   6220: .LC_ListStyleNormal,
1.777     tempelho 6221: .LC_ListStyle_Border,
1.795     www      6222: .LC_ListStyleSpecial {
1.911     bisitz   6223:   /* display:block; */
                   6224:   list-style-position: inside;
                   6225:   list-style-type: none;
                   6226:   overflow: hidden;
                   6227:   padding: 0;
1.693     droeschl 6228: }
                   6229: 
1.721     harmsja  6230: .LC_ListStyleSimple li,
                   6231: .LC_ListStyleSimple dd,
                   6232: .LC_ListStyleNormal li,
                   6233: .LC_ListStyleNormal dd,
                   6234: .LC_ListStyleSpecial li,
1.795     www      6235: .LC_ListStyleSpecial dd {
1.911     bisitz   6236:   margin: 0;
                   6237:   padding: 5px 5px 5px 10px;
                   6238:   clear: both;
1.693     droeschl 6239: }
                   6240: 
1.721     harmsja  6241: .LC_ListStyleClean li,
                   6242: .LC_ListStyleClean dd {
1.911     bisitz   6243:   padding-top: 0;
                   6244:   padding-bottom: 0;
1.693     droeschl 6245: }
                   6246: 
1.721     harmsja  6247: .LC_ListStyleSimple dd,
1.795     www      6248: .LC_ListStyleSimple li {
1.911     bisitz   6249:   border-bottom: solid 1px $lg_border_color;
1.693     droeschl 6250: }
                   6251: 
1.721     harmsja  6252: .LC_ListStyleSpecial li,
                   6253: .LC_ListStyleSpecial dd {
1.911     bisitz   6254:   list-style-type: none;
                   6255:   background-color: RGB(220, 220, 220);
                   6256:   margin-bottom: 4px;
1.693     droeschl 6257: }
                   6258: 
1.721     harmsja  6259: table.LC_SimpleTable {
1.911     bisitz   6260:   margin:5px;
                   6261:   border:solid 1px $lg_border_color;
1.795     www      6262: }
1.693     droeschl 6263: 
1.721     harmsja  6264: table.LC_SimpleTable tr {
1.911     bisitz   6265:   padding: 0;
                   6266:   border:solid 1px $lg_border_color;
1.693     droeschl 6267: }
1.795     www      6268: 
                   6269: table.LC_SimpleTable thead {
1.911     bisitz   6270:   background:rgb(220,220,220);
1.693     droeschl 6271: }
                   6272: 
1.721     harmsja  6273: div.LC_columnSection {
1.911     bisitz   6274:   display: block;
                   6275:   clear: both;
                   6276:   overflow: hidden;
                   6277:   margin: 0;
1.693     droeschl 6278: }
                   6279: 
1.721     harmsja  6280: div.LC_columnSection>* {
1.911     bisitz   6281:   float: left;
                   6282:   margin: 10px 20px 10px 0;
                   6283:   overflow:hidden;
1.693     droeschl 6284: }
1.721     harmsja  6285: 
1.694     tempelho 6286: .LC_loginpage_container {
1.911     bisitz   6287:   text-align:left;
                   6288:   margin : 0 auto;
                   6289:   width:90%;
                   6290:   padding: 10px;
                   6291:   height: auto;
                   6292:   background-color:#FFFFFF;
                   6293:   border:1px solid #CCCCCC;
1.694     tempelho 6294: }
                   6295: 
                   6296: 
                   6297: .LC_loginpage_loginContainer {
1.911     bisitz   6298:   float:left;
                   6299:   width: 182px;
                   6300:   padding: 2px;
                   6301:   border:1px solid #CCCCCC;
                   6302:   background-color:$loginbg;
1.694     tempelho 6303: }
                   6304: 
1.795     www      6305: .LC_loginpage_loginContainer h2 {
1.911     bisitz   6306:   margin-top: 0;
                   6307:   display:block;
                   6308:   background:$bgcol;
                   6309:   color:$textcol;
                   6310:   padding-left:5px;
1.712     muellerd 6311: }
1.785     tempelho 6312: 
1.694     tempelho 6313: .LC_loginpage_loginInfo {
1.911     bisitz   6314:   float:left;
                   6315:   width:182px;
                   6316:   border:1px solid #CCCCCC;
                   6317:   padding:2px;
1.712     muellerd 6318: }
                   6319: 
1.694     tempelho 6320: .LC_loginpage_space {
1.911     bisitz   6321:   clear: both;
                   6322:   margin-bottom: 20px;
                   6323:   border-bottom: 1px solid #CCCCCC;
1.694     tempelho 6324: }
                   6325: 
1.785     tempelho 6326: .LC_loginpage_floatLeft {
1.911     bisitz   6327:   float: left;
                   6328:   width: 200px;
                   6329:   margin: 0;
1.785     tempelho 6330: }
                   6331: 
1.795     www      6332: table em {
1.911     bisitz   6333:   font-weight: bold;
                   6334:   font-style: normal;
1.748     schulted 6335: }
1.795     www      6336: 
1.779     bisitz   6337: table.LC_tableBrowseRes,
1.795     www      6338: table.LC_tableOfContent {
1.911     bisitz   6339:   border:none;
                   6340:   border-spacing: 1px;
                   6341:   padding: 3px;
                   6342:   background-color: #FFFFFF;
                   6343:   font-size: 90%;
1.753     droeschl 6344: }
1.789     droeschl 6345: 
1.911     bisitz   6346: table.LC_tableOfContent {
                   6347:   border-collapse: collapse;
1.789     droeschl 6348: }
                   6349: 
1.771     droeschl 6350: table.LC_tableBrowseRes a,
1.768     schulted 6351: table.LC_tableOfContent a {
1.911     bisitz   6352:   background-color: transparent;
                   6353:   text-decoration: none;
1.753     droeschl 6354: }
                   6355: 
1.771     droeschl 6356: table.LC_tableBrowseRes tr.LC_trOdd,
1.911     bisitz   6357: table.LC_tableOfContent tr.LC_trOdd {
                   6358:   background-color: #EEEEEE;
1.753     droeschl 6359: }
                   6360: 
1.795     www      6361: table.LC_tableOfContent img {
1.911     bisitz   6362:   border: none;
                   6363:   height: 1.3em;
                   6364:   vertical-align: text-bottom;
                   6365:   margin-right: 0.3em;
1.753     droeschl 6366: }
1.757     schulted 6367: 
1.795     www      6368: a#LC_content_toolbar_firsthomework {
1.911     bisitz   6369:   background-image:url(/res/adm/pages/open-first-problem.gif);
1.774     ehlerst  6370: }
                   6371: 
1.795     www      6372: a#LC_content_toolbar_launchnav {
1.911     bisitz   6373:   background-image:url(/res/adm/pages/start-navigation.gif);
1.774     ehlerst  6374: }
                   6375: 
1.795     www      6376: a#LC_content_toolbar_closenav {
1.911     bisitz   6377:   background-image:url(/res/adm/pages/close-navigation.gif);
1.774     ehlerst  6378: }
                   6379: 
1.795     www      6380: a#LC_content_toolbar_everything {
1.911     bisitz   6381:   background-image:url(/res/adm/pages/show-all.gif);
1.774     ehlerst  6382: }
                   6383: 
1.795     www      6384: a#LC_content_toolbar_uncompleted {
1.911     bisitz   6385:   background-image:url(/res/adm/pages/show-incomplete-problems.gif);
1.774     ehlerst  6386: }
                   6387: 
1.795     www      6388: #LC_content_toolbar_clearbubbles {
1.911     bisitz   6389:   background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
1.774     ehlerst  6390: }
                   6391: 
1.795     www      6392: a#LC_content_toolbar_changefolder {
1.911     bisitz   6393:   background : url(/res/adm/pages/close-all-folders.gif) top center ;
1.757     schulted 6394: }
                   6395: 
1.795     www      6396: a#LC_content_toolbar_changefolder_toggled {
1.911     bisitz   6397:   background-image:url(/res/adm/pages/open-all-folders.gif);
1.757     schulted 6398: }
                   6399: 
1.795     www      6400: ul#LC_toolbar li a:hover {
1.911     bisitz   6401:   background-position: bottom center;
1.757     schulted 6402: }
                   6403: 
1.795     www      6404: ul#LC_toolbar {
1.911     bisitz   6405:   padding: 0;
                   6406:   margin: 2px;
                   6407:   list-style:none;
                   6408:   position:relative;
                   6409:   background-color:white;
1.757     schulted 6410: }
                   6411: 
1.795     www      6412: ul#LC_toolbar li {
1.911     bisitz   6413:   border:1px solid white;
                   6414:   padding: 0;
                   6415:   margin: 0;
                   6416:   float: left;
                   6417:   display:inline;
                   6418:   vertical-align:middle;
                   6419: }
1.757     schulted 6420: 
1.783     amueller 6421: 
1.795     www      6422: a.LC_toolbarItem {
1.911     bisitz   6423:   display:block;
                   6424:   padding: 0;
                   6425:   margin: 0;
                   6426:   height: 32px;
                   6427:   width: 32px;
                   6428:   color:white;
                   6429:   border: none;
                   6430:   background-repeat:no-repeat;
                   6431:   background-color:transparent;
1.757     schulted 6432: }
                   6433: 
1.915   ! droeschl 6434: ul.LC_funclist {
        !          6435:     margin: 0;
        !          6436:     padding: 0.5em 1em 0.5em 0;
        !          6437: }
        !          6438: 
        !          6439: ul.LC_funclist + ul.LC_funclist {
        !          6440:     /* 
        !          6441:        left border as a seperator if we have more than
        !          6442:        one list 
        !          6443:     */
        !          6444:     border-left: 1px solid $sidebg;
        !          6445:     /* 
        !          6446:        this hides the left border behind the border of the 
        !          6447:        outer box if element is wrapped to the next 'line' 
        !          6448:     */
        !          6449:     margin-left: -1px;
        !          6450: }
        !          6451: 
1.843     bisitz   6452: ul.LC_funclist li {
1.915   ! droeschl 6453:   display: inline;
1.782     bisitz   6454:   white-space: nowrap;
1.915   ! droeschl 6455:   margin: 0 0 0 25px;
        !          6456:   line-height: 150%;
1.782     bisitz   6457: }
                   6458: 
1.757     schulted 6459: 
1.343     albertel 6460: END
                   6461: }
                   6462: 
1.306     albertel 6463: =pod
                   6464: 
                   6465: =item * &headtag()
                   6466: 
                   6467: Returns a uniform footer for LON-CAPA web pages.
                   6468: 
1.307     albertel 6469: Inputs: $title - optional title for the head
                   6470:         $head_extra - optional extra HTML to put inside the <head>
1.315     albertel 6471:         $args - optional arguments
1.319     albertel 6472:             force_register - if is true call registerurl so the remote is 
                   6473:                              informed
1.415     albertel 6474:             redirect       -> array ref of
                   6475:                                    1- seconds before redirect occurs
                   6476:                                    2- url to redirect to
                   6477:                                    3- whether the side effect should occur
1.315     albertel 6478:                            (side effect of setting 
                   6479:                                $env{'internal.head.redirect'} to the url 
                   6480:                                redirected too)
1.352     albertel 6481:             domain         -> force to color decorate a page for a specific
                   6482:                                domain
                   6483:             function       -> force usage of a specific rolish color scheme
                   6484:             bgcolor        -> override the default page bgcolor
1.460     albertel 6485:             no_auto_mt_title
                   6486:                            -> prevent &mt()ing the title arg
1.464     albertel 6487: 
1.306     albertel 6488: =cut
                   6489: 
                   6490: sub headtag {
1.313     albertel 6491:     my ($title,$head_extra,$args) = @_;
1.306     albertel 6492:     
1.363     albertel 6493:     my $function = $args->{'function'} || &get_users_function();
                   6494:     my $domain   = $args->{'domain'}   || &determinedomain();
                   6495:     my $bgcolor  = $args->{'bgcolor'}  || &designparm($function.'.pgbg',$domain);
1.418     albertel 6496:     my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458     albertel 6497: 		   $Apache::lonnet::perlvar{'lonVersion'},
1.531     albertel 6498: 		   #time(),
1.418     albertel 6499: 		   $env{'environment.color.timestamp'},
1.363     albertel 6500: 		   $function,$domain,$bgcolor);
                   6501: 
1.369     www      6502:     $url = '/adm/css/'.&escape($url).'.css';
1.363     albertel 6503: 
1.308     albertel 6504:     my $result =
                   6505: 	'<head>'.
1.461     albertel 6506: 	&font_settings();
1.319     albertel 6507: 
1.461     albertel 6508:     if (!$args->{'frameset'}) {
                   6509: 	$result .= &Apache::lonhtmlcommon::htmlareaheaders();
                   6510:     }
1.319     albertel 6511:     if ($args->{'force_register'}) {
                   6512: 	$result .= &Apache::lonmenu::registerurl(1);
                   6513:     }
1.436     albertel 6514:     if (!$args->{'no_nav_bar'} 
                   6515: 	&& !$args->{'only_body'}
                   6516: 	&& !$args->{'frameset'}) {
                   6517: 	$result .= &help_menu_js();
                   6518:     }
1.319     albertel 6519: 
1.314     albertel 6520:     if (ref($args->{'redirect'})) {
1.414     albertel 6521: 	my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315     albertel 6522: 	$url = &Apache::lonenc::check_encrypt($url);
1.414     albertel 6523: 	if (!$inhibit_continue) {
                   6524: 	    $env{'internal.head.redirect'} = $url;
                   6525: 	}
1.313     albertel 6526: 	$result.=<<ADDMETA
                   6527: <meta http-equiv="pragma" content="no-cache" />
1.344     albertel 6528: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313     albertel 6529: ADDMETA
                   6530:     }
1.306     albertel 6531:     if (!defined($title)) {
                   6532: 	$title = 'The LearningOnline Network with CAPA';
                   6533:     }
1.460     albertel 6534:     if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
                   6535:     $result .= '<title> LON-CAPA '.$title.'</title>'
1.414     albertel 6536: 	.'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
                   6537: 	.$head_extra;
1.306     albertel 6538:     return $result;
                   6539: }
                   6540: 
                   6541: =pod
                   6542: 
1.340     albertel 6543: =item * &font_settings()
                   6544: 
                   6545: Returns neccessary <meta> to set the proper encoding
                   6546: 
                   6547: Inputs: none
                   6548: 
                   6549: =cut
                   6550: 
                   6551: sub font_settings {
                   6552:     my $headerstring='';
1.647     www      6553:     if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340     albertel 6554: 	$headerstring.=
                   6555: 	    '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
                   6556:     }
                   6557:     return $headerstring;
                   6558: }
                   6559: 
1.341     albertel 6560: =pod
                   6561: 
                   6562: =item * &xml_begin()
                   6563: 
                   6564: Returns the needed doctype and <html>
                   6565: 
                   6566: Inputs: none
                   6567: 
                   6568: =cut
                   6569: 
                   6570: sub xml_begin {
                   6571:     my $output='';
                   6572: 
1.592     albertel 6573:     if ($env{'internal.start_page'}==1) {
                   6574: 	&Apache::lonhtmlcommon::init_htmlareafields();
                   6575:     }
1.342     albertel 6576: 
1.341     albertel 6577:     if ($env{'browser.mathml'}) {
                   6578: 	$output='<?xml version="1.0"?>'
                   6579:             #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
                   6580: #            .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
                   6581:             
                   6582: #	    .'<!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">] >'
                   6583: 	    .'<!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">'
                   6584:             .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" ' 
                   6585: 	    .'xmlns="http://www.w3.org/1999/xhtml">';
                   6586:     } else {
1.849     bisitz   6587: 	$output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
                   6588:            .'<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1.341     albertel 6589:     }
                   6590:     return $output;
                   6591: }
1.340     albertel 6592: 
                   6593: =pod
                   6594: 
1.306     albertel 6595: =item * &endheadtag()
                   6596: 
                   6597: Returns a uniform </head> for LON-CAPA web pages.
                   6598: 
                   6599: Inputs: none
                   6600: 
                   6601: =cut
                   6602: 
                   6603: sub endheadtag {
                   6604:     return '</head>';
                   6605: }
                   6606: 
                   6607: =pod
                   6608: 
                   6609: =item * &head()
                   6610: 
                   6611: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
                   6612: 
1.648     raeburn  6613: Inputs:
                   6614: 
                   6615: =over 4
                   6616: 
                   6617: $title - optional title for the page
                   6618: 
                   6619: $head_extra - optional extra HTML to put inside the <head>
                   6620: 
                   6621: =back
1.405     albertel 6622: 
1.306     albertel 6623: =cut
                   6624: 
                   6625: sub head {
1.325     albertel 6626:     my ($title,$head_extra,$args) = @_;
                   6627:     return &headtag($title,$head_extra,$args).&endheadtag();
1.306     albertel 6628: }
                   6629: 
                   6630: =pod
                   6631: 
                   6632: =item * &start_page()
                   6633: 
                   6634: Returns a complete <html> .. <body> section for LON-CAPA web pages.
                   6635: 
1.648     raeburn  6636: Inputs:
                   6637: 
                   6638: =over 4
                   6639: 
                   6640: $title - optional title for the page
                   6641: 
                   6642: $head_extra - optional extra HTML to incude inside the <head>
                   6643: 
                   6644: $args - additional optional args supported are:
                   6645: 
                   6646: =over 8
                   6647: 
                   6648:              only_body      -> is true will set &bodytag() onlybodytag
1.317     albertel 6649:                                     arg on
1.814     bisitz   6650:              no_nav_bar     -> is true will set &bodytag() no_nav_bar arg on
1.648     raeburn  6651:              add_entries    -> additional attributes to add to the  <body>
                   6652:              domain         -> force to color decorate a page for a 
1.317     albertel 6653:                                     specific domain
1.648     raeburn  6654:              function       -> force usage of a specific rolish color
1.317     albertel 6655:                                     scheme
1.648     raeburn  6656:              redirect       -> see &headtag()
                   6657:              bgcolor        -> override the default page bg color
                   6658:              js_ready       -> return a string ready for being used in 
1.317     albertel 6659:                                     a javascript writeln
1.648     raeburn  6660:              html_encode    -> return a string ready for being used in 
1.320     albertel 6661:                                     a html attribute
1.648     raeburn  6662:              force_register -> if is true will turn on the &bodytag()
1.317     albertel 6663:                                     $forcereg arg
1.648     raeburn  6664:              frameset       -> if true will start with a <frameset>
1.330     albertel 6665:                                     rather than <body>
1.648     raeburn  6666:              skip_phases    -> hash ref of 
1.338     albertel 6667:                                     head -> skip the <html><head> generation
                   6668:                                     body -> skip all <body> generation
1.648     raeburn  6669:              no_inline_link -> if true and in remote mode, don't show the 
1.361     albertel 6670:                                     'Switch To Inline Menu' link
1.648     raeburn  6671:              no_auto_mt_title -> prevent &mt()ing the title arg
                   6672:              inherit_jsmath -> when creating popup window in a page,
                   6673:                                     should it have jsmath forced on by the
                   6674:                                     current page
1.867     kalberla 6675:              bread_crumbs ->             Array containing breadcrumbs
                   6676:              bread_crumbs_components ->  if exists show it as headline else show only the breadcrumbs
1.361     albertel 6677: 
1.648     raeburn  6678: =back
1.460     albertel 6679: 
1.648     raeburn  6680: =back
1.562     albertel 6681: 
1.306     albertel 6682: =cut
                   6683: 
                   6684: sub start_page {
1.309     albertel 6685:     my ($title,$head_extra,$args) = @_;
1.318     albertel 6686:     #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313     albertel 6687:     my %head_args;
1.352     albertel 6688:     foreach my $arg ('redirect','force_register','domain','function',
1.460     albertel 6689: 		     'bgcolor','frameset','no_nav_bar','only_body',
                   6690: 		     'no_auto_mt_title') {
1.319     albertel 6691: 	if (defined($args->{$arg})) {
1.324     raeburn  6692: 	    $head_args{$arg} = $args->{$arg};
1.319     albertel 6693: 	}
1.313     albertel 6694:     }
1.319     albertel 6695: 
1.315     albertel 6696:     $env{'internal.start_page'}++;
1.338     albertel 6697:     my $result;
                   6698:     if (! exists($args->{'skip_phases'}{'head'}) ) {
                   6699: 	$result.=
1.341     albertel 6700: 	    &xml_begin().
1.338     albertel 6701: 	    &headtag($title,$head_extra,\%head_args).&endheadtag();
                   6702:     }
                   6703:     
                   6704:     if (! exists($args->{'skip_phases'}{'body'}) ) {
                   6705: 	if ($args->{'frameset'}) {
                   6706: 	    my $attr_string = &make_attr_string($args->{'force_register'},
                   6707: 						$args->{'add_entries'});
                   6708: 	    $result .= "\n<frameset $attr_string>\n";
1.831     bisitz   6709:         } else {
                   6710:             $result .=
                   6711:                 &bodytag($title, 
                   6712:                          $args->{'function'},       $args->{'add_entries'},
                   6713:                          $args->{'only_body'},      $args->{'domain'},
                   6714:                          $args->{'force_register'}, $args->{'no_nav_bar'},
                   6715:                          $args->{'bgcolor'},        $args->{'no_inline_link'},
                   6716:                          $args);
                   6717:         }
1.330     albertel 6718:     }
1.338     albertel 6719: 
1.315     albertel 6720:     if ($args->{'js_ready'}) {
1.713     kaisler  6721: 		$result = &js_ready($result);
1.315     albertel 6722:     }
1.320     albertel 6723:     if ($args->{'html_encode'}) {
1.713     kaisler  6724: 		$result = &html_encode($result);
                   6725:     }
                   6726: 
1.813     bisitz   6727:     # Preparation for new and consistent functionlist at top of screen
                   6728:     # if ($args->{'functionlist'}) {
                   6729:     #            $result .= &build_functionlist();
                   6730:     #}
                   6731: 
                   6732:     # Don't add anything more if only_body wanted
                   6733:     return $result if $args->{'only_body'};
                   6734: 
                   6735:     #Breadcrumbs
1.758     kaisler  6736:     if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
                   6737: 		&Apache::lonhtmlcommon::clear_breadcrumbs();
                   6738: 		#if any br links exists, add them to the breadcrumbs
                   6739: 		if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {         
                   6740: 			foreach my $crumb (@{$args->{'bread_crumbs'}}){
                   6741: 				&Apache::lonhtmlcommon::add_breadcrumb($crumb);
                   6742: 			}
                   6743: 		}
                   6744: 
                   6745: 		#if bread_crumbs_component exists show it as headline else show only the breadcrumbs
                   6746: 		if(exists($args->{'bread_crumbs_component'})){
                   6747: 			$result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
                   6748: 		}else{
                   6749: 			$result .= &Apache::lonhtmlcommon::breadcrumbs();
                   6750: 		}
1.320     albertel 6751:     }
1.315     albertel 6752:     return $result;
1.306     albertel 6753: }
                   6754: 
1.330     albertel 6755: 
1.306     albertel 6756: =pod
                   6757: 
                   6758: =item * &head()
                   6759: 
                   6760: Returns a complete </body></html> section for LON-CAPA web pages.
                   6761: 
1.315     albertel 6762: Inputs:         $args - additional optional args supported are:
                   6763:                  js_ready     -> return a string ready for being used in 
                   6764:                                  a javascript writeln
1.320     albertel 6765:                  html_encode  -> return a string ready for being used in 
                   6766:                                  a html attribute
1.330     albertel 6767:                  frameset     -> if true will start with a <frameset>
                   6768:                                  rather than <body>
1.493     albertel 6769:                  dicsussion   -> if true will get discussion from
                   6770:                                   lonxml::xmlend
                   6771:                                  (you can pass the target and parser arguments
                   6772:                                   through optional 'target' and 'parser' args
                   6773:                                   to this routine)
1.306     albertel 6774: 
                   6775: =cut
                   6776: 
                   6777: sub end_page {
1.315     albertel 6778:     my ($args) = @_;
                   6779:     $env{'internal.end_page'}++;
1.330     albertel 6780:     my $result;
1.335     albertel 6781:     if ($args->{'discussion'}) {
                   6782: 	my ($target,$parser);
                   6783: 	if (ref($args->{'discussion'})) {
                   6784: 	    ($target,$parser) =($args->{'discussion'}{'target'},
                   6785: 				$args->{'discussion'}{'parser'});
                   6786: 	}
                   6787: 	$result .= &Apache::lonxml::xmlend($target,$parser);
                   6788:     }
                   6789: 
1.330     albertel 6790:     if ($args->{'frameset'}) {
                   6791: 	$result .= '</frameset>';
                   6792:     } else {
1.635     raeburn  6793: 	$result .= &endbodytag($args);
1.330     albertel 6794:     }
                   6795:     $result .= "\n</html>";
                   6796: 
1.315     albertel 6797:     if ($args->{'js_ready'}) {
1.317     albertel 6798: 	$result = &js_ready($result);
1.315     albertel 6799:     }
1.335     albertel 6800: 
1.320     albertel 6801:     if ($args->{'html_encode'}) {
                   6802: 	$result = &html_encode($result);
                   6803:     }
1.335     albertel 6804: 
1.315     albertel 6805:     return $result;
                   6806: }
                   6807: 
1.320     albertel 6808: sub html_encode {
                   6809:     my ($result) = @_;
                   6810: 
1.322     albertel 6811:     $result = &HTML::Entities::encode($result,'<>&"');
1.320     albertel 6812:     
                   6813:     return $result;
                   6814: }
1.317     albertel 6815: sub js_ready {
                   6816:     my ($result) = @_;
                   6817: 
1.323     albertel 6818:     $result =~ s/[\n\r]/ /xmsg;
                   6819:     $result =~ s/\\/\\\\/xmsg;
                   6820:     $result =~ s/'/\\'/xmsg;
1.372     albertel 6821:     $result =~ s{</}{<\\/}xmsg;
1.317     albertel 6822:     
                   6823:     return $result;
                   6824: }
                   6825: 
1.315     albertel 6826: sub validate_page {
                   6827:     if (  exists($env{'internal.start_page'})
1.316     albertel 6828: 	  &&     $env{'internal.start_page'} > 1) {
                   6829: 	&Apache::lonnet::logthis('start_page called multiple times '.
1.318     albertel 6830: 				 $env{'internal.start_page'}.' '.
1.316     albertel 6831: 				 $ENV{'request.filename'});
1.315     albertel 6832:     }
                   6833:     if (  exists($env{'internal.end_page'})
1.316     albertel 6834: 	  &&     $env{'internal.end_page'} > 1) {
                   6835: 	&Apache::lonnet::logthis('end_page called multiple times '.
1.318     albertel 6836: 				 $env{'internal.end_page'}.' '.
1.316     albertel 6837: 				 $env{'request.filename'});
1.315     albertel 6838:     }
                   6839:     if (     exists($env{'internal.start_page'})
                   6840: 	&& ! exists($env{'internal.end_page'})) {
1.316     albertel 6841: 	&Apache::lonnet::logthis('start_page called without end_page '.
                   6842: 				 $env{'request.filename'});
1.315     albertel 6843:     }
                   6844:     if (   ! exists($env{'internal.start_page'})
                   6845: 	&&   exists($env{'internal.end_page'})) {
1.316     albertel 6846: 	&Apache::lonnet::logthis('end_page called without start_page'.
                   6847: 				 $env{'request.filename'});
1.315     albertel 6848:     }
1.306     albertel 6849: }
1.315     albertel 6850: 
1.318     albertel 6851: sub simple_error_page {
                   6852:     my ($r,$title,$msg) = @_;
                   6853:     my $page =
                   6854: 	&Apache::loncommon::start_page($title).
                   6855: 	&mt($msg).
                   6856: 	&Apache::loncommon::end_page();
                   6857:     if (ref($r)) {
                   6858: 	$r->print($page);
1.327     albertel 6859: 	return;
1.318     albertel 6860:     }
                   6861:     return $page;
                   6862: }
1.347     albertel 6863: 
                   6864: {
1.610     albertel 6865:     my @row_count;
1.347     albertel 6866:     sub start_data_table {
1.422     albertel 6867: 	my ($add_class) = @_;
                   6868: 	my $css_class = (join(' ','LC_data_table',$add_class));
1.610     albertel 6869: 	unshift(@row_count,0);
1.422     albertel 6870: 	return '<table class="'.$css_class.'">'."\n";
1.347     albertel 6871:     }
                   6872: 
                   6873:     sub end_data_table {
1.610     albertel 6874: 	shift(@row_count);
1.389     albertel 6875: 	return '</table>'."\n";;
1.347     albertel 6876:     }
                   6877: 
                   6878:     sub start_data_table_row {
1.422     albertel 6879: 	my ($add_class) = @_;
1.610     albertel 6880: 	$row_count[0]++;
                   6881: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6882: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');
1.422     albertel 6883: 	return  '<tr class="'.$css_class.'">'."\n";;
1.347     albertel 6884:     }
1.471     banghart 6885:     
                   6886:     sub continue_data_table_row {
                   6887: 	my ($add_class) = @_;
1.610     albertel 6888: 	my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.900     bisitz   6889: 	$css_class = (join(' ',$css_class,$add_class)) unless ($add_class eq '');;
1.471     banghart 6890: 	return  '<tr class="'.$css_class.'">'."\n";;
                   6891:     }
1.347     albertel 6892: 
                   6893:     sub end_data_table_row {
1.389     albertel 6894: 	return '</tr>'."\n";;
1.347     albertel 6895:     }
1.367     www      6896: 
1.421     albertel 6897:     sub start_data_table_empty_row {
1.707     bisitz   6898: #	$row_count[0]++;
1.421     albertel 6899: 	return  '<tr class="LC_empty_row" >'."\n";;
                   6900:     }
                   6901: 
                   6902:     sub end_data_table_empty_row {
                   6903: 	return '</tr>'."\n";;
                   6904:     }
                   6905: 
1.367     www      6906:     sub start_data_table_header_row {
1.389     albertel 6907: 	return  '<tr class="LC_header_row">'."\n";;
1.367     www      6908:     }
                   6909: 
                   6910:     sub end_data_table_header_row {
1.389     albertel 6911: 	return '</tr>'."\n";;
1.367     www      6912:     }
1.890     droeschl 6913: 
                   6914:     sub data_table_caption {
                   6915:         my $caption = shift;
                   6916:         return "<caption class=\"LC_caption\">$caption</caption>";
                   6917:     }
1.347     albertel 6918: }
                   6919: 
1.548     albertel 6920: =pod
                   6921: 
                   6922: =item * &inhibit_menu_check($arg)
                   6923: 
                   6924: Checks for a inhibitmenu state and generates output to preserve it
                   6925: 
                   6926: Inputs:         $arg - can be any of
                   6927:                      - undef - in which case the return value is a string 
                   6928:                                to add  into arguments list of a uri
                   6929:                      - 'input' - in which case the return value is a HTML
                   6930:                                  <form> <input> field of type hidden to
                   6931:                                  preserve the value
                   6932:                      - a url - in which case the return value is the url with
                   6933:                                the neccesary cgi args added to preserve the
                   6934:                                inhibitmenu state
                   6935:                      - a ref to a url - no return value, but the string is
                   6936:                                         updated to include the neccessary cgi
                   6937:                                         args to preserve the inhibitmenu state
                   6938: 
                   6939: =cut
                   6940: 
                   6941: sub inhibit_menu_check {
                   6942:     my ($arg) = @_;
                   6943:     &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
                   6944:     if ($arg eq 'input') {
                   6945: 	if ($env{'form.inhibitmenu'}) {
                   6946: 	    return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
                   6947: 	} else {
                   6948: 	    return
                   6949: 	}
                   6950:     }
                   6951:     if ($env{'form.inhibitmenu'}) {
                   6952: 	if (ref($arg)) {
                   6953: 	    $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6954: 	} elsif ($arg eq '') {
                   6955: 	    $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
                   6956: 	} else {
                   6957: 	    $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
                   6958: 	}
                   6959:     }
                   6960:     if (!ref($arg)) {
                   6961: 	return $arg;
                   6962:     }
                   6963: }
                   6964: 
1.251     albertel 6965: ###############################################
1.182     matthew  6966: 
                   6967: =pod
                   6968: 
1.549     albertel 6969: =back
                   6970: 
                   6971: =head1 User Information Routines
                   6972: 
                   6973: =over 4
                   6974: 
1.405     albertel 6975: =item * &get_users_function()
1.182     matthew  6976: 
                   6977: Used by &bodytag to determine the current users primary role.
                   6978: Returns either 'student','coordinator','admin', or 'author'.
                   6979: 
                   6980: =cut
                   6981: 
                   6982: ###############################################
                   6983: sub get_users_function {
1.815     tempelho 6984:     my $function = 'norole';
1.818     tempelho 6985:     if ($env{'request.role'}=~/^(st)/) {
                   6986:         $function='student';
                   6987:     }
1.907     raeburn  6988:     if ($env{'request.role'}=~/^(cc|co|in|ta|ep)/) {
1.182     matthew  6989:         $function='coordinator';
                   6990:     }
1.258     albertel 6991:     if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182     matthew  6992:         $function='admin';
                   6993:     }
1.826     bisitz   6994:     if (($env{'request.role'}=~/^(au|ca|aa)/) ||
1.182     matthew  6995:         ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
                   6996:         $function='author';
                   6997:     }
                   6998:     return $function;
1.54      www      6999: }
1.99      www      7000: 
                   7001: ###############################################
                   7002: 
1.233     raeburn  7003: =pod
                   7004: 
1.821     raeburn  7005: =item * &show_course()
                   7006: 
                   7007: Used by lonmenu.pm and lonroles.pm to determine whether to use the word
                   7008: 'Courses' or 'Roles' in inline navigation and on screen displaying user's roles.
                   7009: 
                   7010: Inputs:
                   7011: None
                   7012: 
                   7013: Outputs:
                   7014: Scalar: 1 if 'Course' to be used, 0 otherwise.
                   7015: 
                   7016: =cut
                   7017: 
                   7018: ###############################################
                   7019: sub show_course {
                   7020:     my $course = !$env{'user.adv'};
                   7021:     if (!$env{'user.adv'}) {
                   7022:         foreach my $env (keys(%env)) {
                   7023:             next if ($env !~ m/^user\.priv\./);
                   7024:             if ($env !~ m/^user\.priv\.(?:st|cm)/) {
                   7025:                 $course = 0;
                   7026:                 last;
                   7027:             }
                   7028:         }
                   7029:     }
                   7030:     return $course;
                   7031: }
                   7032: 
                   7033: ###############################################
                   7034: 
                   7035: =pod
                   7036: 
1.542     raeburn  7037: =item * &check_user_status()
1.274     raeburn  7038: 
                   7039: Determines current status of supplied role for a
                   7040: specific user. Roles can be active, previous or future.
                   7041: 
                   7042: Inputs: 
                   7043: user's domain, user's username, course's domain,
1.375     raeburn  7044: course's number, optional section ID.
1.274     raeburn  7045: 
                   7046: Outputs:
                   7047: role status: active, previous or future. 
                   7048: 
                   7049: =cut
                   7050: 
                   7051: sub check_user_status {
1.412     raeburn  7052:     my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274     raeburn  7053:     my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
                   7054:     my @uroles = keys %userinfo;
                   7055:     my $srchstr;
                   7056:     my $active_chk = 'none';
1.412     raeburn  7057:     my $now = time;
1.274     raeburn  7058:     if (@uroles > 0) {
1.908     raeburn  7059:         if (($role eq 'cc') || ($role eq 'co') || ($sec eq '') || (!defined($sec))) {
1.274     raeburn  7060:             $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
                   7061:         } else {
1.412     raeburn  7062:             $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
                   7063:         }
                   7064:         if (grep/^\Q$srchstr\E$/,@uroles) {
1.274     raeburn  7065:             my $role_end = 0;
                   7066:             my $role_start = 0;
                   7067:             $active_chk = 'active';
1.412     raeburn  7068:             if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
                   7069:                 $role_end = $1;
                   7070:                 if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
                   7071:                     $role_start = $1;
1.274     raeburn  7072:                 }
                   7073:             }
                   7074:             if ($role_start > 0) {
1.412     raeburn  7075:                 if ($now < $role_start) {
1.274     raeburn  7076:                     $active_chk = 'future';
                   7077:                 }
                   7078:             }
                   7079:             if ($role_end > 0) {
1.412     raeburn  7080:                 if ($now > $role_end) {
1.274     raeburn  7081:                     $active_chk = 'previous';
                   7082:                 }
                   7083:             }
                   7084:         }
                   7085:     }
                   7086:     return $active_chk;
                   7087: }
                   7088: 
                   7089: ###############################################
                   7090: 
                   7091: =pod
                   7092: 
1.405     albertel 7093: =item * &get_sections()
1.233     raeburn  7094: 
                   7095: Determines all the sections for a course including
                   7096: sections with students and sections containing other roles.
1.419     raeburn  7097: Incoming parameters: 
                   7098: 
                   7099: 1. domain
                   7100: 2. course number 
                   7101: 3. reference to array containing roles for which sections should 
                   7102: be gathered (optional).
                   7103: 4. reference to array containing status types for which sections 
                   7104: should be gathered (optional).
                   7105: 
                   7106: If the third argument is undefined, sections are gathered for any role. 
                   7107: If the fourth argument is undefined, sections are gathered for any status.
                   7108: Permissible values are 'active' or 'future' or 'previous'.
1.233     raeburn  7109:  
1.374     raeburn  7110: Returns section hash (keys are section IDs, values are
                   7111: number of users in each section), subject to the
1.419     raeburn  7112: optional roles filter, optional status filter 
1.233     raeburn  7113: 
                   7114: =cut
                   7115: 
                   7116: ###############################################
                   7117: sub get_sections {
1.419     raeburn  7118:     my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366     albertel 7119:     if (!defined($cdom) || !defined($cnum)) {
                   7120:         my $cid =  $env{'request.course.id'};
                   7121: 
                   7122: 	return if (!defined($cid));
                   7123: 
                   7124:         $cdom = $env{'course.'.$cid.'.domain'};
                   7125:         $cnum = $env{'course.'.$cid.'.num'};
                   7126:     }
                   7127: 
                   7128:     my %sectioncount;
1.419     raeburn  7129:     my $now = time;
1.240     albertel 7130: 
1.366     albertel 7131:     if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276     albertel 7132: 	my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240     albertel 7133: 	my $sec_index = &Apache::loncoursedata::CL_SECTION();
                   7134: 	my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419     raeburn  7135:         my $start_index = &Apache::loncoursedata::CL_START();
                   7136:         my $end_index = &Apache::loncoursedata::CL_END();
                   7137:         my $status;
1.366     albertel 7138: 	while (my ($student,$data) = each(%$classlist)) {
1.419     raeburn  7139: 	    my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
                   7140: 				                     $data->[$status_index],
                   7141:                                                      $data->[$start_index],
                   7142:                                                      $data->[$end_index]);
                   7143:             if ($stu_status eq 'Active') {
                   7144:                 $status = 'active';
                   7145:             } elsif ($end < $now) {
                   7146:                 $status = 'previous';
                   7147:             } elsif ($start > $now) {
                   7148:                 $status = 'future';
                   7149:             } 
                   7150: 	    if ($section ne '-1' && $section !~ /^\s*$/) {
                   7151:                 if ((!defined($possible_status)) || (($status ne '') && 
                   7152:                     (grep/^\Q$status\E$/,@{$possible_status}))) { 
                   7153: 		    $sectioncount{$section}++;
                   7154:                 }
1.240     albertel 7155: 	    }
                   7156: 	}
                   7157:     }
                   7158:     my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7159:     foreach my $user (sort(keys(%courseroles))) {
                   7160: 	if ($user !~ /^(\w{2})/) { next; }
                   7161: 	my ($role) = ($user =~ /^(\w{2})/);
                   7162: 	if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419     raeburn  7163: 	my ($section,$status);
1.240     albertel 7164: 	if ($role eq 'cr' &&
                   7165: 	    $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
                   7166: 	    $section=$1;
                   7167: 	}
                   7168: 	if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
                   7169: 	if (!defined($section) || $section eq '-1') { next; }
1.419     raeburn  7170:         my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
                   7171:         if ($end == -1 && $start == -1) {
                   7172:             next; #deleted role
                   7173:         }
                   7174:         if (!defined($possible_status)) { 
                   7175:             $sectioncount{$section}++;
                   7176:         } else {
                   7177:             if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
                   7178:                 $status = 'active';
                   7179:             } elsif ($end < $now) {
                   7180:                 $status = 'future';
                   7181:             } elsif ($start > $now) {
                   7182:                 $status = 'previous';
                   7183:             }
                   7184:             if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
                   7185:                 $sectioncount{$section}++;
                   7186:             }
                   7187:         }
1.233     raeburn  7188:     }
1.366     albertel 7189:     return %sectioncount;
1.233     raeburn  7190: }
                   7191: 
1.274     raeburn  7192: ###############################################
1.294     raeburn  7193: 
                   7194: =pod
1.405     albertel 7195: 
                   7196: =item * &get_course_users()
                   7197: 
1.275     raeburn  7198: Retrieves usernames:domains for users in the specified course
                   7199: with specific role(s), and access status. 
                   7200: 
                   7201: Incoming parameters:
1.277     albertel 7202: 1. course domain
                   7203: 2. course number
                   7204: 3. access status: users must have - either active, 
1.275     raeburn  7205: previous, future, or all.
1.277     albertel 7206: 4. reference to array of permissible roles
1.288     raeburn  7207: 5. reference to array of section restrictions (optional)
                   7208: 6. reference to results object (hash of hashes).
                   7209: 7. reference to optional userdata hash
1.609     raeburn  7210: 8. reference to optional statushash
1.630     raeburn  7211: 9. flag if privileged users (except those set to unhide in
                   7212:    course settings) should be excluded    
1.609     raeburn  7213: Keys of top level results hash are roles.
1.275     raeburn  7214: Keys of inner hashes are username:domain, with 
                   7215: values set to access type.
1.288     raeburn  7216: Optional userdata hash returns an array with arguments in the 
                   7217: same order as loncoursedata::get_classlist() for student data.
                   7218: 
1.609     raeburn  7219: Optional statushash returns
                   7220: 
1.288     raeburn  7221: Entries for end, start, section and status are blank because
                   7222: of the possibility of multiple values for non-student roles.
                   7223: 
1.275     raeburn  7224: =cut
1.405     albertel 7225: 
1.275     raeburn  7226: ###############################################
1.405     albertel 7227: 
1.275     raeburn  7228: sub get_course_users {
1.630     raeburn  7229:     my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288     raeburn  7230:     my %idx = ();
1.419     raeburn  7231:     my %seclists;
1.288     raeburn  7232: 
                   7233:     $idx{udom} = &Apache::loncoursedata::CL_SDOM();
                   7234:     $idx{uname} =  &Apache::loncoursedata::CL_SNAME();
                   7235:     $idx{end} = &Apache::loncoursedata::CL_END();
                   7236:     $idx{start} = &Apache::loncoursedata::CL_START();
                   7237:     $idx{id} = &Apache::loncoursedata::CL_ID();
                   7238:     $idx{section} = &Apache::loncoursedata::CL_SECTION();
                   7239:     $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
                   7240:     $idx{status} = &Apache::loncoursedata::CL_STATUS();
                   7241: 
1.290     albertel 7242:     if (grep(/^st$/,@{$roles})) {
1.276     albertel 7243:         my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278     raeburn  7244:         my $now = time;
1.277     albertel 7245:         foreach my $student (keys(%{$classlist})) {
1.288     raeburn  7246:             my $match = 0;
1.412     raeburn  7247:             my $secmatch = 0;
1.419     raeburn  7248:             my $section = $$classlist{$student}[$idx{section}];
1.609     raeburn  7249:             my $status = $$classlist{$student}[$idx{status}];
1.419     raeburn  7250:             if ($section eq '') {
                   7251:                 $section = 'none';
                   7252:             }
1.291     albertel 7253:             if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7254:                 if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7255:                     $secmatch = 1;
                   7256:                 } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420     albertel 7257:                     if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7258:                         $secmatch = 1;
                   7259:                     }
                   7260:                 } else {  
1.419     raeburn  7261: 		    if (grep(/^\Q$section\E$/,@{$sections})) {
1.412     raeburn  7262: 		        $secmatch = 1;
                   7263:                     }
1.290     albertel 7264: 		}
1.412     raeburn  7265:                 if (!$secmatch) {
                   7266:                     next;
                   7267:                 }
1.419     raeburn  7268:             }
1.275     raeburn  7269:             if (defined($$types{'active'})) {
1.288     raeburn  7270:                 if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275     raeburn  7271:                     push(@{$$users{st}{$student}},'active');
1.288     raeburn  7272:                     $match = 1;
1.275     raeburn  7273:                 }
                   7274:             }
                   7275:             if (defined($$types{'previous'})) {
1.609     raeburn  7276:                 if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275     raeburn  7277:                     push(@{$$users{st}{$student}},'previous');
1.288     raeburn  7278:                     $match = 1;
1.275     raeburn  7279:                 }
                   7280:             }
                   7281:             if (defined($$types{'future'})) {
1.609     raeburn  7282:                 if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275     raeburn  7283:                     push(@{$$users{st}{$student}},'future');
1.288     raeburn  7284:                     $match = 1;
1.275     raeburn  7285:                 }
                   7286:             }
1.609     raeburn  7287:             if ($match) {
                   7288:                 push(@{$seclists{$student}},$section);
                   7289:                 if (ref($userdata) eq 'HASH') {
                   7290:                     $$userdata{$student} = $$classlist{$student};
                   7291:                 }
                   7292:                 if (ref($statushash) eq 'HASH') {
                   7293:                     $statushash->{$student}{'st'}{$section} = $status;
                   7294:                 }
1.288     raeburn  7295:             }
1.275     raeburn  7296:         }
                   7297:     }
1.412     raeburn  7298:     if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439     raeburn  7299:         my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7300:         my $now = time;
1.609     raeburn  7301:         my %displaystatus = ( previous => 'Expired',
                   7302:                               active   => 'Active',
                   7303:                               future   => 'Future',
                   7304:                             );
1.630     raeburn  7305:         my %nothide;
                   7306:         if ($hidepriv) {
                   7307:             my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
                   7308:             foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
                   7309:                 if ($user !~ /:/) {
                   7310:                     $nothide{join(':',split(/[\@]/,$user))}=1;
                   7311:                 } else {
                   7312:                     $nothide{$user} = 1;
                   7313:                 }
                   7314:             }
                   7315:         }
1.439     raeburn  7316:         foreach my $person (sort(keys(%coursepersonnel))) {
1.288     raeburn  7317:             my $match = 0;
1.412     raeburn  7318:             my $secmatch = 0;
1.439     raeburn  7319:             my $status;
1.412     raeburn  7320:             my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275     raeburn  7321:             $user =~ s/:$//;
1.439     raeburn  7322:             my ($end,$start) = split(/:/,$coursepersonnel{$person});
                   7323:             if ($end == -1 || $start == -1) {
                   7324:                 next;
                   7325:             }
                   7326:             if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
                   7327:                 (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412     raeburn  7328:                 my ($uname,$udom) = split(/:/,$user);
                   7329:                 if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420     albertel 7330:                     if (grep(/^all$/,@{$sections})) {
1.412     raeburn  7331:                         $secmatch = 1;
                   7332:                     } elsif ($usec eq '') {
1.420     albertel 7333:                         if (grep(/^none$/,@{$sections})) {
1.412     raeburn  7334:                             $secmatch = 1;
                   7335:                         }
                   7336:                     } else {
                   7337:                         if (grep(/^\Q$usec\E$/,@{$sections})) {
                   7338:                             $secmatch = 1;
                   7339:                         }
                   7340:                     }
                   7341:                     if (!$secmatch) {
                   7342:                         next;
                   7343:                     }
1.288     raeburn  7344:                 }
1.419     raeburn  7345:                 if ($usec eq '') {
                   7346:                     $usec = 'none';
                   7347:                 }
1.275     raeburn  7348:                 if ($uname ne '' && $udom ne '') {
1.630     raeburn  7349:                     if ($hidepriv) {
                   7350:                         if ((&Apache::lonnet::privileged($uname,$udom)) &&
                   7351:                             (!$nothide{$uname.':'.$udom})) {
                   7352:                             next;
                   7353:                         }
                   7354:                     }
1.503     raeburn  7355:                     if ($end > 0 && $end < $now) {
1.439     raeburn  7356:                         $status = 'previous';
                   7357:                     } elsif ($start > $now) {
                   7358:                         $status = 'future';
                   7359:                     } else {
                   7360:                         $status = 'active';
                   7361:                     }
1.277     albertel 7362:                     foreach my $type (keys(%{$types})) { 
1.275     raeburn  7363:                         if ($status eq $type) {
1.420     albertel 7364:                             if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419     raeburn  7365:                                 push(@{$$users{$role}{$user}},$type);
                   7366:                             }
1.288     raeburn  7367:                             $match = 1;
                   7368:                         }
                   7369:                     }
1.419     raeburn  7370:                     if (($match) && (ref($userdata) eq 'HASH')) {
                   7371:                         if (!exists($$userdata{$uname.':'.$udom})) {
                   7372: 			    &get_user_info($udom,$uname,\%idx,$userdata);
                   7373:                         }
1.420     albertel 7374:                         if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419     raeburn  7375:                             push(@{$seclists{$uname.':'.$udom}},$usec);
                   7376:                         }
1.609     raeburn  7377:                         if (ref($statushash) eq 'HASH') {
                   7378:                             $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
                   7379:                         }
1.275     raeburn  7380:                     }
                   7381:                 }
                   7382:             }
                   7383:         }
1.290     albertel 7384:         if (grep(/^ow$/,@{$roles})) {
1.279     raeburn  7385:             if ((defined($cdom)) && (defined($cnum))) {
                   7386:                 my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
                   7387:                 if ( defined($csettings{'internal.courseowner'}) ) {
                   7388:                     my $owner = $csettings{'internal.courseowner'};
1.609     raeburn  7389:                     next if ($owner eq '');
                   7390:                     my ($ownername,$ownerdom);
                   7391:                     if ($owner =~ /^([^:]+):([^:]+)$/) {
                   7392:                         $ownername = $1;
                   7393:                         $ownerdom = $2;
                   7394:                     } else {
                   7395:                         $ownername = $owner;
                   7396:                         $ownerdom = $cdom;
                   7397:                         $owner = $ownername.':'.$ownerdom;
1.439     raeburn  7398:                     }
                   7399:                     @{$$users{'ow'}{$owner}} = 'any';
1.290     albertel 7400:                     if (defined($userdata) && 
1.609     raeburn  7401: 			!exists($$userdata{$owner})) {
                   7402: 			&get_user_info($ownerdom,$ownername,\%idx,$userdata);
                   7403:                         if (!grep(/^none$/,@{$seclists{$owner}})) {
                   7404:                             push(@{$seclists{$owner}},'none');
                   7405:                         }
                   7406:                         if (ref($statushash) eq 'HASH') {
                   7407:                             $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419     raeburn  7408:                         }
1.290     albertel 7409: 		    }
1.279     raeburn  7410:                 }
                   7411:             }
                   7412:         }
1.419     raeburn  7413:         foreach my $user (keys(%seclists)) {
                   7414:             @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
                   7415:             $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
                   7416:         }
1.275     raeburn  7417:     }
                   7418:     return;
                   7419: }
                   7420: 
1.288     raeburn  7421: sub get_user_info {
                   7422:     my ($udom,$uname,$idx,$userdata) = @_;
1.289     albertel 7423:     $$userdata{$uname.':'.$udom}[$$idx{fullname}] = 
                   7424: 	&plainname($uname,$udom,'lastname');
1.291     albertel 7425:     $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297     raeburn  7426:     $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609     raeburn  7427:     my %idhash =  &Apache::lonnet::idrget($udom,($uname));
                   7428:     $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname}; 
1.288     raeburn  7429:     return;
                   7430: }
1.275     raeburn  7431: 
1.472     raeburn  7432: ###############################################
                   7433: 
                   7434: =pod
                   7435: 
                   7436: =item * &get_user_quota()
                   7437: 
                   7438: Retrieves quota assigned for storage of portfolio files for a user  
                   7439: 
                   7440: Incoming parameters:
                   7441: 1. user's username
                   7442: 2. user's domain
                   7443: 
                   7444: Returns:
1.536     raeburn  7445: 1. Disk quota (in Mb) assigned to student.
                   7446: 2. (Optional) Type of setting: custom or default
                   7447:    (individually assigned or default for user's 
                   7448:    institutional status).
                   7449: 3. (Optional) - User's institutional status (e.g., faculty, staff
                   7450:    or student - types as defined in localenroll::inst_usertypes 
                   7451:    for user's domain, which determines default quota for user.
                   7452: 4. (Optional) - Default quota which would apply to the user.
1.472     raeburn  7453: 
                   7454: If a value has been stored in the user's environment, 
1.536     raeburn  7455: it will return that, otherwise it returns the maximal default
                   7456: defined for the user's instituional status(es) in the domain.
1.472     raeburn  7457: 
                   7458: =cut
                   7459: 
                   7460: ###############################################
                   7461: 
                   7462: 
                   7463: sub get_user_quota {
                   7464:     my ($uname,$udom) = @_;
1.536     raeburn  7465:     my ($quota,$quotatype,$settingstatus,$defquota);
1.472     raeburn  7466:     if (!defined($udom)) {
                   7467:         $udom = $env{'user.domain'};
                   7468:     }
                   7469:     if (!defined($uname)) {
                   7470:         $uname = $env{'user.name'};
                   7471:     }
                   7472:     if (($udom eq '' || $uname eq '') ||
                   7473:         ($udom eq 'public') && ($uname eq 'public')) {
                   7474:         $quota = 0;
1.536     raeburn  7475:         $quotatype = 'default';
                   7476:         $defquota = 0; 
1.472     raeburn  7477:     } else {
1.536     raeburn  7478:         my $inststatus;
1.472     raeburn  7479:         if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
                   7480:             $quota = $env{'environment.portfolioquota'};
1.536     raeburn  7481:             $inststatus = $env{'environment.inststatus'};
1.472     raeburn  7482:         } else {
1.536     raeburn  7483:             my %userenv = 
                   7484:                 &Apache::lonnet::get('environment',['portfolioquota',
                   7485:                                      'inststatus'],$udom,$uname);
1.472     raeburn  7486:             my ($tmp) = keys(%userenv);
                   7487:             if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   7488:                 $quota = $userenv{'portfolioquota'};
1.536     raeburn  7489:                 $inststatus = $userenv{'inststatus'};
1.472     raeburn  7490:             } else {
                   7491:                 undef(%userenv);
                   7492:             }
                   7493:         }
1.536     raeburn  7494:         ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472     raeburn  7495:         if ($quota eq '') {
1.536     raeburn  7496:             $quota = $defquota;
                   7497:             $quotatype = 'default';
                   7498:         } else {
                   7499:             $quotatype = 'custom';
1.472     raeburn  7500:         }
                   7501:     }
1.536     raeburn  7502:     if (wantarray) {
                   7503:         return ($quota,$quotatype,$settingstatus,$defquota);
                   7504:     } else {
                   7505:         return $quota;
                   7506:     }
1.472     raeburn  7507: }
                   7508: 
                   7509: ###############################################
                   7510: 
                   7511: =pod
                   7512: 
                   7513: =item * &default_quota()
                   7514: 
1.536     raeburn  7515: Retrieves default quota assigned for storage of user portfolio files,
                   7516: given an (optional) user's institutional status.
1.472     raeburn  7517: 
                   7518: Incoming parameters:
                   7519: 1. domain
1.536     raeburn  7520: 2. (Optional) institutional status(es).  This is a : separated list of 
                   7521:    status types (e.g., faculty, staff, student etc.)
                   7522:    which apply to the user for whom the default is being retrieved.
                   7523:    If the institutional status string in undefined, the domain
                   7524:    default quota will be returned. 
1.472     raeburn  7525: 
                   7526: Returns:
                   7527: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536     raeburn  7528: 2. (Optional) institutional type which determined the value of the
                   7529:    default quota.
1.472     raeburn  7530: 
                   7531: If a value has been stored in the domain's configuration db,
                   7532: it will return that, otherwise it returns 20 (for backwards 
                   7533: compatibility with domains which have not set up a configuration
                   7534: db file; the original statically defined portfolio quota was 20 Mb). 
                   7535: 
1.536     raeburn  7536: If the user's status includes multiple types (e.g., staff and student),
                   7537: the largest default quota which applies to the user determines the
                   7538: default quota returned.
                   7539: 
1.780     raeburn  7540: =back
                   7541: 
1.472     raeburn  7542: =cut
                   7543: 
                   7544: ###############################################
                   7545: 
                   7546: 
                   7547: sub default_quota {
1.536     raeburn  7548:     my ($udom,$inststatus) = @_;
                   7549:     my ($defquota,$settingstatus);
                   7550:     my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622     raeburn  7551:                                             ['quotas'],$udom);
                   7552:     if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536     raeburn  7553:         if ($inststatus ne '') {
1.765     raeburn  7554:             my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536     raeburn  7555:             foreach my $item (@statuses) {
1.711     raeburn  7556:                 if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7557:                     if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
                   7558:                         if ($defquota eq '') {
                   7559:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7560:                             $settingstatus = $item;
                   7561:                         } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
                   7562:                             $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
                   7563:                             $settingstatus = $item;
                   7564:                         }
                   7565:                     }
                   7566:                 } else {
                   7567:                     if ($quotahash{'quotas'}{$item} ne '') {
                   7568:                         if ($defquota eq '') {
                   7569:                             $defquota = $quotahash{'quotas'}{$item};
                   7570:                             $settingstatus = $item;
                   7571:                         } elsif ($quotahash{'quotas'}{$item} > $defquota) {
                   7572:                             $defquota = $quotahash{'quotas'}{$item};
                   7573:                             $settingstatus = $item;
                   7574:                         }
1.536     raeburn  7575:                     }
                   7576:                 }
                   7577:             }
                   7578:         }
                   7579:         if ($defquota eq '') {
1.711     raeburn  7580:             if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
                   7581:                 $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
                   7582:             } else {
                   7583:                 $defquota = $quotahash{'quotas'}{'default'};
                   7584:             }
1.536     raeburn  7585:             $settingstatus = 'default';
                   7586:         }
                   7587:     } else {
                   7588:         $settingstatus = 'default';
                   7589:         $defquota = 20;
                   7590:     }
                   7591:     if (wantarray) {
                   7592:         return ($defquota,$settingstatus);
1.472     raeburn  7593:     } else {
1.536     raeburn  7594:         return $defquota;
1.472     raeburn  7595:     }
                   7596: }
                   7597: 
1.384     raeburn  7598: sub get_secgrprole_info {
                   7599:     my ($cdom,$cnum,$needroles,$type)  = @_;
                   7600:     my %sections_count = &get_sections($cdom,$cnum);
                   7601:     my @sections =  (sort {$a <=> $b} keys(%sections_count));
                   7602:     my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
                   7603:     my @groups = sort(keys(%curr_groups));
                   7604:     my $allroles = [];
                   7605:     my $rolehash;
                   7606:     my $accesshash = {
                   7607:                      active => 'Currently has access',
                   7608:                      future => 'Will have future access',
                   7609:                      previous => 'Previously had access',
                   7610:                   };
                   7611:     if ($needroles) {
                   7612:         $rolehash = {'all' => 'all'};
1.385     albertel 7613:         my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
                   7614: 	if (&Apache::lonnet::error(%user_roles)) {
                   7615: 	    undef(%user_roles);
                   7616: 	}
                   7617:         foreach my $item (keys(%user_roles)) {
1.384     raeburn  7618:             my ($role)=split(/\:/,$item,2);
                   7619:             if ($role eq 'cr') { next; }
                   7620:             if ($role =~ /^cr/) {
                   7621:                 $$rolehash{$role} = (split('/',$role))[3];
                   7622:             } else {
                   7623:                 $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
                   7624:             }
                   7625:         }
                   7626:         foreach my $key (sort(keys(%{$rolehash}))) {
                   7627:             push(@{$allroles},$key);
                   7628:         }
                   7629:         push (@{$allroles},'st');
                   7630:         $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
                   7631:     }
                   7632:     return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
                   7633: }
                   7634: 
1.555     raeburn  7635: sub user_picker {
1.627     raeburn  7636:     my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555     raeburn  7637:     my $currdom = $dom;
                   7638:     my %curr_selected = (
                   7639:                         srchin => 'dom',
1.580     raeburn  7640:                         srchby => 'lastname',
1.555     raeburn  7641:                       );
                   7642:     my $srchterm;
1.625     raeburn  7643:     if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555     raeburn  7644:         if ($srch->{'srchby'} ne '') {
                   7645:             $curr_selected{'srchby'} = $srch->{'srchby'};
                   7646:         }
                   7647:         if ($srch->{'srchin'} ne '') {
                   7648:             $curr_selected{'srchin'} = $srch->{'srchin'};
                   7649:         }
                   7650:         if ($srch->{'srchtype'} ne '') {
                   7651:             $curr_selected{'srchtype'} = $srch->{'srchtype'};
                   7652:         }
                   7653:         if ($srch->{'srchdomain'} ne '') {
                   7654:             $currdom = $srch->{'srchdomain'};
                   7655:         }
                   7656:         $srchterm = $srch->{'srchterm'};
                   7657:     }
                   7658:     my %lt=&Apache::lonlocal::texthash(
1.573     raeburn  7659:                     'usr'       => 'Search criteria',
1.563     raeburn  7660:                     'doma'      => 'Domain/institution to search',
1.558     albertel 7661:                     'uname'     => 'username',
                   7662:                     'lastname'  => 'last name',
1.555     raeburn  7663:                     'lastfirst' => 'last name, first name',
1.558     albertel 7664:                     'crs'       => 'in this course',
1.576     raeburn  7665:                     'dom'       => 'in selected LON-CAPA domain', 
1.558     albertel 7666:                     'alc'       => 'all LON-CAPA',
1.573     raeburn  7667:                     'instd'     => 'in institutional directory for selected domain',
1.558     albertel 7668:                     'exact'     => 'is',
                   7669:                     'contains'  => 'contains',
1.569     raeburn  7670:                     'begins'    => 'begins with',
1.571     raeburn  7671:                     'youm'      => "You must include some text to search for.",
                   7672:                     'thte'      => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
                   7673:                     'thet'      => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
                   7674:                     'yomc'      => "You must choose a domain when using an institutional directory search.",
                   7675:                     'ymcd'      => "You must choose a domain when using a domain search.",
                   7676:                     'whus'      => "When using searching by last,first you must include a comma as separator between last name and first name.",
                   7677:                     'whse'      => "When searching by last,first you must include at least one character in the first name.",
                   7678:                      'thfo'     => "The following need to be corrected before the search can be run:",
1.555     raeburn  7679:                                        );
1.563     raeburn  7680:     my $domform = &select_dom_form($currdom,'srchdomain',1,1);
                   7681:     my $srchinsel = ' <select name="srchin">';
1.555     raeburn  7682: 
                   7683:     my @srchins = ('crs','dom','alc','instd');
                   7684: 
                   7685:     foreach my $option (@srchins) {
                   7686:         # FIXME 'alc' option unavailable until 
                   7687:         #       loncreateuser::print_user_query_page()
                   7688:         #       has been completed.
                   7689:         next if ($option eq 'alc');
1.880     raeburn  7690:         next if (($option eq 'crs') && ($env{'form.form'} eq 'requestcrs'));  
1.555     raeburn  7691:         next if ($option eq 'crs' && !$env{'request.course.id'});
1.563     raeburn  7692:         if ($curr_selected{'srchin'} eq $option) {
                   7693:             $srchinsel .= ' 
                   7694:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7695:         } else {
                   7696:             $srchinsel .= '
                   7697:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7698:         }
1.555     raeburn  7699:     }
1.563     raeburn  7700:     $srchinsel .= "\n  </select>\n";
1.555     raeburn  7701: 
                   7702:     my $srchbysel =  ' <select name="srchby">';
1.580     raeburn  7703:     foreach my $option ('lastname','lastfirst','uname') {
1.555     raeburn  7704:         if ($curr_selected{'srchby'} eq $option) {
                   7705:             $srchbysel .= '
                   7706:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7707:         } else {
                   7708:             $srchbysel .= '
                   7709:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7710:          }
                   7711:     }
                   7712:     $srchbysel .= "\n  </select>\n";
                   7713: 
                   7714:     my $srchtypesel = ' <select name="srchtype">';
1.580     raeburn  7715:     foreach my $option ('begins','contains','exact') {
1.555     raeburn  7716:         if ($curr_selected{'srchtype'} eq $option) {
                   7717:             $srchtypesel .= '
                   7718:    <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
                   7719:         } else {
                   7720:             $srchtypesel .= '
                   7721:    <option value="'.$option.'">'.$lt{$option}.'</option>';
                   7722:         }
                   7723:     }
                   7724:     $srchtypesel .= "\n  </select>\n";
                   7725: 
1.558     albertel 7726:     my ($newuserscript,$new_user_create);
1.556     raeburn  7727: 
                   7728:     if ($forcenewuser) {
1.576     raeburn  7729:         if (ref($srch) eq 'HASH') {
                   7730:             if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627     raeburn  7731:                 if ($cancreate) {
                   7732:                     $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>';
                   7733:                 } else {
1.799     bisitz   7734:                     my $helplink = 'javascript:helpMenu('."'display'".')';
1.627     raeburn  7735:                     my %usertypetext = (
                   7736:                         official   => 'institutional',
                   7737:                         unofficial => 'non-institutional',
                   7738:                     );
1.799     bisitz   7739:                     $new_user_create = '<p class="LC_warning">'
                   7740:                                       .&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.")
                   7741:                                       .' '
                   7742:                                       .&mt('Please contact the [_1]helpdesk[_2] for assistance.'
                   7743:                                           ,'<a href="'.$helplink.'">','</a>')
                   7744:                                       .'</p><br />';
1.627     raeburn  7745:                 }
1.576     raeburn  7746:             }
                   7747:         }
                   7748: 
1.556     raeburn  7749:         $newuserscript = <<"ENDSCRIPT";
                   7750: 
1.570     raeburn  7751: function setSearch(createnew,callingForm) {
1.556     raeburn  7752:     if (createnew == 1) {
1.570     raeburn  7753:         for (var i=0; i<callingForm.srchby.length; i++) {
                   7754:             if (callingForm.srchby.options[i].value == 'uname') {
                   7755:                 callingForm.srchby.selectedIndex = i;
1.556     raeburn  7756:             }
                   7757:         }
1.570     raeburn  7758:         for (var i=0; i<callingForm.srchin.length; i++) {
                   7759:             if ( callingForm.srchin.options[i].value == 'dom') {
                   7760: 		callingForm.srchin.selectedIndex = i;
1.556     raeburn  7761:             }
                   7762:         }
1.570     raeburn  7763:         for (var i=0; i<callingForm.srchtype.length; i++) {
                   7764:             if (callingForm.srchtype.options[i].value == 'exact') {
                   7765:                 callingForm.srchtype.selectedIndex = i;
1.556     raeburn  7766:             }
                   7767:         }
1.570     raeburn  7768:         for (var i=0; i<callingForm.srchdomain.length; i++) {
                   7769:             if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
                   7770:                 callingForm.srchdomain.selectedIndex = i;
1.556     raeburn  7771:             }
                   7772:         }
                   7773:     }
                   7774: }
                   7775: ENDSCRIPT
1.558     albertel 7776: 
1.556     raeburn  7777:     }
                   7778: 
1.555     raeburn  7779:     my $output = <<"END_BLOCK";
1.556     raeburn  7780: <script type="text/javascript">
1.824     bisitz   7781: // <![CDATA[
1.570     raeburn  7782: function validateEntry(callingForm) {
1.558     albertel 7783: 
1.556     raeburn  7784:     var checkok = 1;
1.558     albertel 7785:     var srchin;
1.570     raeburn  7786:     for (var i=0; i<callingForm.srchin.length; i++) {
                   7787: 	if ( callingForm.srchin[i].checked ) {
                   7788: 	    srchin = callingForm.srchin[i].value;
1.558     albertel 7789: 	}
                   7790:     }
                   7791: 
1.570     raeburn  7792:     var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
                   7793:     var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
                   7794:     var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
                   7795:     var srchterm =  callingForm.srchterm.value;
                   7796:     var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556     raeburn  7797:     var msg = "";
                   7798: 
                   7799:     if (srchterm == "") {
                   7800:         checkok = 0;
1.571     raeburn  7801:         msg += "$lt{'youm'}\\n";
1.556     raeburn  7802:     }
                   7803: 
1.569     raeburn  7804:     if (srchtype== 'begins') {
                   7805:         if (srchterm.length < 2) {
                   7806:             checkok = 0;
1.571     raeburn  7807:             msg += "$lt{'thte'}\\n";
1.569     raeburn  7808:         }
                   7809:     }
                   7810: 
1.556     raeburn  7811:     if (srchtype== 'contains') {
                   7812:         if (srchterm.length < 3) {
                   7813:             checkok = 0;
1.571     raeburn  7814:             msg += "$lt{'thet'}\\n";
1.556     raeburn  7815:         }
                   7816:     }
                   7817:     if (srchin == 'instd') {
                   7818:         if (srchdomain == '') {
                   7819:             checkok = 0;
1.571     raeburn  7820:             msg += "$lt{'yomc'}\\n";
1.556     raeburn  7821:         }
                   7822:     }
                   7823:     if (srchin == 'dom') {
                   7824:         if (srchdomain == '') {
                   7825:             checkok = 0;
1.571     raeburn  7826:             msg += "$lt{'ymcd'}\\n";
1.556     raeburn  7827:         }
                   7828:     }
                   7829:     if (srchby == 'lastfirst') {
                   7830:         if (srchterm.indexOf(",") == -1) {
                   7831:             checkok = 0;
1.571     raeburn  7832:             msg += "$lt{'whus'}\\n";
1.556     raeburn  7833:         }
                   7834:         if (srchterm.indexOf(",") == srchterm.length -1) {
                   7835:             checkok = 0;
1.571     raeburn  7836:             msg += "$lt{'whse'}\\n";
1.556     raeburn  7837:         }
                   7838:     }
                   7839:     if (checkok == 0) {
1.571     raeburn  7840:         alert("$lt{'thfo'}\\n"+msg);
1.556     raeburn  7841:         return;
                   7842:     }
                   7843:     if (checkok == 1) {
1.570     raeburn  7844:         callingForm.submit();
1.556     raeburn  7845:     }
                   7846: }
                   7847: 
                   7848: $newuserscript
                   7849: 
1.824     bisitz   7850: // ]]>
1.556     raeburn  7851: </script>
1.558     albertel 7852: 
                   7853: $new_user_create
                   7854: 
1.555     raeburn  7855: END_BLOCK
1.558     albertel 7856: 
1.876     raeburn  7857:     $output .= &Apache::lonhtmlcommon::start_pick_box().
                   7858:                &Apache::lonhtmlcommon::row_title($lt{'doma'}).
                   7859:                $domform.
                   7860:                &Apache::lonhtmlcommon::row_closure().
                   7861:                &Apache::lonhtmlcommon::row_title($lt{'usr'}).
                   7862:                $srchbysel.
                   7863:                $srchtypesel. 
                   7864:                '<input type="text" size="15" name="srchterm" value="'.$srchterm.'" />'.
                   7865:                $srchinsel.
                   7866:                &Apache::lonhtmlcommon::row_closure(1). 
                   7867:                &Apache::lonhtmlcommon::end_pick_box().
                   7868:                '<br />';
1.555     raeburn  7869:     return $output;
                   7870: }
                   7871: 
1.612     raeburn  7872: sub user_rule_check {
1.615     raeburn  7873:     my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612     raeburn  7874:     my $response;
                   7875:     if (ref($usershash) eq 'HASH') {
                   7876:         foreach my $user (keys(%{$usershash})) {
                   7877:             my ($uname,$udom) = split(/:/,$user);
                   7878:             next if ($udom eq '' || $uname eq '');
1.615     raeburn  7879:             my ($id,$newuser);
1.612     raeburn  7880:             if (ref($usershash->{$user}) eq 'HASH') {
1.615     raeburn  7881:                 $newuser = $usershash->{$user}->{'newuser'};
1.612     raeburn  7882:                 $id = $usershash->{$user}->{'id'};
                   7883:             }
                   7884:             my $inst_response;
                   7885:             if (ref($checks) eq 'HASH') {
                   7886:                 if (defined($checks->{'username'})) {
1.615     raeburn  7887:                     ($inst_response,%{$inst_results->{$user}}) = 
1.612     raeburn  7888:                         &Apache::lonnet::get_instuser($udom,$uname);
                   7889:                 } elsif (defined($checks->{'id'})) {
1.615     raeburn  7890:                     ($inst_response,%{$inst_results->{$user}}) =
1.612     raeburn  7891:                         &Apache::lonnet::get_instuser($udom,undef,$id);
                   7892:                 }
1.615     raeburn  7893:             } else {
                   7894:                 ($inst_response,%{$inst_results->{$user}}) =
                   7895:                     &Apache::lonnet::get_instuser($udom,$uname);
                   7896:                 return;
1.612     raeburn  7897:             }
1.615     raeburn  7898:             if (!$got_rules->{$udom}) {
1.612     raeburn  7899:                 my %domconfig = &Apache::lonnet::get_dom('configuration',
                   7900:                                                   ['usercreation'],$udom);
                   7901:                 if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615     raeburn  7902:                     foreach my $item ('username','id') {
1.612     raeburn  7903:                         if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
                   7904:                             $$curr_rules{$udom}{$item} = 
                   7905:                                 $domconfig{'usercreation'}{$item.'_rule'};
1.585     raeburn  7906:                         }
                   7907:                     }
                   7908:                 }
1.615     raeburn  7909:                 $got_rules->{$udom} = 1;  
1.585     raeburn  7910:             }
1.612     raeburn  7911:             foreach my $item (keys(%{$checks})) {
                   7912:                 if (ref($$curr_rules{$udom}) eq 'HASH') {
                   7913:                     if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
                   7914:                         if (@{$$curr_rules{$udom}{$item}} > 0) {
                   7915:                             my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
                   7916:                             foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
                   7917:                                 if ($rule_check{$rule}) {
                   7918:                                     $$rulematch{$user}{$item} = $rule;
                   7919:                                     if ($inst_response eq 'ok') {
1.615     raeburn  7920:                                         if (ref($inst_results) eq 'HASH') {
                   7921:                                             if (ref($inst_results->{$user}) eq 'HASH') {
                   7922:                                                 if (keys(%{$inst_results->{$user}}) == 0) {
                   7923:                                                     $$alerts{$item}{$udom}{$uname} = 1;
                   7924:                                                 }
1.612     raeburn  7925:                                             }
                   7926:                                         }
1.615     raeburn  7927:                                     }
                   7928:                                     last;
1.585     raeburn  7929:                                 }
                   7930:                             }
                   7931:                         }
                   7932:                     }
                   7933:                 }
                   7934:             }
                   7935:         }
                   7936:     }
1.612     raeburn  7937:     return;
                   7938: }
                   7939: 
                   7940: sub user_rule_formats {
                   7941:     my ($domain,$domdesc,$curr_rules,$check) = @_;
                   7942:     my %text = ( 
                   7943:                  'username' => 'Usernames',
                   7944:                  'id'       => 'IDs',
                   7945:                );
                   7946:     my $output;
                   7947:     my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
                   7948:     if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
                   7949:         if (@{$ruleorder} > 0) {
                   7950:             $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>';
                   7951:             foreach my $rule (@{$ruleorder}) {
                   7952:                 if (ref($curr_rules) eq 'ARRAY') {
                   7953:                     if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
                   7954:                         if (ref($rules->{$rule}) eq 'HASH') {
                   7955:                             $output .= '<li>'.$rules->{$rule}{'name'}.': '.
                   7956:                                         $rules->{$rule}{'desc'}.'</li>';
                   7957:                         }
                   7958:                     }
                   7959:                 }
                   7960:             }
                   7961:             $output .= '</ul>';
                   7962:         }
                   7963:     }
                   7964:     return $output;
                   7965: }
                   7966: 
                   7967: sub instrule_disallow_msg {
1.615     raeburn  7968:     my ($checkitem,$domdesc,$count,$mode) = @_;
1.612     raeburn  7969:     my $response;
                   7970:     my %text = (
                   7971:                   item   => 'username',
                   7972:                   items  => 'usernames',
                   7973:                   match  => 'matches',
                   7974:                   do     => 'does',
                   7975:                   action => 'a username',
                   7976:                   one    => 'one',
                   7977:                );
                   7978:     if ($count > 1) {
                   7979:         $text{'item'} = 'usernames';
                   7980:         $text{'match'} ='match';
                   7981:         $text{'do'} = 'do';
                   7982:         $text{'action'} = 'usernames',
                   7983:         $text{'one'} = 'ones';
                   7984:     }
                   7985:     if ($checkitem eq 'id') {
                   7986:         $text{'items'} = 'IDs';
                   7987:         $text{'item'} = 'ID';
                   7988:         $text{'action'} = 'an ID';
1.615     raeburn  7989:         if ($count > 1) {
                   7990:             $text{'item'} = 'IDs';
                   7991:             $text{'action'} = 'IDs';
                   7992:         }
1.612     raeburn  7993:     }
1.674     bisitz   7994:     $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  7995:     if ($mode eq 'upload') {
                   7996:         if ($checkitem eq 'username') {
                   7997:             $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'}.");
                   7998:         } elsif ($checkitem eq 'id') {
1.674     bisitz   7999:             $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  8000:         }
1.669     raeburn  8001:     } elsif ($mode eq 'selfcreate') {
                   8002:         if ($checkitem eq 'id') {
                   8003:             $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.");
                   8004:         }
1.615     raeburn  8005:     } else {
                   8006:         if ($checkitem eq 'username') {
                   8007:             $response .= &mt("You must choose $text{'action'} with a different format --  $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
                   8008:         } elsif ($checkitem eq 'id') {
                   8009:             $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.");
                   8010:         }
1.612     raeburn  8011:     }
                   8012:     return $response;
1.585     raeburn  8013: }
                   8014: 
1.624     raeburn  8015: sub personal_data_fieldtitles {
                   8016:     my %fieldtitles = &Apache::lonlocal::texthash (
                   8017:                         id => 'Student/Employee ID',
                   8018:                         permanentemail => 'E-mail address',
                   8019:                         lastname => 'Last Name',
                   8020:                         firstname => 'First Name',
                   8021:                         middlename => 'Middle Name',
                   8022:                         generation => 'Generation',
                   8023:                         gen => 'Generation',
1.765     raeburn  8024:                         inststatus => 'Affiliation',
1.624     raeburn  8025:                    );
                   8026:     return %fieldtitles;
                   8027: }
                   8028: 
1.642     raeburn  8029: sub sorted_inst_types {
                   8030:     my ($dom) = @_;
                   8031:     my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
                   8032:     my $othertitle = &mt('All users');
                   8033:     if ($env{'request.course.id'}) {
1.668     raeburn  8034:         $othertitle  = &mt('Any users');
1.642     raeburn  8035:     }
                   8036:     my @types;
                   8037:     if (ref($order) eq 'ARRAY') {
                   8038:         @types = @{$order};
                   8039:     }
                   8040:     if (@types == 0) {
                   8041:         if (ref($usertypes) eq 'HASH') {
                   8042:             @types = sort(keys(%{$usertypes}));
                   8043:         }
                   8044:     }
                   8045:     if (keys(%{$usertypes}) > 0) {
                   8046:         $othertitle = &mt('Other users');
                   8047:     }
                   8048:     return ($othertitle,$usertypes,\@types);
                   8049: }
                   8050: 
1.645     raeburn  8051: sub get_institutional_codes {
                   8052:     my ($settings,$allcourses,$LC_code) = @_;
                   8053: # Get complete list of course sections to update
                   8054:     my @currsections = ();
                   8055:     my @currxlists = ();
                   8056:     my $coursecode = $$settings{'internal.coursecode'};
                   8057: 
                   8058:     if ($$settings{'internal.sectionnums'} ne '') {
                   8059:         @currsections = split(/,/,$$settings{'internal.sectionnums'});
                   8060:     }
                   8061: 
                   8062:     if ($$settings{'internal.crosslistings'} ne '') {
                   8063:         @currxlists = split(/,/,$$settings{'internal.crosslistings'});
                   8064:     }
                   8065: 
                   8066:     if (@currxlists > 0) {
                   8067:         foreach (@currxlists) {
                   8068:             if (m/^([^:]+):(\w*)$/) {
                   8069:                 unless (grep/^$1$/,@{$allcourses}) {
                   8070:                     push @{$allcourses},$1;
                   8071:                     $$LC_code{$1} = $2;
                   8072:                 }
                   8073:             }
                   8074:         }
                   8075:     }
                   8076:  
                   8077:     if (@currsections > 0) {
                   8078:         foreach (@currsections) {
                   8079:             if (m/^(\w+):(\w*)$/) {
                   8080:                 my $sec = $coursecode.$1;
                   8081:                 my $lc_sec = $2;
                   8082:                 unless (grep/^$sec$/,@{$allcourses}) {
                   8083:                     push @{$allcourses},$sec;
                   8084:                     $$LC_code{$sec} = $lc_sec;
                   8085:                 }
                   8086:             }
                   8087:         }
                   8088:     }
                   8089:     return;
                   8090: }
                   8091: 
1.112     bowersj2 8092: =pod
                   8093: 
1.780     raeburn  8094: =head1 Slot Helpers
                   8095: 
                   8096: =over 4
                   8097: 
                   8098: =item * sorted_slots()
                   8099: 
                   8100: Sorts an array of slot names in order of slot start time (earliest first). 
                   8101: 
                   8102: Inputs:
                   8103: 
                   8104: =over 4
                   8105: 
                   8106: slotsarr  - Reference to array of unsorted slot names.
                   8107: 
                   8108: slots     - Reference to hash of hash, where outer hash keys are slot names.
                   8109: 
1.549     albertel 8110: =back
                   8111: 
1.780     raeburn  8112: Returns:
                   8113: 
                   8114: =over 4
                   8115: 
                   8116: sorted   - An array of slot names sorted by the start time of the slot.
                   8117: 
                   8118: =back
                   8119: 
                   8120: =back
                   8121: 
                   8122: =cut
                   8123: 
                   8124: 
                   8125: sub sorted_slots {
                   8126:     my ($slotsarr,$slots) = @_;
                   8127:     my @sorted;
                   8128:     if ((ref($slotsarr) eq 'ARRAY') && (ref($slots) eq 'HASH')) {
                   8129:         @sorted =
                   8130:             sort {
                   8131:                      if (ref($slots->{$a}) && ref($slots->{$b})) {
                   8132:                          return $slots->{$a}{'starttime'} <=> $slots->{$b}{'starttime'}
                   8133:                      }
                   8134:                      if (ref($slots->{$a})) { return -1;}
                   8135:                      if (ref($slots->{$b})) { return 1;}
                   8136:                      return 0;
                   8137:                  } @{$slotsarr};
                   8138:     }
                   8139:     return @sorted;
                   8140: }
                   8141: 
                   8142: 
                   8143: =pod
                   8144: 
1.549     albertel 8145: =head1 HTTP Helpers
                   8146: 
                   8147: =over 4
                   8148: 
1.648     raeburn  8149: =item * &get_unprocessed_cgi($query,$possible_names)
1.112     bowersj2 8150: 
1.258     albertel 8151: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112     bowersj2 8152: $query.  The parameters listed in $possible_names (an array reference),
1.258     albertel 8153: will be set in $env{'form.name'} if they do not already exist.
1.112     bowersj2 8154: 
                   8155: Typically called with $ENV{'QUERY_STRING'} as the first parameter.  
                   8156: $possible_names is an ref to an array of form element names.  As an example:
                   8157: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258     albertel 8158: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112     bowersj2 8159: 
                   8160: =cut
1.1       albertel 8161: 
1.6       albertel 8162: sub get_unprocessed_cgi {
1.25      albertel 8163:   my ($query,$possible_names)= @_;
1.26      matthew  8164:   # $Apache::lonxml::debug=1;
1.356     albertel 8165:   foreach my $pair (split(/&/,$query)) {
                   8166:     my ($name, $value) = split(/=/,$pair);
1.369     www      8167:     $name = &unescape($name);
1.25      albertel 8168:     if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
                   8169:       $value =~ tr/+/ /;
                   8170:       $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258     albertel 8171:       unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25      albertel 8172:     }
1.16      harris41 8173:   }
1.6       albertel 8174: }
                   8175: 
1.112     bowersj2 8176: =pod
                   8177: 
1.648     raeburn  8178: =item * &cacheheader() 
1.112     bowersj2 8179: 
                   8180: returns cache-controlling header code
                   8181: 
                   8182: =cut
                   8183: 
1.7       albertel 8184: sub cacheheader {
1.258     albertel 8185:     unless ($env{'request.method'} eq 'GET') { return ''; }
1.216     albertel 8186:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
                   8187:     my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7       albertel 8188:                 <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
                   8189:                 <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216     albertel 8190:     return $output;
1.7       albertel 8191: }
                   8192: 
1.112     bowersj2 8193: =pod
                   8194: 
1.648     raeburn  8195: =item * &no_cache($r) 
1.112     bowersj2 8196: 
                   8197: specifies header code to not have cache
                   8198: 
                   8199: =cut
                   8200: 
1.9       albertel 8201: sub no_cache {
1.216     albertel 8202:     my ($r) = @_;
                   8203:     if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258     albertel 8204: 	$env{'request.method'} ne 'GET') { return ''; }
1.216     albertel 8205:     my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
                   8206:     $r->no_cache(1);
                   8207:     $r->header_out("Expires" => $date);
                   8208:     $r->header_out("Pragma" => "no-cache");
1.123     www      8209: }
                   8210: 
                   8211: sub content_type {
1.181     albertel 8212:     my ($r,$type,$charset) = @_;
1.299     foxr     8213:     if ($r) {
                   8214: 	#  Note that printout.pl calls this with undef for $r.
                   8215: 	&no_cache($r);
                   8216:     }
1.258     albertel 8217:     if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181     albertel 8218:     unless ($charset) {
                   8219: 	$charset=&Apache::lonlocal::current_encoding;
                   8220:     }
                   8221:     if ($charset) { $type.='; charset='.$charset; }
                   8222:     if ($r) {
                   8223: 	$r->content_type($type);
                   8224:     } else {
                   8225: 	print("Content-type: $type\n\n");
                   8226:     }
1.9       albertel 8227: }
1.25      albertel 8228: 
1.112     bowersj2 8229: =pod
                   8230: 
1.648     raeburn  8231: =item * &add_to_env($name,$value) 
1.112     bowersj2 8232: 
1.258     albertel 8233: adds $name to the %env hash with value
1.112     bowersj2 8234: $value, if $name already exists, the entry is converted to an array
                   8235: reference and $value is added to the array.
                   8236: 
                   8237: =cut
                   8238: 
1.25      albertel 8239: sub add_to_env {
                   8240:   my ($name,$value)=@_;
1.258     albertel 8241:   if (defined($env{$name})) {
                   8242:     if (ref($env{$name})) {
1.25      albertel 8243:       #already have multiple values
1.258     albertel 8244:       push(@{ $env{$name} },$value);
1.25      albertel 8245:     } else {
                   8246:       #first time seeing multiple values, convert hash entry to an arrayref
1.258     albertel 8247:       my $first=$env{$name};
                   8248:       undef($env{$name});
                   8249:       push(@{ $env{$name} },$first,$value);
1.25      albertel 8250:     }
                   8251:   } else {
1.258     albertel 8252:     $env{$name}=$value;
1.25      albertel 8253:   }
1.31      albertel 8254: }
1.149     albertel 8255: 
                   8256: =pod
                   8257: 
1.648     raeburn  8258: =item * &get_env_multiple($name) 
1.149     albertel 8259: 
1.258     albertel 8260: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149     albertel 8261: values may be defined and end up as an array ref.
                   8262: 
                   8263: returns an array of values
                   8264: 
                   8265: =cut
                   8266: 
                   8267: sub get_env_multiple {
                   8268:     my ($name) = @_;
                   8269:     my @values;
1.258     albertel 8270:     if (defined($env{$name})) {
1.149     albertel 8271:         # exists is it an array
1.258     albertel 8272:         if (ref($env{$name})) {
                   8273:             @values=@{ $env{$name} };
1.149     albertel 8274:         } else {
1.258     albertel 8275:             $values[0]=$env{$name};
1.149     albertel 8276:         }
                   8277:     }
                   8278:     return(@values);
                   8279: }
                   8280: 
1.660     raeburn  8281: sub ask_for_embedded_content {
                   8282:     my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
                   8283:     my $upload_output = '
                   8284:    <form name="upload_embedded" action="'.$actionurl.'"
                   8285:                   method="post" enctype="multipart/form-data">';
                   8286:     $upload_output .= $state;
1.661     raeburn  8287:     $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660     raeburn  8288: 
                   8289:     my $num = 0;
                   8290:     foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
                   8291:         $upload_output .= &start_data_table_row().
                   8292:             '<td>'.$embed_file.'</td><td>';
                   8293:         if ($args->{'ignore_remote_references'}
                   8294:             && $embed_file =~ m{^\w+://}) {
                   8295:             $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
                   8296:         } elsif ($args->{'error_on_invalid_names'}
                   8297:             && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
                   8298: 
                   8299:             $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
                   8300: 
                   8301:         } else {
                   8302:             $upload_output .='
1.661     raeburn  8303:            <input name="embedded_item_'.$num.'" type="file" value="" />
1.660     raeburn  8304:            <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
                   8305:             my $attrib = join(':',@{$$allfiles{$embed_file}});
                   8306:             $upload_output .=
                   8307:                 "\n\t\t".
                   8308:                 '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
                   8309:                 $attrib.'" />';
                   8310:             if (exists($$codebase{$embed_file})) {
                   8311:                 $upload_output .=
                   8312:                     "\n\t\t".
                   8313:                     '<input name="codebase_'.$num.'" type="hidden" value="'.
                   8314:                     &escape($$codebase{$embed_file}).'" />';
                   8315:             }
                   8316:         }
                   8317:         $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
                   8318:         $num++;
                   8319:     }
                   8320:     $upload_output .= &Apache::loncommon::end_data_table().'<br />
                   8321:    <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
                   8322:    <input type ="submit" value="'.&mt('Upload Listed Files').'" />
                   8323:    '.&mt('(only files for which a location has been provided will be uploaded)').'
                   8324:    </form>';
                   8325:     return $upload_output;
                   8326: }
                   8327: 
1.661     raeburn  8328: sub upload_embedded {
                   8329:     my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
                   8330:         $current_disk_usage) = @_;
                   8331:     my $output;
                   8332:     for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
                   8333:         next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
                   8334:         my $orig_uploaded_filename =
                   8335:             $env{'form.embedded_item_'.$i.'.filename'};
                   8336: 
                   8337:         $env{'form.embedded_orig_'.$i} =
                   8338:             &unescape($env{'form.embedded_orig_'.$i});
                   8339:         my ($path,$fname) =
                   8340:             ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
                   8341:         # no path, whole string is fname
                   8342:         if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
                   8343: 
                   8344:         $path = $env{'form.currentpath'}.$path;
                   8345:         $fname = &Apache::lonnet::clean_filename($fname);
                   8346:         # See if there is anything left
                   8347:         next if ($fname eq '');
                   8348: 
                   8349:         # Check if file already exists as a file or directory.
                   8350:         my ($state,$msg);
                   8351:         if ($context eq 'portfolio') {
                   8352:             my $port_path = $dirpath;
                   8353:             if ($group ne '') {
                   8354:                 $port_path = "groups/$group/$port_path";
                   8355:             }
                   8356:             ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
                   8357:                                               $dir_root,$port_path,$disk_quota,
                   8358:                                               $current_disk_usage,$uname,$udom);
                   8359:             if ($state eq 'will_exceed_quota'
                   8360:                 || $state eq 'file_locked'
                   8361:                 || $state eq 'file_exists' ) {
                   8362:                 $output .= $msg;
                   8363:                 next;
                   8364:             }
                   8365:         } elsif (($context eq 'author') || ($context eq 'testbank')) {
                   8366:             ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
                   8367:             if ($state eq 'exists') {
                   8368:                 $output .= $msg;
                   8369:                 next;
                   8370:             }
                   8371:         }
                   8372:         # Check if extension is valid
                   8373:         if (($fname =~ /\.(\w+)$/) &&
                   8374:             (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
                   8375:             $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
                   8376:             next;
                   8377:         } elsif (($fname =~ /\.(\w+)$/) &&
                   8378:                  (!defined(&Apache::loncommon::fileembstyle($1)))) {
                   8379:             $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
                   8380:             next;
                   8381:         } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
                   8382:             $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
                   8383:             next;
                   8384:         }
                   8385: 
                   8386:         $env{'form.embedded_item_'.$i.'.filename'}=$fname;
                   8387:         if ($context eq 'portfolio') {
                   8388:             my $result=
                   8389:                 &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
                   8390:                                                 $dirpath.$path);
                   8391:             if ($result !~ m|^/uploaded/|) {
                   8392:                 $output .= '<span class="LC_error">'
                   8393:                       .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
                   8394:                            ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
                   8395:                       .'</span><br />';
                   8396:                 next;
                   8397:             } else {
                   8398:                 $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
                   8399:                            $path.$fname.'</span>').'</p>';     
                   8400:             }
                   8401:         } else {
                   8402: # Save the file
                   8403:             my $target = $env{'form.embedded_item_'.$i};
                   8404:             my $fullpath = $dir_root.$dirpath.'/'.$path;
                   8405:             my $dest = $fullpath.$fname;
                   8406:             my $url = $url_root.$dirpath.'/'.$path.$fname;
                   8407:             my @parts=split(/\//,$fullpath);
                   8408:             my $count;
                   8409:             my $filepath = $dir_root;
                   8410:             for ($count=4;$count<=$#parts;$count++) {
                   8411:                 $filepath .= "/$parts[$count]";
                   8412:                 if ((-e $filepath)!=1) {
                   8413:                     mkdir($filepath,0770);
                   8414:                 }
                   8415:             }
                   8416:             my $fh;
                   8417:             if (!open($fh,'>'.$dest)) {
                   8418:                 &Apache::lonnet::logthis('Failed to create '.$dest);
                   8419:                 $output .= '<span class="LC_error">'.
                   8420:                            &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8421:                            '</span><br />';
                   8422:             } else {
                   8423:                 if (!print $fh $env{'form.embedded_item_'.$i}) {
                   8424:                     &Apache::lonnet::logthis('Failed to write to '.$dest);
                   8425:                     $output .= '<span class="LC_error">'.
                   8426:                               &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
                   8427:                               '</span><br />';
                   8428:                 } else {
                   8429:                     if ($context eq 'testbank') {
                   8430:                         $output .= &mt('Embedded file uploaded successfully:').
                   8431:                                    '&nbsp;<a href="'.$url.'">'.
                   8432:                                    $orig_uploaded_filename.'</a><br />';
                   8433:                     } else {
1.705     tempelho 8434:                         $output .= '<span class=\"LC_fontsize_large\">'.
1.661     raeburn  8435:                                    &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705     tempelho 8436:                                    $orig_uploaded_filename.'</a>').'</span><br />';
1.661     raeburn  8437:                     }
                   8438:                 }
                   8439:                 close($fh);
                   8440:             }
                   8441:         }
                   8442:     }
                   8443:     return $output;
                   8444: }
                   8445: 
                   8446: sub check_for_existing {
                   8447:     my ($path,$fname,$element) = @_;
                   8448:     my ($state,$msg);
                   8449:     if (-d $path.'/'.$fname) {
                   8450:         $state = 'exists';
                   8451:         $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8452:     } elsif (-e $path.'/'.$fname) {
                   8453:         $state = 'exists';
                   8454:         $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
                   8455:     }
                   8456:     if ($state eq 'exists') {
                   8457:         $msg = '<span class="LC_error">'.$msg.'</span><br />';
                   8458:     }
                   8459:     return ($state,$msg);
                   8460: }
                   8461: 
                   8462: sub check_for_upload {
                   8463:     my ($path,$fname,$group,$element,$portfolio_root,$port_path,
                   8464:         $disk_quota,$current_disk_usage,$uname,$udom) = @_;
                   8465:     my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
                   8466:     my $getpropath = 1;
                   8467:     my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
                   8468:                                             $getpropath);
                   8469:     my $found_file = 0;
                   8470:     my $locked_file = 0;
                   8471:     foreach my $line (@dir_list) {
                   8472:         my ($file_name)=split(/\&/,$line,2);
                   8473:         if ($file_name eq $fname){
                   8474:             $file_name = $path.$file_name;
                   8475:             if ($group ne '') {
                   8476:                 $file_name = $group.$file_name;
                   8477:             }
                   8478:             $found_file = 1;
                   8479:             if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
                   8480:                 $locked_file = 1;
                   8481:             }
                   8482:         }
                   8483:     }
                   8484:     if (($current_disk_usage + $filesize) > $disk_quota){
                   8485:         my $msg = '<span class="LC_error">'.
                   8486:                 &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
                   8487:                   '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
                   8488:         return ('will_exceed_quota',$msg);
                   8489:     } elsif ($found_file) {
                   8490:         if ($locked_file) {
                   8491:             my $msg = '<span class="LC_error">';
                   8492:             $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>');
                   8493:             $msg .= '</span><br />';
                   8494:             $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
                   8495:             return ('file_locked',$msg);
                   8496:         } else {
                   8497:             my $msg = '<span class="LC_error">';
                   8498:             $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'});
                   8499:             $msg .= '</span>';
                   8500:             $msg .= '<br />';
                   8501:             $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
                   8502:             return ('file_exists',$msg);
                   8503:         }
                   8504:     }
                   8505: }
                   8506: 
1.31      albertel 8507: 
1.41      ng       8508: =pod
1.45      matthew  8509: 
1.464     albertel 8510: =back
1.41      ng       8511: 
1.112     bowersj2 8512: =head1 CSV Upload/Handling functions
1.38      albertel 8513: 
1.41      ng       8514: =over 4
                   8515: 
1.648     raeburn  8516: =item * &upfile_store($r)
1.41      ng       8517: 
                   8518: Store uploaded file, $r should be the HTTP Request object,
1.258     albertel 8519: needs $env{'form.upfile'}
1.41      ng       8520: returns $datatoken to be put into hidden field
                   8521: 
                   8522: =cut
1.31      albertel 8523: 
                   8524: sub upfile_store {
                   8525:     my $r=shift;
1.258     albertel 8526:     $env{'form.upfile'}=~s/\r/\n/gs;
                   8527:     $env{'form.upfile'}=~s/\f/\n/gs;
                   8528:     $env{'form.upfile'}=~s/\n+/\n/gs;
                   8529:     $env{'form.upfile'}=~s/\n+$//gs;
1.31      albertel 8530: 
1.258     albertel 8531:     my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
                   8532: 	'_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31      albertel 8533:     {
1.158     raeburn  8534:         my $datafile = $r->dir_config('lonDaemons').
                   8535:                            '/tmp/'.$datatoken.'.tmp';
                   8536:         if ( open(my $fh,">$datafile") ) {
1.258     albertel 8537:             print $fh $env{'form.upfile'};
1.158     raeburn  8538:             close($fh);
                   8539:         }
1.31      albertel 8540:     }
                   8541:     return $datatoken;
                   8542: }
                   8543: 
1.56      matthew  8544: =pod
                   8545: 
1.648     raeburn  8546: =item * &load_tmp_file($r)
1.41      ng       8547: 
                   8548: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258     albertel 8549: needs $env{'form.datatoken'},
                   8550: sets $env{'form.upfile'} to the contents of the file
1.41      ng       8551: 
                   8552: =cut
1.31      albertel 8553: 
                   8554: sub load_tmp_file {
                   8555:     my $r=shift;
                   8556:     my @studentdata=();
                   8557:     {
1.158     raeburn  8558:         my $studentfile = $r->dir_config('lonDaemons').
1.258     albertel 8559:                               '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158     raeburn  8560:         if ( open(my $fh,"<$studentfile") ) {
                   8561:             @studentdata=<$fh>;
                   8562:             close($fh);
                   8563:         }
1.31      albertel 8564:     }
1.258     albertel 8565:     $env{'form.upfile'}=join('',@studentdata);
1.31      albertel 8566: }
                   8567: 
1.56      matthew  8568: =pod
                   8569: 
1.648     raeburn  8570: =item * &upfile_record_sep()
1.41      ng       8571: 
                   8572: Separate uploaded file into records
                   8573: returns array of records,
1.258     albertel 8574: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41      ng       8575: 
                   8576: =cut
1.31      albertel 8577: 
                   8578: sub upfile_record_sep {
1.258     albertel 8579:     if ($env{'form.upfiletype'} eq 'xml') {
1.31      albertel 8580:     } else {
1.248     albertel 8581: 	my @records;
1.258     albertel 8582: 	foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248     albertel 8583: 	    if ($line=~/^\s*$/) { next; }
                   8584: 	    push(@records,$line);
                   8585: 	}
                   8586: 	return @records;
1.31      albertel 8587:     }
                   8588: }
                   8589: 
1.56      matthew  8590: =pod
                   8591: 
1.648     raeburn  8592: =item * &record_sep($record)
1.41      ng       8593: 
1.258     albertel 8594: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41      ng       8595: 
                   8596: =cut
                   8597: 
1.263     www      8598: sub takeleft {
                   8599:     my $index=shift;
                   8600:     return substr('0000'.$index,-4,4);
                   8601: }
                   8602: 
1.31      albertel 8603: sub record_sep {
                   8604:     my $record=shift;
                   8605:     my %components=();
1.258     albertel 8606:     if ($env{'form.upfiletype'} eq 'xml') {
                   8607:     } elsif ($env{'form.upfiletype'} eq 'space') {
1.31      albertel 8608:         my $i=0;
1.356     albertel 8609:         foreach my $field (split(/\s+/,$record)) {
1.31      albertel 8610:             $field=~s/^(\"|\')//;
                   8611:             $field=~s/(\"|\')$//;
1.263     www      8612:             $components{&takeleft($i)}=$field;
1.31      albertel 8613:             $i++;
                   8614:         }
1.258     albertel 8615:     } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31      albertel 8616:         my $i=0;
1.356     albertel 8617:         foreach my $field (split(/\t/,$record)) {
1.31      albertel 8618:             $field=~s/^(\"|\')//;
                   8619:             $field=~s/(\"|\')$//;
1.263     www      8620:             $components{&takeleft($i)}=$field;
1.31      albertel 8621:             $i++;
                   8622:         }
                   8623:     } else {
1.561     www      8624:         my $separator=',';
1.480     banghart 8625:         if ($env{'form.upfiletype'} eq 'semisv') {
1.561     www      8626:             $separator=';';
1.480     banghart 8627:         }
1.31      albertel 8628:         my $i=0;
1.561     www      8629: # the character we are looking for to indicate the end of a quote or a record 
                   8630:         my $looking_for=$separator;
                   8631: # do not add the characters to the fields
                   8632:         my $ignore=0;
                   8633: # we just encountered a separator (or the beginning of the record)
                   8634:         my $just_found_separator=1;
                   8635: # store the field we are working on here
                   8636:         my $field='';
                   8637: # work our way through all characters in record
                   8638:         foreach my $character ($record=~/(.)/g) {
                   8639:             if ($character eq $looking_for) {
                   8640:                if ($character ne $separator) {
                   8641: # Found the end of a quote, again looking for separator
                   8642:                   $looking_for=$separator;
                   8643:                   $ignore=1;
                   8644:                } else {
                   8645: # Found a separator, store away what we got
                   8646:                   $components{&takeleft($i)}=$field;
                   8647: 	          $i++;
                   8648:                   $just_found_separator=1;
                   8649:                   $ignore=0;
                   8650:                   $field='';
                   8651:                }
                   8652:                next;
                   8653:             }
                   8654: # single or double quotation marks after a separator indicate beginning of a quote
                   8655: # we are now looking for the end of the quote and need to ignore separators
                   8656:             if ((($character eq '"') || ($character eq "'")) && ($just_found_separator))  {
                   8657:                $looking_for=$character;
                   8658:                next;
                   8659:             }
                   8660: # ignore would be true after we reached the end of a quote
                   8661:             if ($ignore) { next; }
                   8662:             if (($just_found_separator) && ($character=~/\s/)) { next; }
                   8663:             $field.=$character;
                   8664:             $just_found_separator=0; 
1.31      albertel 8665:         }
1.561     www      8666: # catch the very last entry, since we never encountered the separator
                   8667:         $components{&takeleft($i)}=$field;
1.31      albertel 8668:     }
                   8669:     return %components;
                   8670: }
                   8671: 
1.144     matthew  8672: ######################################################
                   8673: ######################################################
                   8674: 
1.56      matthew  8675: =pod
                   8676: 
1.648     raeburn  8677: =item * &upfile_select_html()
1.41      ng       8678: 
1.144     matthew  8679: Return HTML code to select a file from the users machine and specify 
                   8680: the file type.
1.41      ng       8681: 
                   8682: =cut
                   8683: 
1.144     matthew  8684: ######################################################
                   8685: ######################################################
1.31      albertel 8686: sub upfile_select_html {
1.144     matthew  8687:     my %Types = (
                   8688:                  csv   => &mt('CSV (comma separated values, spreadsheet)'),
1.480     banghart 8689:                  semisv => &mt('Semicolon separated values'),
1.144     matthew  8690:                  space => &mt('Space separated'),
                   8691:                  tab   => &mt('Tabulator separated'),
                   8692: #                 xml   => &mt('HTML/XML'),
                   8693:                  );
                   8694:     my $Str = '<input type="file" name="upfile" size="50" />'.
1.727     riegler  8695:         '<br />'.&mt('Type').': <select name="upfiletype">';
1.144     matthew  8696:     foreach my $type (sort(keys(%Types))) {
                   8697:         $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
                   8698:     }
                   8699:     $Str .= "</select>\n";
                   8700:     return $Str;
1.31      albertel 8701: }
                   8702: 
1.301     albertel 8703: sub get_samples {
                   8704:     my ($records,$toget) = @_;
                   8705:     my @samples=({});
                   8706:     my $got=0;
                   8707:     foreach my $rec (@$records) {
                   8708: 	my %temp = &record_sep($rec);
                   8709: 	if (! grep(/\S/, values(%temp))) { next; }
                   8710: 	if (%temp) {
                   8711: 	    $samples[$got]=\%temp;
                   8712: 	    $got++;
                   8713: 	    if ($got == $toget) { last; }
                   8714: 	}
                   8715:     }
                   8716:     return \@samples;
                   8717: }
                   8718: 
1.144     matthew  8719: ######################################################
                   8720: ######################################################
                   8721: 
1.56      matthew  8722: =pod
                   8723: 
1.648     raeburn  8724: =item * &csv_print_samples($r,$records)
1.41      ng       8725: 
                   8726: Prints a table of sample values from each column uploaded $r is an
                   8727: Apache Request ref, $records is an arrayref from
                   8728: &Apache::loncommon::upfile_record_sep
                   8729: 
                   8730: =cut
                   8731: 
1.144     matthew  8732: ######################################################
                   8733: ######################################################
1.31      albertel 8734: sub csv_print_samples {
                   8735:     my ($r,$records) = @_;
1.662     bisitz   8736:     my $samples = &get_samples($records,5);
1.301     albertel 8737: 
1.594     raeburn  8738:     $r->print(&mt('Samples').'<br />'.&start_data_table().
                   8739:               &start_data_table_header_row());
1.356     albertel 8740:     foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) { 
1.845     bisitz   8741:         $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594     raeburn  8742:     $r->print(&end_data_table_header_row());
1.301     albertel 8743:     foreach my $hash (@$samples) {
1.594     raeburn  8744: 	$r->print(&start_data_table_row());
1.356     albertel 8745: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31      albertel 8746: 	    $r->print('<td>');
1.356     albertel 8747: 	    if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31      albertel 8748: 	    $r->print('</td>');
                   8749: 	}
1.594     raeburn  8750: 	$r->print(&end_data_table_row());
1.31      albertel 8751:     }
1.594     raeburn  8752:     $r->print(&end_data_table().'<br />'."\n");
1.31      albertel 8753: }
                   8754: 
1.144     matthew  8755: ######################################################
                   8756: ######################################################
                   8757: 
1.56      matthew  8758: =pod
                   8759: 
1.648     raeburn  8760: =item * &csv_print_select_table($r,$records,$d)
1.41      ng       8761: 
                   8762: Prints a table to create associations between values and table columns.
1.144     matthew  8763: 
1.41      ng       8764: $r is an Apache Request ref,
                   8765: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174     matthew  8766: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41      ng       8767: 
                   8768: =cut
                   8769: 
1.144     matthew  8770: ######################################################
                   8771: ######################################################
1.31      albertel 8772: sub csv_print_select_table {
                   8773:     my ($r,$records,$d) = @_;
1.301     albertel 8774:     my $i=0;
                   8775:     my $samples = &get_samples($records,1);
1.144     matthew  8776:     $r->print(&mt('Associate columns with student attributes.')."\n".
1.594     raeburn  8777: 	      &start_data_table().&start_data_table_header_row().
1.144     matthew  8778:               '<th>'.&mt('Attribute').'</th>'.
1.594     raeburn  8779:               '<th>'.&mt('Column').'</th>'.
                   8780:               &end_data_table_header_row()."\n");
1.356     albertel 8781:     foreach my $array_ref (@$d) {
                   8782: 	my ($value,$display,$defaultcol)=@{ $array_ref };
1.729     raeburn  8783: 	$r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31      albertel 8784: 
1.875     bisitz   8785: 	$r->print('<td><select name="f'.$i.'"'.
1.32      matthew  8786: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.31      albertel 8787: 	$r->print('<option value="none"></option>');
1.356     albertel 8788: 	foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
                   8789: 	    $r->print('<option value="'.$sample.'"'.
                   8790:                       ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662     bisitz   8791:                       '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31      albertel 8792: 	}
1.594     raeburn  8793: 	$r->print('</select></td>'.&end_data_table_row()."\n");
1.31      albertel 8794: 	$i++;
                   8795:     }
1.594     raeburn  8796:     $r->print(&end_data_table());
1.31      albertel 8797:     $i--;
                   8798:     return $i;
                   8799: }
1.56      matthew  8800: 
1.144     matthew  8801: ######################################################
                   8802: ######################################################
                   8803: 
1.56      matthew  8804: =pod
1.31      albertel 8805: 
1.648     raeburn  8806: =item * &csv_samples_select_table($r,$records,$d)
1.41      ng       8807: 
                   8808: Prints a table of sample values from the upload and can make associate samples to internal names.
                   8809: 
                   8810: $r is an Apache Request ref,
                   8811: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
                   8812: $d is an array of 2 element arrays (internal name, displayed name)
                   8813: 
                   8814: =cut
                   8815: 
1.144     matthew  8816: ######################################################
                   8817: ######################################################
1.31      albertel 8818: sub csv_samples_select_table {
                   8819:     my ($r,$records,$d) = @_;
                   8820:     my $i=0;
1.144     matthew  8821:     #
1.662     bisitz   8822:     my $max_samples = 5;
                   8823:     my $samples = &get_samples($records,$max_samples);
1.594     raeburn  8824:     $r->print(&start_data_table().
                   8825:               &start_data_table_header_row().'<th>'.
                   8826:               &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
                   8827:               &end_data_table_header_row());
1.301     albertel 8828: 
                   8829:     foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594     raeburn  8830: 	$r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32      matthew  8831: 		  ' onchange="javascript:flip(this.form,'.$i.');">');
1.301     albertel 8832: 	foreach my $option (@$d) {
                   8833: 	    my ($value,$display,$defaultcol)=@{ $option };
1.174     matthew  8834: 	    $r->print('<option value="'.$value.'"'.
1.253     albertel 8835:                       ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174     matthew  8836:                       $display.'</option>');
1.31      albertel 8837: 	}
                   8838: 	$r->print('</select></td><td>');
1.662     bisitz   8839: 	foreach my $line (0..($max_samples-1)) {
1.301     albertel 8840: 	    if (defined($samples->[$line]{$key})) { 
                   8841: 		$r->print($samples->[$line]{$key}."<br />\n"); 
                   8842: 	    }
                   8843: 	}
1.594     raeburn  8844: 	$r->print('</td>'.&end_data_table_row());
1.31      albertel 8845: 	$i++;
                   8846:     }
1.594     raeburn  8847:     $r->print(&end_data_table());
1.31      albertel 8848:     $i--;
                   8849:     return($i);
1.115     matthew  8850: }
                   8851: 
1.144     matthew  8852: ######################################################
                   8853: ######################################################
                   8854: 
1.115     matthew  8855: =pod
                   8856: 
1.648     raeburn  8857: =item * &clean_excel_name($name)
1.115     matthew  8858: 
                   8859: Returns a replacement for $name which does not contain any illegal characters.
                   8860: 
                   8861: =cut
                   8862: 
1.144     matthew  8863: ######################################################
                   8864: ######################################################
1.115     matthew  8865: sub clean_excel_name {
                   8866:     my ($name) = @_;
                   8867:     $name =~ s/[:\*\?\/\\]//g;
                   8868:     if (length($name) > 31) {
                   8869:         $name = substr($name,0,31);
                   8870:     }
                   8871:     return $name;
1.25      albertel 8872: }
1.84      albertel 8873: 
1.85      albertel 8874: =pod
                   8875: 
1.648     raeburn  8876: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85      albertel 8877: 
                   8878: Returns either 1 or undef
                   8879: 
                   8880: 1 if the part is to be hidden, undef if it is to be shown
                   8881: 
                   8882: Arguments are:
                   8883: 
                   8884: $id the id of the part to be checked
                   8885: $symb, optional the symb of the resource to check
                   8886: $udom, optional the domain of the user to check for
                   8887: $uname, optional the username of the user to check for
                   8888: 
                   8889: =cut
1.84      albertel 8890: 
                   8891: sub check_if_partid_hidden {
                   8892:     my ($id,$symb,$udom,$uname) = @_;
1.133     albertel 8893:     my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84      albertel 8894: 					 $symb,$udom,$uname);
1.141     albertel 8895:     my $truth=1;
                   8896:     #if the string starts with !, then the list is the list to show not hide
                   8897:     if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84      albertel 8898:     my @hiddenlist=split(/,/,$hiddenparts);
                   8899:     foreach my $checkid (@hiddenlist) {
1.141     albertel 8900: 	if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84      albertel 8901:     }
1.141     albertel 8902:     return !$truth;
1.84      albertel 8903: }
1.127     matthew  8904: 
1.138     matthew  8905: 
                   8906: ############################################################
                   8907: ############################################################
                   8908: 
                   8909: =pod
                   8910: 
1.157     matthew  8911: =back 
                   8912: 
1.138     matthew  8913: =head1 cgi-bin script and graphing routines
                   8914: 
1.157     matthew  8915: =over 4
                   8916: 
1.648     raeburn  8917: =item * &get_cgi_id()
1.138     matthew  8918: 
                   8919: Inputs: none
                   8920: 
                   8921: Returns an id which can be used to pass environment variables
                   8922: to various cgi-bin scripts.  These environment variables will
                   8923: be removed from the users environment after a given time by
                   8924: the routine &Apache::lonnet::transfer_profile_to_env.
                   8925: 
                   8926: =cut
                   8927: 
                   8928: ############################################################
                   8929: ############################################################
1.152     albertel 8930: my $uniq=0;
1.136     matthew  8931: sub get_cgi_id {
1.154     albertel 8932:     $uniq=($uniq+1)%100000;
1.280     albertel 8933:     return (time.'_'.$$.'_'.$uniq);
1.136     matthew  8934: }
                   8935: 
1.127     matthew  8936: ############################################################
                   8937: ############################################################
                   8938: 
                   8939: =pod
                   8940: 
1.648     raeburn  8941: =item * &DrawBarGraph()
1.127     matthew  8942: 
1.138     matthew  8943: Facilitates the plotting of data in a (stacked) bar graph.
                   8944: Puts plot definition data into the users environment in order for 
                   8945: graph.png to plot it.  Returns an <img> tag for the plot.
                   8946: The bars on the plot are labeled '1','2',...,'n'.
                   8947: 
                   8948: Inputs:
                   8949: 
                   8950: =over 4
                   8951: 
                   8952: =item $Title: string, the title of the plot
                   8953: 
                   8954: =item $xlabel: string, text describing the X-axis of the plot
                   8955: 
                   8956: =item $ylabel: string, text describing the Y-axis of the plot
                   8957: 
                   8958: =item $Max: scalar, the maximum Y value to use in the plot
                   8959: If $Max is < any data point, the graph will not be rendered.
                   8960: 
1.140     matthew  8961: =item $colors: array ref holding the colors to be used for the data sets when
1.138     matthew  8962: they are plotted.  If undefined, default values will be used.
                   8963: 
1.178     matthew  8964: =item $labels: array ref holding the labels to use on the x-axis for the bars.
                   8965: 
1.138     matthew  8966: =item @Values: An array of array references.  Each array reference holds data
                   8967: to be plotted in a stacked bar chart.
                   8968: 
1.239     matthew  8969: =item If the final element of @Values is a hash reference the key/value
                   8970: pairs will be added to the graph definition.
                   8971: 
1.138     matthew  8972: =back
                   8973: 
                   8974: Returns:
                   8975: 
                   8976: An <img> tag which references graph.png and the appropriate identifying
                   8977: information for the plot.
                   8978: 
1.127     matthew  8979: =cut
                   8980: 
                   8981: ############################################################
                   8982: ############################################################
1.134     matthew  8983: sub DrawBarGraph {
1.178     matthew  8984:     my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134     matthew  8985:     #
                   8986:     if (! defined($colors)) {
                   8987:         $colors = ['#33ff00', 
                   8988:                   '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
                   8989:                   '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
                   8990:                   ]; 
                   8991:     }
1.228     matthew  8992:     my $extra_settings = {};
                   8993:     if (ref($Values[-1]) eq 'HASH') {
                   8994:         $extra_settings = pop(@Values);
                   8995:     }
1.127     matthew  8996:     #
1.136     matthew  8997:     my $identifier = &get_cgi_id();
                   8998:     my $id = 'cgi.'.$identifier;        
1.129     matthew  8999:     if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127     matthew  9000:         return '';
                   9001:     }
1.225     matthew  9002:     #
                   9003:     my @Labels;
                   9004:     if (defined($labels)) {
                   9005:         @Labels = @$labels;
                   9006:     } else {
                   9007:         for (my $i=0;$i<@{$Values[0]};$i++) {
                   9008:             push (@Labels,$i+1);
                   9009:         }
                   9010:     }
                   9011:     #
1.129     matthew  9012:     my $NumBars = scalar(@{$Values[0]});
1.225     matthew  9013:     if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129     matthew  9014:     my %ValuesHash;
                   9015:     my $NumSets=1;
                   9016:     foreach my $array (@Values) {
                   9017:         next if (! ref($array));
1.136     matthew  9018:         $ValuesHash{$id.'.data.'.$NumSets++} = 
1.132     matthew  9019:             join(',',@$array);
1.129     matthew  9020:     }
1.127     matthew  9021:     #
1.136     matthew  9022:     my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225     matthew  9023:     if ($NumBars < 3) {
                   9024:         $width = 120+$NumBars*32;
1.220     matthew  9025:         $xskip = 1;
1.225     matthew  9026:         $bar_width = 30;
                   9027:     } elsif ($NumBars < 5) {
                   9028:         $width = 120+$NumBars*20;
                   9029:         $xskip = 1;
                   9030:         $bar_width = 20;
1.220     matthew  9031:     } elsif ($NumBars < 10) {
1.136     matthew  9032:         $width = 120+$NumBars*15;
                   9033:         $xskip = 1;
                   9034:         $bar_width = 15;
                   9035:     } elsif ($NumBars <= 25) {
                   9036:         $width = 120+$NumBars*11;
                   9037:         $xskip = 5;
                   9038:         $bar_width = 8;
                   9039:     } elsif ($NumBars <= 50) {
                   9040:         $width = 120+$NumBars*8;
                   9041:         $xskip = 5;
                   9042:         $bar_width = 4;
                   9043:     } else {
                   9044:         $width = 120+$NumBars*8;
                   9045:         $xskip = 5;
                   9046:         $bar_width = 4;
                   9047:     }
                   9048:     #
1.137     matthew  9049:     $Max = 1 if ($Max < 1);
                   9050:     if ( int($Max) < $Max ) {
                   9051:         $Max++;
                   9052:         $Max = int($Max);
                   9053:     }
1.127     matthew  9054:     $Title  = '' if (! defined($Title));
                   9055:     $xlabel = '' if (! defined($xlabel));
                   9056:     $ylabel = '' if (! defined($ylabel));
1.369     www      9057:     $ValuesHash{$id.'.title'}    = &escape($Title);
                   9058:     $ValuesHash{$id.'.xlabel'}   = &escape($xlabel);
                   9059:     $ValuesHash{$id.'.ylabel'}   = &escape($ylabel);
1.137     matthew  9060:     $ValuesHash{$id.'.y_max_value'} = $Max;
1.136     matthew  9061:     $ValuesHash{$id.'.NumBars'}  = $NumBars;
                   9062:     $ValuesHash{$id.'.NumSets'}  = $NumSets;
                   9063:     $ValuesHash{$id.'.PlotType'} = 'bar';
                   9064:     $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9065:     $ValuesHash{$id.'.height'}   = $height;
                   9066:     $ValuesHash{$id.'.width'}    = $width;
                   9067:     $ValuesHash{$id.'.xskip'}    = $xskip;
                   9068:     $ValuesHash{$id.'.bar_width'} = $bar_width;
                   9069:     $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127     matthew  9070:     #
1.228     matthew  9071:     # Deal with other parameters
                   9072:     while (my ($key,$value) = each(%$extra_settings)) {
                   9073:         $ValuesHash{$id.'.'.$key} = $value;
                   9074:     }
                   9075:     #
1.646     raeburn  9076:     &Apache::lonnet::appenv(\%ValuesHash);
1.137     matthew  9077:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9078: }
                   9079: 
                   9080: ############################################################
                   9081: ############################################################
                   9082: 
                   9083: =pod
                   9084: 
1.648     raeburn  9085: =item * &DrawXYGraph()
1.137     matthew  9086: 
1.138     matthew  9087: Facilitates the plotting of data in an XY graph.
                   9088: Puts plot definition data into the users environment in order for 
                   9089: graph.png to plot it.  Returns an <img> tag for the plot.
                   9090: 
                   9091: Inputs:
                   9092: 
                   9093: =over 4
                   9094: 
                   9095: =item $Title: string, the title of the plot
                   9096: 
                   9097: =item $xlabel: string, text describing the X-axis of the plot
                   9098: 
                   9099: =item $ylabel: string, text describing the Y-axis of the plot
                   9100: 
                   9101: =item $Max: scalar, the maximum Y value to use in the plot
                   9102: If $Max is < any data point, the graph will not be rendered.
                   9103: 
                   9104: =item $colors: Array ref containing the hex color codes for the data to be 
                   9105: plotted in.  If undefined, default values will be used.
                   9106: 
                   9107: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9108: 
                   9109: =item $Ydata: Array ref containing Array refs.  
1.185     www      9110: Each of the contained arrays will be plotted as a separate curve.
1.138     matthew  9111: 
                   9112: =item %Values: hash indicating or overriding any default values which are 
                   9113: passed to graph.png.  
                   9114: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9115: 
                   9116: =back
                   9117: 
                   9118: Returns:
                   9119: 
                   9120: An <img> tag which references graph.png and the appropriate identifying
                   9121: information for the plot.
                   9122: 
1.137     matthew  9123: =cut
                   9124: 
                   9125: ############################################################
                   9126: ############################################################
                   9127: sub DrawXYGraph {
                   9128:     my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
                   9129:     #
                   9130:     # Create the identifier for the graph
                   9131:     my $identifier = &get_cgi_id();
                   9132:     my $id = 'cgi.'.$identifier;
                   9133:     #
                   9134:     $Title  = '' if (! defined($Title));
                   9135:     $xlabel = '' if (! defined($xlabel));
                   9136:     $ylabel = '' if (! defined($ylabel));
                   9137:     my %ValuesHash = 
                   9138:         (
1.369     www      9139:          $id.'.title'  => &escape($Title),
                   9140:          $id.'.xlabel' => &escape($xlabel),
                   9141:          $id.'.ylabel' => &escape($ylabel),
1.137     matthew  9142:          $id.'.y_max_value'=> $Max,
                   9143:          $id.'.labels'     => join(',',@$Xlabels),
                   9144:          $id.'.PlotType'   => 'XY',
                   9145:          );
                   9146:     #
                   9147:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9148:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9149:     }
                   9150:     #
                   9151:     if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
                   9152:         return '';
                   9153:     }
                   9154:     my $NumSets=1;
1.138     matthew  9155:     foreach my $array (@{$Ydata}){
1.137     matthew  9156:         next if (! ref($array));
                   9157:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
                   9158:     }
1.138     matthew  9159:     $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137     matthew  9160:     #
                   9161:     # Deal with other parameters
                   9162:     while (my ($key,$value) = each(%Values)) {
                   9163:         $ValuesHash{$id.'.'.$key} = $value;
1.127     matthew  9164:     }
                   9165:     #
1.646     raeburn  9166:     &Apache::lonnet::appenv(\%ValuesHash);
1.136     matthew  9167:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
                   9168: }
                   9169: 
                   9170: ############################################################
                   9171: ############################################################
                   9172: 
                   9173: =pod
                   9174: 
1.648     raeburn  9175: =item * &DrawXYYGraph()
1.138     matthew  9176: 
                   9177: Facilitates the plotting of data in an XY graph with two Y axes.
                   9178: Puts plot definition data into the users environment in order for 
                   9179: graph.png to plot it.  Returns an <img> tag for the plot.
                   9180: 
                   9181: Inputs:
                   9182: 
                   9183: =over 4
                   9184: 
                   9185: =item $Title: string, the title of the plot
                   9186: 
                   9187: =item $xlabel: string, text describing the X-axis of the plot
                   9188: 
                   9189: =item $ylabel: string, text describing the Y-axis of the plot
                   9190: 
                   9191: =item $colors: Array ref containing the hex color codes for the data to be 
                   9192: plotted in.  If undefined, default values will be used.
                   9193: 
                   9194: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
                   9195: 
                   9196: =item $Ydata1: The first data set
                   9197: 
                   9198: =item $Min1: The minimum value of the left Y-axis
                   9199: 
                   9200: =item $Max1: The maximum value of the left Y-axis
                   9201: 
                   9202: =item $Ydata2: The second data set
                   9203: 
                   9204: =item $Min2: The minimum value of the right Y-axis
                   9205: 
                   9206: =item $Max2: The maximum value of the left Y-axis
                   9207: 
                   9208: =item %Values: hash indicating or overriding any default values which are 
                   9209: passed to graph.png.  
                   9210: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
                   9211: 
                   9212: =back
                   9213: 
                   9214: Returns:
                   9215: 
                   9216: An <img> tag which references graph.png and the appropriate identifying
                   9217: information for the plot.
1.136     matthew  9218: 
                   9219: =cut
                   9220: 
                   9221: ############################################################
                   9222: ############################################################
1.137     matthew  9223: sub DrawXYYGraph {
                   9224:     my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
                   9225:                                         $Ydata2,$Min2,$Max2,%Values)=@_;
1.136     matthew  9226:     #
                   9227:     # Create the identifier for the graph
                   9228:     my $identifier = &get_cgi_id();
                   9229:     my $id = 'cgi.'.$identifier;
                   9230:     #
                   9231:     $Title  = '' if (! defined($Title));
                   9232:     $xlabel = '' if (! defined($xlabel));
                   9233:     $ylabel = '' if (! defined($ylabel));
                   9234:     my %ValuesHash = 
                   9235:         (
1.369     www      9236:          $id.'.title'  => &escape($Title),
                   9237:          $id.'.xlabel' => &escape($xlabel),
                   9238:          $id.'.ylabel' => &escape($ylabel),
1.136     matthew  9239:          $id.'.labels' => join(',',@$Xlabels),
                   9240:          $id.'.PlotType' => 'XY',
                   9241:          $id.'.NumSets' => 2,
1.137     matthew  9242:          $id.'.two_axes' => 1,
                   9243:          $id.'.y1_max_value' => $Max1,
                   9244:          $id.'.y1_min_value' => $Min1,
                   9245:          $id.'.y2_max_value' => $Max2,
                   9246:          $id.'.y2_min_value' => $Min2,
1.136     matthew  9247:          );
                   9248:     #
1.137     matthew  9249:     if (defined($colors) && ref($colors) eq 'ARRAY') {
                   9250:         $ValuesHash{$id.'.Colors'}   = join(',',@{$colors});
                   9251:     }
                   9252:     #
                   9253:     if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
                   9254:         ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136     matthew  9255:         return '';
                   9256:     }
                   9257:     my $NumSets=1;
1.137     matthew  9258:     foreach my $array ($Ydata1,$Ydata2){
1.136     matthew  9259:         next if (! ref($array));
                   9260:         $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137     matthew  9261:     }
                   9262:     #
                   9263:     # Deal with other parameters
                   9264:     while (my ($key,$value) = each(%Values)) {
                   9265:         $ValuesHash{$id.'.'.$key} = $value;
1.136     matthew  9266:     }
                   9267:     #
1.646     raeburn  9268:     &Apache::lonnet::appenv(\%ValuesHash);
1.130     albertel 9269:     return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139     matthew  9270: }
                   9271: 
                   9272: ############################################################
                   9273: ############################################################
                   9274: 
                   9275: =pod
                   9276: 
1.157     matthew  9277: =back 
                   9278: 
1.139     matthew  9279: =head1 Statistics helper routines?  
                   9280: 
                   9281: Bad place for them but what the hell.
                   9282: 
1.157     matthew  9283: =over 4
                   9284: 
1.648     raeburn  9285: =item * &chartlink()
1.139     matthew  9286: 
                   9287: Returns a link to the chart for a specific student.  
                   9288: 
                   9289: Inputs:
                   9290: 
                   9291: =over 4
                   9292: 
                   9293: =item $linktext: The text of the link
                   9294: 
                   9295: =item $sname: The students username
                   9296: 
                   9297: =item $sdomain: The students domain
                   9298: 
                   9299: =back
                   9300: 
1.157     matthew  9301: =back
                   9302: 
1.139     matthew  9303: =cut
                   9304: 
                   9305: ############################################################
                   9306: ############################################################
                   9307: sub chartlink {
                   9308:     my ($linktext, $sname, $sdomain) = @_;
                   9309:     my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369     www      9310:         '&amp;SelectedStudent='.&escape($sname.':'.$sdomain).
1.219     albertel 9311:         '&amp;chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139     matthew  9312:        '">'.$linktext.'</a>';
1.153     matthew  9313: }
                   9314: 
                   9315: #######################################################
                   9316: #######################################################
                   9317: 
                   9318: =pod
                   9319: 
                   9320: =head1 Course Environment Routines
1.157     matthew  9321: 
                   9322: =over 4
1.153     matthew  9323: 
1.648     raeburn  9324: =item * &restore_course_settings()
1.153     matthew  9325: 
1.648     raeburn  9326: =item * &store_course_settings()
1.153     matthew  9327: 
                   9328: Restores/Store indicated form parameters from the course environment.
                   9329: Will not overwrite existing values of the form parameters.
                   9330: 
                   9331: Inputs: 
                   9332: a scalar describing the data (e.g. 'chart', 'problem_analysis')
                   9333: 
                   9334: a hash ref describing the data to be stored.  For example:
                   9335:    
                   9336: %Save_Parameters = ('Status' => 'scalar',
                   9337:     'chartoutputmode' => 'scalar',
                   9338:     'chartoutputdata' => 'scalar',
                   9339:     'Section' => 'array',
1.373     raeburn  9340:     'Group' => 'array',
1.153     matthew  9341:     'StudentData' => 'array',
                   9342:     'Maps' => 'array');
                   9343: 
                   9344: Returns: both routines return nothing
                   9345: 
1.631     raeburn  9346: =back
                   9347: 
1.153     matthew  9348: =cut
                   9349: 
                   9350: #######################################################
                   9351: #######################################################
                   9352: sub store_course_settings {
1.496     albertel 9353:     return &store_settings($env{'request.course.id'},@_);
                   9354: }
                   9355: 
                   9356: sub store_settings {
1.153     matthew  9357:     # save to the environment
                   9358:     # appenv the same items, just to be safe
1.300     albertel 9359:     my $udom  = $env{'user.domain'};
                   9360:     my $uname = $env{'user.name'};
1.496     albertel 9361:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9362:     my %SaveHash;
                   9363:     my %AppHash;
                   9364:     while (my ($setting,$type) = each(%$Settings)) {
1.496     albertel 9365:         my $basename = join('.','internal',$context,$prefix,$setting);
1.300     albertel 9366:         my $envname = 'environment.'.$basename;
1.258     albertel 9367:         if (exists($env{'form.'.$setting})) {
1.153     matthew  9368:             # Save this value away
                   9369:             if ($type eq 'scalar' &&
1.258     albertel 9370:                 (! exists($env{$envname}) || 
                   9371:                  $env{$envname} ne $env{'form.'.$setting})) {
                   9372:                 $SaveHash{$basename} = $env{'form.'.$setting};
                   9373:                 $AppHash{$envname}   = $env{'form.'.$setting};
1.153     matthew  9374:             } elsif ($type eq 'array') {
                   9375:                 my $stored_form;
1.258     albertel 9376:                 if (ref($env{'form.'.$setting})) {
1.153     matthew  9377:                     $stored_form = join(',',
                   9378:                                         map {
1.369     www      9379:                                             &escape($_);
1.258     albertel 9380:                                         } sort(@{$env{'form.'.$setting}}));
1.153     matthew  9381:                 } else {
                   9382:                     $stored_form = 
1.369     www      9383:                         &escape($env{'form.'.$setting});
1.153     matthew  9384:                 }
                   9385:                 # Determine if the array contents are the same.
1.258     albertel 9386:                 if ($stored_form ne $env{$envname}) {
1.153     matthew  9387:                     $SaveHash{$basename} = $stored_form;
                   9388:                     $AppHash{$envname}   = $stored_form;
                   9389:                 }
                   9390:             }
                   9391:         }
                   9392:     }
                   9393:     my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300     albertel 9394:                                           $udom,$uname);
1.153     matthew  9395:     if ($put_result !~ /^(ok|delayed)/) {
                   9396:         &Apache::lonnet::logthis('unable to save form parameters, '.
                   9397:                                  'got error:'.$put_result);
                   9398:     }
                   9399:     # Make sure these settings stick around in this session, too
1.646     raeburn  9400:     &Apache::lonnet::appenv(\%AppHash);
1.153     matthew  9401:     return;
                   9402: }
                   9403: 
                   9404: sub restore_course_settings {
1.499     albertel 9405:     return &restore_settings($env{'request.course.id'},@_);
1.496     albertel 9406: }
                   9407: 
                   9408: sub restore_settings {
                   9409:     my ($context,$prefix,$Settings) = @_;
1.153     matthew  9410:     while (my ($setting,$type) = each(%$Settings)) {
1.258     albertel 9411:         next if (exists($env{'form.'.$setting}));
1.496     albertel 9412:         my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153     matthew  9413:             '.'.$setting;
1.258     albertel 9414:         if (exists($env{$envname})) {
1.153     matthew  9415:             if ($type eq 'scalar') {
1.258     albertel 9416:                 $env{'form.'.$setting} = $env{$envname};
1.153     matthew  9417:             } elsif ($type eq 'array') {
1.258     albertel 9418:                 $env{'form.'.$setting} = [ 
1.153     matthew  9419:                                            map { 
1.369     www      9420:                                                &unescape($_); 
1.258     albertel 9421:                                            } split(',',$env{$envname})
1.153     matthew  9422:                                            ];
                   9423:             }
                   9424:         }
                   9425:     }
1.127     matthew  9426: }
                   9427: 
1.618     raeburn  9428: #######################################################
                   9429: #######################################################
                   9430: 
                   9431: =pod
                   9432: 
                   9433: =head1 Domain E-mail Routines  
                   9434: 
                   9435: =over 4
                   9436: 
1.648     raeburn  9437: =item * &build_recipient_list()
1.618     raeburn  9438: 
1.884     raeburn  9439: Build recipient lists for five types of e-mail:
1.766     raeburn  9440: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
1.884     raeburn  9441: (d) Help requests, (e) Course requests needing approval,  generated by
                   9442: lonerrorhandler.pm, CHECKRPMS, loncron, lonsupportreq.pm and
                   9443: loncoursequeueadmin.pm respectively.
1.618     raeburn  9444: 
                   9445: Inputs:
1.619     raeburn  9446: defmail (scalar - email address of default recipient), 
1.618     raeburn  9447: mailing type (scalar - errormail, packagesmail, or helpdeskmail), 
1.619     raeburn  9448: defdom (domain for which to retrieve configuration settings),
                   9449: origmail (scalar - email address of recipient from loncapa.conf, 
                   9450: i.e., predates configuration by DC via domainprefs.pm 
1.618     raeburn  9451: 
1.655     raeburn  9452: Returns: comma separated list of addresses to which to send e-mail.
                   9453: 
                   9454: =back
1.618     raeburn  9455: 
                   9456: =cut
                   9457: 
                   9458: ############################################################
                   9459: ############################################################
                   9460: sub build_recipient_list {
1.619     raeburn  9461:     my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618     raeburn  9462:     my @recipients;
                   9463:     my $otheremails;
                   9464:     my %domconfig =
                   9465:          &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
                   9466:     if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766     raeburn  9467:         if (exists($domconfig{'contacts'}{$mailing})) {
                   9468:             if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
                   9469:                 my @contacts = ('adminemail','supportemail');
                   9470:                 foreach my $item (@contacts) {
                   9471:                     if ($domconfig{'contacts'}{$mailing}{$item}) {
                   9472:                         my $addr = $domconfig{'contacts'}{$item}; 
                   9473:                         if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9474:                             push(@recipients,$addr);
                   9475:                         }
1.619     raeburn  9476:                     }
1.766     raeburn  9477:                     $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618     raeburn  9478:                 }
                   9479:             }
1.766     raeburn  9480:         } elsif ($origmail ne '') {
                   9481:             push(@recipients,$origmail);
1.618     raeburn  9482:         }
1.619     raeburn  9483:     } elsif ($origmail ne '') {
                   9484:         push(@recipients,$origmail);
1.618     raeburn  9485:     }
1.688     raeburn  9486:     if (defined($defmail)) {
                   9487:         if ($defmail ne '') {
                   9488:             push(@recipients,$defmail);
                   9489:         }
1.618     raeburn  9490:     }
                   9491:     if ($otheremails) {
1.619     raeburn  9492:         my @others;
                   9493:         if ($otheremails =~ /,/) {
                   9494:             @others = split(/,/,$otheremails);
1.618     raeburn  9495:         } else {
1.619     raeburn  9496:             push(@others,$otheremails);
                   9497:         }
                   9498:         foreach my $addr (@others) {
                   9499:             if (!grep(/^\Q$addr\E$/,@recipients)) {
                   9500:                 push(@recipients,$addr);
                   9501:             }
1.618     raeburn  9502:         }
                   9503:     }
1.619     raeburn  9504:     my $recipientlist = join(',',@recipients); 
1.618     raeburn  9505:     return $recipientlist;
                   9506: }
                   9507: 
1.127     matthew  9508: ############################################################
                   9509: ############################################################
1.154     albertel 9510: 
1.655     raeburn  9511: =pod
                   9512: 
                   9513: =head1 Course Catalog Routines
                   9514: 
                   9515: =over 4
                   9516: 
                   9517: =item * &gather_categories()
                   9518: 
                   9519: Converts category definitions - keys of categories hash stored in  
                   9520: coursecategories in configuration.db on the primary library server in a 
                   9521: domain - to an array.  Also generates javascript and idx hash used to 
                   9522: generate Domain Coordinator interface for editing Course Categories.
                   9523: 
                   9524: Inputs:
1.663     raeburn  9525: 
1.655     raeburn  9526: categories (reference to hash of category definitions).
1.663     raeburn  9527: 
1.655     raeburn  9528: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9529:       categories and subcategories).
1.663     raeburn  9530: 
1.655     raeburn  9531: idx (reference to hash of counters used in Domain Coordinator interface for 
                   9532:       editing Course Categories).
1.663     raeburn  9533: 
1.655     raeburn  9534: jsarray (reference to array of categories used to create Javascript arrays for
                   9535:          Domain Coordinator interface for editing Course Categories).
                   9536: 
                   9537: Returns: nothing
                   9538: 
                   9539: Side effects: populates cats, idx and jsarray. 
                   9540: 
                   9541: =cut
                   9542: 
                   9543: sub gather_categories {
                   9544:     my ($categories,$cats,$idx,$jsarray) = @_;
                   9545:     my %counters;
                   9546:     my $num = 0;
                   9547:     foreach my $item (keys(%{$categories})) {
                   9548:         my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
                   9549:         if ($container eq '' && $depth == 0) {
                   9550:             $cats->[$depth][$categories->{$item}] = $cat;
                   9551:         } else {
                   9552:             $cats->[$depth]{$container}[$categories->{$item}] = $cat;
                   9553:         }
                   9554:         my ($escitem,$tail) = split(/:/,$item,2);
                   9555:         if ($counters{$tail} eq '') {
                   9556:             $counters{$tail} = $num;
                   9557:             $num ++;
                   9558:         }
                   9559:         if (ref($idx) eq 'HASH') {
                   9560:             $idx->{$item} = $counters{$tail};
                   9561:         }
                   9562:         if (ref($jsarray) eq 'ARRAY') {
                   9563:             push(@{$jsarray->[$counters{$tail}]},$item);
                   9564:         }
                   9565:     }
                   9566:     return;
                   9567: }
                   9568: 
                   9569: =pod
                   9570: 
                   9571: =item * &extract_categories()
                   9572: 
                   9573: Used to generate breadcrumb trails for course categories.
                   9574: 
                   9575: Inputs:
1.663     raeburn  9576: 
1.655     raeburn  9577: categories (reference to hash of category definitions).
1.663     raeburn  9578: 
1.655     raeburn  9579: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9580:       categories and subcategories).
1.663     raeburn  9581: 
1.655     raeburn  9582: trails (reference to array of breacrumb trails for each category).
1.663     raeburn  9583: 
1.655     raeburn  9584: allitems (reference to hash - key is category key 
                   9585:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9586: 
1.655     raeburn  9587: idx (reference to hash of counters used in Domain Coordinator interface for
                   9588:       editing Course Categories).
1.663     raeburn  9589: 
1.655     raeburn  9590: jsarray (reference to array of categories used to create Javascript arrays for
                   9591:          Domain Coordinator interface for editing Course Categories).
                   9592: 
1.665     raeburn  9593: subcats (reference to hash of arrays containing all subcategories within each 
                   9594:          category, -recursive)
                   9595: 
1.655     raeburn  9596: Returns: nothing
                   9597: 
                   9598: Side effects: populates trails and allitems hash references.
                   9599: 
                   9600: =cut
                   9601: 
                   9602: sub extract_categories {
1.665     raeburn  9603:     my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655     raeburn  9604:     if (ref($categories) eq 'HASH') {
                   9605:         &gather_categories($categories,$cats,$idx,$jsarray);
                   9606:         if (ref($cats->[0]) eq 'ARRAY') {
                   9607:             for (my $i=0; $i<@{$cats->[0]}; $i++) {
                   9608:                 my $name = $cats->[0][$i];
                   9609:                 my $item = &escape($name).'::0';
                   9610:                 my $trailstr;
                   9611:                 if ($name eq 'instcode') {
                   9612:                     $trailstr = &mt('Official courses (with institutional codes)');
                   9613:                 } else {
                   9614:                     $trailstr = $name;
                   9615:                 }
                   9616:                 if ($allitems->{$item} eq '') {
                   9617:                     push(@{$trails},$trailstr);
                   9618:                     $allitems->{$item} = scalar(@{$trails})-1;
                   9619:                 }
                   9620:                 my @parents = ($name);
                   9621:                 if (ref($cats->[1]{$name}) eq 'ARRAY') {
                   9622:                     for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
                   9623:                         my $category = $cats->[1]{$name}[$j];
1.665     raeburn  9624:                         if (ref($subcats) eq 'HASH') {
                   9625:                             push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
                   9626:                         }
                   9627:                         &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
                   9628:                     }
                   9629:                 } else {
                   9630:                     if (ref($subcats) eq 'HASH') {
                   9631:                         $subcats->{$item} = [];
1.655     raeburn  9632:                     }
                   9633:                 }
                   9634:             }
                   9635:         }
                   9636:     }
                   9637:     return;
                   9638: }
                   9639: 
                   9640: =pod
                   9641: 
                   9642: =item *&recurse_categories()
                   9643: 
                   9644: Recursively used to generate breadcrumb trails for course categories.
                   9645: 
                   9646: Inputs:
1.663     raeburn  9647: 
1.655     raeburn  9648: cats (reference to array of arrays/hashes which encapsulates hierarchy of
                   9649:       categories and subcategories).
1.663     raeburn  9650: 
1.655     raeburn  9651: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663     raeburn  9652: 
                   9653: category (current course category, for which breadcrumb trail is being generated).
                   9654: 
                   9655: trails (reference to array of breadcrumb trails for each category).
                   9656: 
1.655     raeburn  9657: allitems (reference to hash - key is category key
                   9658:          (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663     raeburn  9659: 
1.655     raeburn  9660: parents (array containing containers directories for current category, 
                   9661:          back to top level). 
                   9662: 
                   9663: Returns: nothing
                   9664: 
                   9665: Side effects: populates trails and allitems hash references
                   9666: 
                   9667: =cut
                   9668: 
                   9669: sub recurse_categories {
1.665     raeburn  9670:     my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655     raeburn  9671:     my $shallower = $depth - 1;
                   9672:     if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
                   9673:         for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
                   9674:             my $name = $cats->[$depth]{$category}[$k];
                   9675:             my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9676:             my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9677:             if ($allitems->{$item} eq '') {
                   9678:                 push(@{$trails},$trailstr);
                   9679:                 $allitems->{$item} = scalar(@{$trails})-1;
                   9680:             }
                   9681:             my $deeper = $depth+1;
                   9682:             push(@{$parents},$category);
1.665     raeburn  9683:             if (ref($subcats) eq 'HASH') {
                   9684:                 my $subcat = &escape($name).':'.$category.':'.$depth;
                   9685:                 for (my $j=@{$parents}; $j>=0; $j--) {
                   9686:                     my $higher;
                   9687:                     if ($j > 0) {
                   9688:                         $higher = &escape($parents->[$j]).':'.
                   9689:                                   &escape($parents->[$j-1]).':'.$j;
                   9690:                     } else {
                   9691:                         $higher = &escape($parents->[$j]).'::'.$j;
                   9692:                     }
                   9693:                     push(@{$subcats->{$higher}},$subcat);
                   9694:                 }
                   9695:             }
                   9696:             &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
                   9697:                                 $subcats);
1.655     raeburn  9698:             pop(@{$parents});
                   9699:         }
                   9700:     } else {
                   9701:         my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
                   9702:         my $trailstr = join(' -&gt; ',(@{$parents},$category));
                   9703:         if ($allitems->{$item} eq '') {
                   9704:             push(@{$trails},$trailstr);
                   9705:             $allitems->{$item} = scalar(@{$trails})-1;
                   9706:         }
                   9707:     }
                   9708:     return;
                   9709: }
                   9710: 
1.663     raeburn  9711: =pod
                   9712: 
                   9713: =item *&assign_categories_table()
                   9714: 
                   9715: Create a datatable for display of hierarchical categories in a domain,
                   9716: with checkboxes to allow a course to be categorized. 
                   9717: 
                   9718: Inputs:
                   9719: 
                   9720: cathash - reference to hash of categories defined for the domain (from
                   9721:           configuration.db)
                   9722: 
                   9723: currcat - scalar with an & separated list of categories assigned to a course. 
                   9724: 
                   9725: Returns: $output (markup to be displayed) 
                   9726: 
                   9727: =cut
                   9728: 
                   9729: sub assign_categories_table {
                   9730:     my ($cathash,$currcat) = @_;
                   9731:     my $output;
                   9732:     if (ref($cathash) eq 'HASH') {
                   9733:         my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
                   9734:         &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
                   9735:         $maxdepth = scalar(@cats);
                   9736:         if (@cats > 0) {
                   9737:             my $itemcount = 0;
                   9738:             if (ref($cats[0]) eq 'ARRAY') {
                   9739:                 $output = &Apache::loncommon::start_data_table();
                   9740:                 my @currcategories;
                   9741:                 if ($currcat ne '') {
                   9742:                     @currcategories = split('&',$currcat);
                   9743:                 }
                   9744:                 for (my $i=0; $i<@{$cats[0]}; $i++) {
                   9745:                     my $parent = $cats[0][$i];
                   9746:                     my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9747:                     next if ($parent eq 'instcode');
                   9748:                     my $item = &escape($parent).'::0';
                   9749:                     my $checked = '';
                   9750:                     if (@currcategories > 0) {
                   9751:                         if (grep(/^\Q$item\E$/,@currcategories)) {
1.772     bisitz   9752:                             $checked = ' checked="checked"';
1.663     raeburn  9753:                         }
                   9754:                     }
1.675     raeburn  9755:                     $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
                   9756:                                '<input type="checkbox" name="usecategory" value="'.
                   9757:                                $item.'"'.$checked.' />'.$parent.'</span>'.
                   9758:                                '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663     raeburn  9759:                     my $depth = 1;
                   9760:                     push(@path,$parent);
                   9761:                     $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
                   9762:                     pop(@path);
                   9763:                     $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
                   9764:                     $itemcount ++;
                   9765:                 }
                   9766:                 $output .= &Apache::loncommon::end_data_table();
                   9767:             }
                   9768:         }
                   9769:     }
                   9770:     return $output;
                   9771: }
                   9772: 
                   9773: =pod
                   9774: 
                   9775: =item *&assign_category_rows()
                   9776: 
                   9777: Create a datatable row for display of nested categories in a domain,
                   9778: with checkboxes to allow a course to be categorized,called recursively.
                   9779: 
                   9780: Inputs:
                   9781: 
                   9782: itemcount - track row number for alternating colors
                   9783: 
                   9784: cats - reference to array of arrays/hashes which encapsulates hierarchy of
                   9785:       categories and subcategories.
                   9786: 
                   9787: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
                   9788: 
                   9789: parent - parent of current category item
                   9790: 
                   9791: path - Array containing all categories back up through the hierarchy from the
                   9792:        current category to the top level.
                   9793: 
                   9794: currcategories - reference to array of current categories assigned to the course
                   9795: 
                   9796: Returns: $output (markup to be displayed).
                   9797: 
                   9798: =cut
                   9799: 
                   9800: sub assign_category_rows {
                   9801:     my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
                   9802:     my ($text,$name,$item,$chgstr);
                   9803:     if (ref($cats) eq 'ARRAY') {
                   9804:         my $maxdepth = scalar(@{$cats});
                   9805:         if (ref($cats->[$depth]) eq 'HASH') {
                   9806:             if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
                   9807:                 my $numchildren = @{$cats->[$depth]{$parent}};
                   9808:                 my $css_class = $itemcount%2?' class="LC_odd_row"':'';
                   9809:                 $text .= '<td><table class="LC_datatable">';
                   9810:                 for (my $j=0; $j<$numchildren; $j++) {
                   9811:                     $name = $cats->[$depth]{$parent}[$j];
                   9812:                     $item = &escape($name).':'.&escape($parent).':'.$depth;
                   9813:                     my $deeper = $depth+1;
                   9814:                     my $checked = '';
                   9815:                     if (ref($currcategories) eq 'ARRAY') {
                   9816:                         if (@{$currcategories} > 0) {
                   9817:                             if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772     bisitz   9818:                                 $checked = ' checked="checked"';
1.663     raeburn  9819:                             }
                   9820:                         }
                   9821:                     }
1.664     raeburn  9822:                     $text .= '<tr><td><span class="LC_nobreak"><label>'.
                   9823:                              '<input type="checkbox" name="usecategory" value="'.
1.675     raeburn  9824:                              $item.'"'.$checked.' />'.$name.'</label></span>'.
                   9825:                              '<input type="hidden" name="catname" value="'.$name.'" />'.
                   9826:                              '</td><td>';
1.663     raeburn  9827:                     if (ref($path) eq 'ARRAY') {
                   9828:                         push(@{$path},$name);
                   9829:                         $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
                   9830:                         pop(@{$path});
                   9831:                     }
                   9832:                     $text .= '</td></tr>';
                   9833:                 }
                   9834:                 $text .= '</table></td>';
                   9835:             }
                   9836:         }
                   9837:     }
                   9838:     return $text;
                   9839: }
                   9840: 
1.655     raeburn  9841: ############################################################
                   9842: ############################################################
                   9843: 
                   9844: 
1.443     albertel 9845: sub commit_customrole {
1.664     raeburn  9846:     my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630     raeburn  9847:     my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443     albertel 9848:                          ($start?', '.&mt('starting').' '.localtime($start):'').
                   9849:                          ($end?', ending '.localtime($end):'').': <b>'.
                   9850:               &Apache::lonnet::assigncustomrole(
1.664     raeburn  9851:                  $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443     albertel 9852:                  '</b><br />';
                   9853:     return $output;
                   9854: }
                   9855: 
                   9856: sub commit_standardrole {
1.541     raeburn  9857:     my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
                   9858:     my ($output,$logmsg,$linefeed);
                   9859:     if ($context eq 'auto') {
                   9860:         $linefeed = "\n";
                   9861:     } else {
                   9862:         $linefeed = "<br />\n";
                   9863:     }  
1.443     albertel 9864:     if ($three eq 'st') {
1.541     raeburn  9865:         my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
                   9866:                                          $one,$two,$sec,$context);
                   9867:         if (($result =~ /^error/) || ($result eq 'not_in_class') || 
1.626     raeburn  9868:             ($result eq 'unknown_course') || ($result eq 'refused')) {
                   9869:             $output = $logmsg.' '.&mt('Error: ').$result."\n"; 
1.443     albertel 9870:         } else {
1.541     raeburn  9871:             $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443     albertel 9872:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9873:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
                   9874:             if ($context eq 'auto') {
                   9875:                 $output .= $result.$linefeed.&mt('Add to classlist').': ok';
                   9876:             } else {
                   9877:                $output .= '<b>'.$result.'</b>'.$linefeed.
                   9878:                &mt('Add to classlist').': <b>ok</b>';
                   9879:             }
                   9880:             $output .= $linefeed;
1.443     albertel 9881:         }
                   9882:     } else {
                   9883:         $output = &mt('Assigning').' '.$three.' in '.$url.
                   9884:                ($start?', '.&mt('starting').' '.localtime($start):'').
1.541     raeburn  9885:                ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652     raeburn  9886:         my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541     raeburn  9887:         if ($context eq 'auto') {
                   9888:             $output .= $result.$linefeed;
                   9889:         } else {
                   9890:             $output .= '<b>'.$result.'</b>'.$linefeed;
                   9891:         }
1.443     albertel 9892:     }
                   9893:     return $output;
                   9894: }
                   9895: 
                   9896: sub commit_studentrole {
1.541     raeburn  9897:     my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626     raeburn  9898:     my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541     raeburn  9899:     if ($context eq 'auto') {
                   9900:         $linefeed = "\n";
                   9901:     } else {
                   9902:         $linefeed = '<br />'."\n";
                   9903:     }
1.443     albertel 9904:     if (defined($one) && defined($two)) {
                   9905:         my $cid=$one.'_'.$two;
                   9906:         my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
                   9907:         my $secchange = 0;
                   9908:         my $expire_role_result;
                   9909:         my $modify_section_result;
1.628     raeburn  9910:         if ($oldsec ne '-1') { 
                   9911:             if ($oldsec ne $sec) {
1.443     albertel 9912:                 $secchange = 1;
1.628     raeburn  9913:                 my $now = time;
1.443     albertel 9914:                 my $uurl='/'.$cid;
                   9915:                 $uurl=~s/\_/\//g;
                   9916:                 if ($oldsec) {
                   9917:                     $uurl.='/'.$oldsec;
                   9918:                 }
1.626     raeburn  9919:                 $oldsecurl = $uurl;
1.628     raeburn  9920:                 $expire_role_result = 
1.652     raeburn  9921:                     &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628     raeburn  9922:                 if ($env{'request.course.sec'} ne '') { 
                   9923:                     if ($expire_role_result eq 'refused') {
                   9924:                         my @roles = ('st');
                   9925:                         my @statuses = ('previous');
                   9926:                         my @roledoms = ($one);
                   9927:                         my $withsec = 1;
                   9928:                         my %roleshash = 
                   9929:                             &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
                   9930:                                               \@statuses,\@roles,\@roledoms,$withsec);
                   9931:                         if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
                   9932:                             my ($oldstart,$oldend) = 
                   9933:                                 split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
                   9934:                             if ($oldend > 0 && $oldend <= $now) {
                   9935:                                 $expire_role_result = 'ok';
                   9936:                             }
                   9937:                         }
                   9938:                     }
                   9939:                 }
1.443     albertel 9940:                 $result = $expire_role_result;
                   9941:             }
                   9942:         }
                   9943:         if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652     raeburn  9944:             $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443     albertel 9945:             if ($modify_section_result =~ /^ok/) {
                   9946:                 if ($secchange == 1) {
1.628     raeburn  9947:                     if ($sec eq '') {
                   9948:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
                   9949:                     } else {
                   9950:                         $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
                   9951:                     }
1.443     albertel 9952:                 } elsif ($oldsec eq '-1') {
1.628     raeburn  9953:                     if ($sec eq '') {
                   9954:                         $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
                   9955:                     } else {
                   9956:                         $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9957:                     }
1.443     albertel 9958:                 } else {
1.628     raeburn  9959:                     if ($sec eq '') {
                   9960:                         $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
                   9961:                     } else {
                   9962:                         $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
                   9963:                     }
1.443     albertel 9964:                 }
                   9965:             } else {
1.628     raeburn  9966:                 if ($secchange) {       
                   9967:                     $$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;
                   9968:                 } else {
                   9969:                     $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
                   9970:                 }
1.443     albertel 9971:             }
                   9972:             $result = $modify_section_result;
                   9973:         } elsif ($secchange == 1) {
1.628     raeburn  9974:             if ($oldsec eq '') {
                   9975:                 $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
                   9976:             } else {
                   9977:                 $$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;
                   9978:             }
1.626     raeburn  9979:             if ($expire_role_result eq 'refused') {
                   9980:                 my $newsecurl = '/'.$cid;
                   9981:                 $newsecurl =~ s/\_/\//g;
                   9982:                 if ($sec ne '') {
                   9983:                     $newsecurl.='/'.$sec;
                   9984:                 }
                   9985:                 if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
                   9986:                     if ($sec eq '') {
                   9987:                         $$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;
                   9988:                     } else {
                   9989:                         $$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;
                   9990:                     }
                   9991:                 }
                   9992:             }
1.443     albertel 9993:         }
                   9994:     } else {
1.626     raeburn  9995:         $$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 9996:         $result = "error: incomplete course id\n";
                   9997:     }
                   9998:     return $result;
                   9999: }
                   10000: 
                   10001: ############################################################
                   10002: ############################################################
                   10003: 
1.566     albertel 10004: sub check_clone {
1.578     raeburn  10005:     my ($args,$linefeed) = @_;
1.566     albertel 10006:     my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
                   10007:     my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
                   10008:     my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
                   10009:     my $clonemsg;
                   10010:     my $can_clone = 0;
1.908     raeburn  10011:     my $lctype = lc($args->{'type'});
                   10012:     if ($lctype ne 'community') {
                   10013:         $lctype = 'course';
                   10014:     }
1.566     albertel 10015:     if ($clonehome eq 'no_host') {
1.908     raeburn  10016:         if ($args->{'type'} eq 'Community') {
                   10017:             $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'});
                   10018:         } else {
                   10019:             $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'});
                   10020:         }     
1.566     albertel 10021:     } else {
                   10022: 	my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.908     raeburn  10023:         if ($args->{'type'} eq 'Community') {
                   10024:             if ($clonedesc{'type'} ne 'Community') {
                   10025:                  $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'});
                   10026:                 return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10027:             }
                   10028:         }
1.882     raeburn  10029: 	if (($env{'request.role.domain'} eq $args->{'clonedomain'}) && 
                   10030:             (&Apache::lonnet::allowed('ccc',$env{'request.role.domain'}))) {
1.566     albertel 10031: 	    $can_clone = 1;
                   10032: 	} else {
                   10033: 	    my %clonehash = &Apache::lonnet::get('environment',['cloners'],
                   10034: 						 $args->{'clonedomain'},$args->{'clonecourse'});
                   10035: 	    my @cloners = split(/,/,$clonehash{'cloners'});
1.578     raeburn  10036:             if (grep(/^\*$/,@cloners)) {
                   10037:                 $can_clone = 1;
                   10038:             } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
                   10039:                 $can_clone = 1;
                   10040:             } else {
1.908     raeburn  10041:                 my $ccrole = 'cc';
                   10042:                 if ($args->{'type'} eq 'Community') {
                   10043:                     $ccrole = 'co';
                   10044:                 }
1.578     raeburn  10045: 	        my %roleshash =
                   10046: 		    &Apache::lonnet::get_my_roles($args->{'ccuname'},
                   10047: 					 $args->{'ccdomain'},
1.908     raeburn  10048:                                          'userroles',['active'],[$ccrole],
1.578     raeburn  10049: 					 [$args->{'clonedomain'}]);
1.908     raeburn  10050: 	        if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':'.$ccrole}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
1.578     raeburn  10051: 		    $can_clone = 1;
                   10052: 	        } else {
1.908     raeburn  10053:                     if ($args->{'type'} eq 'Community') {
                   10054:                         $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'});
                   10055:                     } else {
                   10056:                         $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'});
                   10057:                     }
1.578     raeburn  10058: 	        }
1.566     albertel 10059: 	    }
1.578     raeburn  10060:         }
1.566     albertel 10061:     }
                   10062:     return ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10063: }
                   10064: 
1.444     albertel 10065: sub construct_course {
1.885     raeburn  10066:     my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context,$cnum,$category) = @_;
1.444     albertel 10067:     my $outcome;
1.541     raeburn  10068:     my $linefeed =  '<br />'."\n";
                   10069:     if ($context eq 'auto') {
                   10070:         $linefeed = "\n";
                   10071:     }
1.566     albertel 10072: 
                   10073: #
                   10074: # Are we cloning?
                   10075: #
                   10076:     my ($can_clone, $clonemsg, $cloneid, $clonehome);
                   10077:     if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578     raeburn  10078: 	($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566     albertel 10079: 	if ($context ne 'auto') {
1.578     raeburn  10080:             if ($clonemsg ne '') {
                   10081: 	        $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
                   10082:             }
1.566     albertel 10083: 	}
                   10084: 	$outcome .= $clonemsg.$linefeed;
                   10085: 
                   10086:         if (!$can_clone) {
                   10087: 	    return (0,$outcome);
                   10088: 	}
                   10089:     }
                   10090: 
1.444     albertel 10091: #
                   10092: # Open course
                   10093: #
                   10094:     my $crstype = lc($args->{'crstype'});
                   10095:     my %cenv=();
                   10096:     $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
                   10097:                                              $args->{'cdescr'},
                   10098:                                              $args->{'curl'},
                   10099:                                              $args->{'course_home'},
                   10100:                                              $args->{'nonstandard'},
                   10101:                                              $args->{'crscode'},
                   10102:                                              $args->{'ccuname'}.':'.
                   10103:                                              $args->{'ccdomain'},
1.882     raeburn  10104:                                              $args->{'crstype'},
1.885     raeburn  10105:                                              $cnum,$context,$category);
1.444     albertel 10106: 
                   10107:     # Note: The testing routines depend on this being output; see 
                   10108:     # Utils::Course. This needs to at least be output as a comment
                   10109:     # if anyone ever decides to not show this, and Utils::Course::new
                   10110:     # will need to be suitably modified.
1.541     raeburn  10111:     $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444     albertel 10112: #
                   10113: # Check if created correctly
                   10114: #
1.479     albertel 10115:     ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444     albertel 10116:     my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541     raeburn  10117:     $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566     albertel 10118: 
1.444     albertel 10119: #
1.566     albertel 10120: # Do the cloning
                   10121: #   
                   10122:     if ($can_clone && $cloneid) {
                   10123: 	$clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
                   10124: 	if ($context ne 'auto') {
                   10125: 	    $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
                   10126: 	}
                   10127: 	$outcome .= $clonemsg.$linefeed;
                   10128: 	my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444     albertel 10129: # Copy all files
1.637     www      10130: 	&Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444     albertel 10131: # Restore URL
1.566     albertel 10132: 	$cenv{'url'}=$oldcenv{'url'};
1.444     albertel 10133: # Restore title
1.566     albertel 10134: 	$cenv{'description'}=$oldcenv{'description'};
1.444     albertel 10135: # Mark as cloned
1.566     albertel 10136: 	$cenv{'clonedfrom'}=$cloneid;
1.638     www      10137: # Need to clone grading mode
                   10138:         my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
                   10139:         $cenv{'grading'}=$newenv{'grading'};
                   10140: # Do not clone these environment entries
                   10141:         &Apache::lonnet::del('environment',
                   10142:                   ['default_enrollment_start_date',
                   10143:                    'default_enrollment_end_date',
                   10144:                    'question.email',
                   10145:                    'policy.email',
                   10146:                    'comment.email',
                   10147:                    'pch.users.denied',
1.725     raeburn  10148:                    'plc.users.denied',
                   10149:                    'hidefromcat',
                   10150:                    'categories'],
1.638     www      10151:                    $$crsudom,$$crsunum);
1.444     albertel 10152:     }
1.566     albertel 10153: 
1.444     albertel 10154: #
                   10155: # Set environment (will override cloned, if existing)
                   10156: #
                   10157:     my @sections = ();
                   10158:     my @xlists = ();
                   10159:     if ($args->{'crstype'}) {
                   10160:         $cenv{'type'}=$args->{'crstype'};
                   10161:     }
                   10162:     if ($args->{'crsid'}) {
                   10163:         $cenv{'courseid'}=$args->{'crsid'};
                   10164:     }
                   10165:     if ($args->{'crscode'}) {
                   10166:         $cenv{'internal.coursecode'}=$args->{'crscode'};
                   10167:     }
                   10168:     if ($args->{'crsquota'} ne '') {
                   10169:         $cenv{'internal.coursequota'}=$args->{'crsquota'};
                   10170:     } else {
                   10171:         $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
                   10172:     }
                   10173:     if ($args->{'ccuname'}) {
                   10174:         $cenv{'internal.courseowner'} = $args->{'ccuname'}.
                   10175:                                         ':'.$args->{'ccdomain'};
                   10176:     } else {
                   10177:         $cenv{'internal.courseowner'} = $args->{'curruser'};
                   10178:     }
                   10179:     my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
                   10180:     if ($args->{'crssections'}) {
                   10181:         $cenv{'internal.sectionnums'} = '';
                   10182:         if ($args->{'crssections'} =~ m/,/) {
                   10183:             @sections = split/,/,$args->{'crssections'};
                   10184:         } else {
                   10185:             $sections[0] = $args->{'crssections'};
                   10186:         }
                   10187:         if (@sections > 0) {
                   10188:             foreach my $item (@sections) {
                   10189:                 my ($sec,$gp) = split/:/,$item;
                   10190:                 my $class = $args->{'crscode'}.$sec;
                   10191:                 my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
                   10192:                 $cenv{'internal.sectionnums'} .= $item.',';
                   10193:                 unless ($addcheck eq 'ok') {
                   10194:                     push @badclasses, $class;
                   10195:                 }
                   10196:             }
                   10197:             $cenv{'internal.sectionnums'} =~ s/,$//;
                   10198:         }
                   10199:     }
                   10200: # do not hide course coordinator from staff listing, 
                   10201: # even if privileged
                   10202:     $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10203: # add crosslistings
                   10204:     if ($args->{'crsxlist'}) {
                   10205:         $cenv{'internal.crosslistings'}='';
                   10206:         if ($args->{'crsxlist'} =~ m/,/) {
                   10207:             @xlists = split/,/,$args->{'crsxlist'};
                   10208:         } else {
                   10209:             $xlists[0] = $args->{'crsxlist'};
                   10210:         }
                   10211:         if (@xlists > 0) {
                   10212:             foreach my $item (@xlists) {
                   10213:                 my ($xl,$gp) = split/:/,$item;
                   10214:                 my $addcheck =  &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
                   10215:                 $cenv{'internal.crosslistings'} .= $item.',';
                   10216:                 unless ($addcheck eq 'ok') {
                   10217:                     push @badclasses, $xl;
                   10218:                 }
                   10219:             }
                   10220:             $cenv{'internal.crosslistings'} =~ s/,$//;
                   10221:         }
                   10222:     }
                   10223:     if ($args->{'autoadds'}) {
                   10224:         $cenv{'internal.autoadds'}=$args->{'autoadds'};
                   10225:     }
                   10226:     if ($args->{'autodrops'}) {
                   10227:         $cenv{'internal.autodrops'}=$args->{'autodrops'};
                   10228:     }
                   10229: # check for notification of enrollment changes
                   10230:     my @notified = ();
                   10231:     if ($args->{'notify_owner'}) {
                   10232:         if ($args->{'ccuname'} ne '') {
                   10233:             push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
                   10234:         }
                   10235:     }
                   10236:     if ($args->{'notify_dc'}) {
                   10237:         if ($uname ne '') { 
1.630     raeburn  10238:             push(@notified,$uname.':'.$udom);
1.444     albertel 10239:         }
                   10240:     }
                   10241:     if (@notified > 0) {
                   10242:         my $notifylist;
                   10243:         if (@notified > 1) {
                   10244:             $notifylist = join(',',@notified);
                   10245:         } else {
                   10246:             $notifylist = $notified[0];
                   10247:         }
                   10248:         $cenv{'internal.notifylist'} = $notifylist;
                   10249:     }
                   10250:     if (@badclasses > 0) {
                   10251:         my %lt=&Apache::lonlocal::texthash(
                   10252:                 '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',
                   10253:                 'dnhr' => 'does not have rights to access enrollment in these classes',
                   10254:                 'adby' => 'as determined by the policies of your institution on access to official classlists'
                   10255:         );
1.541     raeburn  10256:         my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
                   10257:                            ' ('.$lt{'adby'}.')';
                   10258:         if ($context eq 'auto') {
                   10259:             $outcome .= $badclass_msg.$linefeed;
1.566     albertel 10260:             $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541     raeburn  10261:             foreach my $item (@badclasses) {
                   10262:                 if ($context eq 'auto') {
                   10263:                     $outcome .= " - $item\n";
                   10264:                 } else {
                   10265:                     $outcome .= "<li>$item</li>\n";
                   10266:                 }
                   10267:             }
                   10268:             if ($context eq 'auto') {
                   10269:                 $outcome .= $linefeed;
                   10270:             } else {
1.566     albertel 10271:                 $outcome .= "</ul><br /><br /></div>\n";
1.541     raeburn  10272:             }
                   10273:         } 
1.444     albertel 10274:     }
                   10275:     if ($args->{'no_end_date'}) {
                   10276:         $args->{'endaccess'} = 0;
                   10277:     }
                   10278:     $cenv{'internal.autostart'}=$args->{'enrollstart'};
                   10279:     $cenv{'internal.autoend'}=$args->{'enrollend'};
                   10280:     $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
                   10281:     $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
                   10282:     if ($args->{'showphotos'}) {
                   10283:       $cenv{'internal.showphotos'}=$args->{'showphotos'};
                   10284:     }
                   10285:     $cenv{'internal.authtype'} = $args->{'authtype'};
                   10286:     $cenv{'internal.autharg'} = $args->{'autharg'}; 
                   10287:     if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
                   10288:         if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'}  eq '') {
1.541     raeburn  10289:             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'); 
                   10290:             if ($context eq 'auto') {
                   10291:                 $outcome .= $krb_msg;
                   10292:             } else {
1.566     albertel 10293:                 $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541     raeburn  10294:             }
                   10295:             $outcome .= $linefeed;
1.444     albertel 10296:         }
                   10297:     }
                   10298:     if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
                   10299:        if ($args->{'setpolicy'}) {
                   10300:            $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10301:        }
                   10302:        if ($args->{'setcontent'}) {
                   10303:            $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
                   10304:        }
                   10305:     }
                   10306:     if ($args->{'reshome'}) {
                   10307: 	$cenv{'reshome'}=$args->{'reshome'}.'/';
                   10308: 	$cenv{'reshome'}=~s/\/+$/\//;
                   10309:     }
                   10310: #
                   10311: # course has keyed access
                   10312: #
                   10313:     if ($args->{'setkeys'}) {
                   10314:        $cenv{'keyaccess'}='yes';
                   10315:     }
                   10316: # if specified, key authority is not course, but user
                   10317: # only active if keyaccess is yes
                   10318:     if ($args->{'keyauth'}) {
1.487     albertel 10319: 	my ($user,$domain) = split(':',$args->{'keyauth'});
                   10320: 	$user = &LONCAPA::clean_username($user);
                   10321: 	$domain = &LONCAPA::clean_username($domain);
1.488     foxr     10322: 	if ($user ne '' && $domain ne '') {
1.487     albertel 10323: 	    $cenv{'keyauth'}=$user.':'.$domain;
1.444     albertel 10324: 	}
                   10325:     }
                   10326: 
                   10327:     if ($args->{'disresdis'}) {
                   10328:         $cenv{'pch.roles.denied'}='st';
                   10329:     }
                   10330:     if ($args->{'disablechat'}) {
                   10331:         $cenv{'plc.roles.denied'}='st';
                   10332:     }
                   10333: 
                   10334:     # Record we've not yet viewed the Course Initialization Helper for this 
                   10335:     # course
                   10336:     $cenv{'course.helper.not.run'} = 1;
                   10337:     #
                   10338:     # Use new Randomseed
                   10339:     #
                   10340:     $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
                   10341:     $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
                   10342:     #
                   10343:     # The encryption code and receipt prefix for this course
                   10344:     #
                   10345:     $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
                   10346:     $cenv{'internal.encpref'}=100+int(9*rand(99));
                   10347:     #
                   10348:     # By default, use standard grading
                   10349:     if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
                   10350: 
1.541     raeburn  10351:     $outcome .= $linefeed.&mt('Setting environment').': '.                 
                   10352:           &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10353: #
                   10354: # Open all assignments
                   10355: #
                   10356:     if ($args->{'openall'}) {
                   10357:        my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
                   10358:        my %storecontent = ($storeunder         => time,
                   10359:                            $storeunder.'.type' => 'date_start');
                   10360:        
                   10361:        $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541     raeburn  10362:                  ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444     albertel 10363:    }
                   10364: #
                   10365: # Set first page
                   10366: #
                   10367:     unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
                   10368: 	    || ($cloneid)) {
1.445     albertel 10369: 	use LONCAPA::map;
1.444     albertel 10370: 	$outcome .= &mt('Setting first resource').': ';
1.445     albertel 10371: 
                   10372: 	my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
                   10373:         my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
                   10374: 
1.444     albertel 10375:         $outcome .= ($fatal?$errtext:'read ok').' - ';
                   10376:         my $title; my $url;
                   10377:         if ($args->{'firstres'} eq 'syl') {
1.690     bisitz   10378: 	    $title=&mt('Syllabus');
1.444     albertel 10379:             $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
                   10380:         } else {
1.690     bisitz   10381:             $title=&mt('Navigate Contents');
1.444     albertel 10382:             $url='/adm/navmaps';
                   10383:         }
1.445     albertel 10384: 
                   10385:         $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
                   10386: 	(my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
                   10387: 
                   10388: 	if ($errtext) { $fatal=2; }
1.541     raeburn  10389:         $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444     albertel 10390:     }
1.566     albertel 10391: 
                   10392:     return (1,$outcome);
1.444     albertel 10393: }
                   10394: 
                   10395: ############################################################
                   10396: ############################################################
                   10397: 
1.378     raeburn  10398: sub course_type {
                   10399:     my ($cid) = @_;
                   10400:     if (!defined($cid)) {
                   10401:         $cid = $env{'request.course.id'};
                   10402:     }
1.404     albertel 10403:     if (defined($env{'course.'.$cid.'.type'})) {
                   10404:         return $env{'course.'.$cid.'.type'};
1.378     raeburn  10405:     } else {
                   10406:         return 'Course';
1.377     raeburn  10407:     }
                   10408: }
1.156     albertel 10409: 
1.406     raeburn  10410: sub group_term {
                   10411:     my $crstype = &course_type();
                   10412:     my %names = (
                   10413:                   'Course' => 'group',
1.865     raeburn  10414:                   'Community' => 'group',
1.406     raeburn  10415:                 );
                   10416:     return $names{$crstype};
                   10417: }
                   10418: 
1.902     raeburn  10419: sub course_types {
                   10420:     my @types = ('official','unofficial','community');
                   10421:     my %typename = (
                   10422:                          official   => 'Official course',
                   10423:                          unofficial => 'Unofficial course',
                   10424:                          community  => 'Community',
                   10425:                    );
                   10426:     return (\@types,\%typename);
                   10427: }
                   10428: 
1.156     albertel 10429: sub icon {
                   10430:     my ($file)=@_;
1.505     albertel 10431:     my $curfext = lc((split(/\./,$file))[-1]);
1.168     albertel 10432:     my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156     albertel 10433:     my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168     albertel 10434:     if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
                   10435: 	if (-e  $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
                   10436: 	          $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10437: 	            $curfext.".gif") {
                   10438: 	    $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
                   10439: 		$curfext.".gif";
                   10440: 	}
                   10441:     }
1.249     albertel 10442:     return &lonhttpdurl($iconname);
1.154     albertel 10443: } 
1.84      albertel 10444: 
1.575     albertel 10445: sub lonhttpdurl {
1.692     www      10446: #
                   10447: # Had been used for "small fry" static images on separate port 8080.
                   10448: # Modify here if lightweight http functionality desired again.
                   10449: # Currently eliminated due to increasing firewall issues.
                   10450: #
1.575     albertel 10451:     my ($url)=@_;
1.692     www      10452:     return $url;
1.215     albertel 10453: }
                   10454: 
1.213     albertel 10455: sub connection_aborted {
                   10456:     my ($r)=@_;
                   10457:     $r->print(" ");$r->rflush();
                   10458:     my $c = $r->connection;
                   10459:     return $c->aborted();
                   10460: }
                   10461: 
1.221     foxr     10462: #    Escapes strings that may have embedded 's that will be put into
1.222     foxr     10463: #    strings as 'strings'.
                   10464: sub escape_single {
1.221     foxr     10465:     my ($input) = @_;
1.223     albertel 10466:     $input =~ s/\\/\\\\/g;	# Escape the \'s..(must be first)>
1.221     foxr     10467:     $input =~ s/\'/\\\'/g;	# Esacpe the 's....
                   10468:     return $input;
                   10469: }
1.223     albertel 10470: 
1.222     foxr     10471: #  Same as escape_single, but escape's "'s  This 
                   10472: #  can be used for  "strings"
                   10473: sub escape_double {
                   10474:     my ($input) = @_;
                   10475:     $input =~ s/\\/\\\\/g;	# Escape the /'s..(must be first)>
                   10476:     $input =~ s/\"/\\\"/g;	# Esacpe the "s....
                   10477:     return $input;
                   10478: }
1.223     albertel 10479:  
1.222     foxr     10480: #   Escapes the last element of a full URL.
                   10481: sub escape_url {
                   10482:     my ($url)   = @_;
1.238     raeburn  10483:     my @urlslices = split(/\//, $url,-1);
1.369     www      10484:     my $lastitem = &escape(pop(@urlslices));
1.223     albertel 10485:     return join('/',@urlslices).'/'.$lastitem;
1.222     foxr     10486: }
1.462     albertel 10487: 
1.820     raeburn  10488: sub compare_arrays {
                   10489:     my ($arrayref1,$arrayref2) = @_;
                   10490:     my (@difference,%count);
                   10491:     @difference = ();
                   10492:     %count = ();
                   10493:     if ((ref($arrayref1) eq 'ARRAY') && (ref($arrayref2) eq 'ARRAY')) {
                   10494:         foreach my $element (@{$arrayref1}, @{$arrayref2}) { $count{$element}++; }
                   10495:         foreach my $element (keys(%count)) {
                   10496:             if ($count{$element} == 1) {
                   10497:                 push(@difference,$element);
                   10498:             }
                   10499:         }
                   10500:     }
                   10501:     return @difference;
                   10502: }
                   10503: 
1.817     bisitz   10504: # -------------------------------------------------------- Initialize user login
1.462     albertel 10505: sub init_user_environment {
1.463     albertel 10506:     my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462     albertel 10507:     my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
                   10508: 
                   10509:     my $public=($username eq 'public' && $domain eq 'public');
                   10510: 
                   10511: # See if old ID present, if so, remove
                   10512: 
                   10513:     my ($filename,$cookie,$userroles);
                   10514:     my $now=time;
                   10515: 
                   10516:     if ($public) {
                   10517: 	my $max_public=100;
                   10518: 	my $oldest;
                   10519: 	my $oldest_time=0;
                   10520: 	for(my $next=1;$next<=$max_public;$next++) {
                   10521: 	    if (-e $lonids."/publicuser_$next.id") {
                   10522: 		my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
                   10523: 		if ($mtime<$oldest_time || !$oldest_time) {
                   10524: 		    $oldest_time=$mtime;
                   10525: 		    $oldest=$next;
                   10526: 		}
                   10527: 	    } else {
                   10528: 		$cookie="publicuser_$next";
                   10529: 		last;
                   10530: 	    }
                   10531: 	}
                   10532: 	if (!$cookie) { $cookie="publicuser_$oldest"; }
                   10533:     } else {
1.463     albertel 10534: 	# if this isn't a robot, kill any existing non-robot sessions
                   10535: 	if (!$args->{'robot'}) {
                   10536: 	    opendir(DIR,$lonids);
                   10537: 	    while ($filename=readdir(DIR)) {
                   10538: 		if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
                   10539: 		    unlink($lonids.'/'.$filename);
                   10540: 		}
1.462     albertel 10541: 	    }
1.463     albertel 10542: 	    closedir(DIR);
1.462     albertel 10543: 	}
                   10544: # Give them a new cookie
1.463     albertel 10545: 	my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684     www      10546: 		                   : $now.$$.int(rand(10000)));
1.463     albertel 10547: 	$cookie="$username\_$id\_$domain\_$authhost";
1.462     albertel 10548:     
                   10549: # Initialize roles
                   10550: 
                   10551: 	$userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
                   10552:     }
                   10553: # ------------------------------------ Check browser type and MathML capability
                   10554: 
                   10555:     my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
                   10556:         $clientunicode,$clientos) = &decode_user_agent($r);
                   10557: 
                   10558: # ------------------------------------------------------------- Get environment
                   10559: 
                   10560:     my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
                   10561:     my ($tmp) = keys(%userenv);
                   10562:     if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
                   10563: 	# default remote control to off
                   10564: 	if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
                   10565:     } else {
                   10566: 	undef(%userenv);
                   10567:     }
                   10568:     if (($userenv{'interface'}) && (!$form->{'interface'})) {
                   10569: 	$form->{'interface'}=$userenv{'interface'};
                   10570:     }
                   10571:     $env{'environment.remote'}=$userenv{'remote'};
                   10572:     if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
                   10573: 
                   10574: # --------------- Do not trust query string to be put directly into environment
1.817     bisitz   10575:     foreach my $option ('interface','localpath','localres') {
                   10576:         $form->{$option}=~s/[\n\r\=]//gs;
1.462     albertel 10577:     }
                   10578: # --------------------------------------------------------- Write first profile
                   10579: 
                   10580:     {
                   10581: 	my %initial_env = 
                   10582: 	    ("user.name"          => $username,
                   10583: 	     "user.domain"        => $domain,
                   10584: 	     "user.home"          => $authhost,
                   10585: 	     "browser.type"       => $clientbrowser,
                   10586: 	     "browser.version"    => $clientversion,
                   10587: 	     "browser.mathml"     => $clientmathml,
                   10588: 	     "browser.unicode"    => $clientunicode,
                   10589: 	     "browser.os"         => $clientos,
                   10590: 	     "server.domain"      => $Apache::lonnet::perlvar{'lonDefDomain'},
                   10591: 	     "request.course.fn"  => '',
                   10592: 	     "request.course.uri" => '',
                   10593: 	     "request.course.sec" => '',
                   10594: 	     "request.role"       => 'cm',
                   10595: 	     "request.role.adv"   => $env{'user.adv'},
                   10596: 	     "request.host"       => $ENV{'REMOTE_ADDR'},);
                   10597: 
                   10598:         if ($form->{'localpath'}) {
                   10599: 	    $initial_env{"browser.localpath"}  = $form->{'localpath'};
                   10600: 	    $initial_env{"browser.localres"}   = $form->{'localres'};
                   10601:         }
                   10602: 	
                   10603: 	if ($public) {
                   10604: 	    $initial_env{"environment.remote"} = "off";
                   10605: 	}
                   10606: 	if ($form->{'interface'}) {
                   10607: 	    $form->{'interface'}=~s/\W//gs;
                   10608: 	    $initial_env{"browser.interface"} = $form->{'interface'};
                   10609: 	    $env{'browser.interface'}=$form->{'interface'};
                   10610: 	}
                   10611: 
1.724     raeburn  10612:         foreach my $tool ('aboutme','blog','portfolio') {
                   10613:             $userenv{'availabletools.'.$tool} = 
                   10614:                 &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
                   10615:         }
                   10616: 
1.864     raeburn  10617:         foreach my $crstype ('official','unofficial','community') {
1.765     raeburn  10618:             $userenv{'canrequest.'.$crstype} =
                   10619:                 &Apache::lonnet::usertools_access($username,$domain,$crstype,
                   10620:                                                   'reload','requestcourses');
                   10621:         }
                   10622: 
1.462     albertel 10623: 	$env{'user.environment'} = "$lonids/$cookie.id";
                   10624: 	
                   10625: 	if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
                   10626: 		 &GDBM_WRCREAT(),0640)) {
                   10627: 	    &_add_to_env(\%disk_env,\%initial_env);
                   10628: 	    &_add_to_env(\%disk_env,\%userenv,'environment.');
                   10629: 	    &_add_to_env(\%disk_env,$userroles);
1.463     albertel 10630: 	    if (ref($args->{'extra_env'})) {
                   10631: 		&_add_to_env(\%disk_env,$args->{'extra_env'});
                   10632: 	    }
1.462     albertel 10633: 	    untie(%disk_env);
                   10634: 	} else {
1.705     tempelho 10635: 	    &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
                   10636: 			   'Could not create environment storage in lonauth: '.$!.'</span>');
1.462     albertel 10637: 	    return 'error: '.$!;
                   10638: 	}
                   10639:     }
                   10640:     $env{'request.role'}='cm';
                   10641:     $env{'request.role.adv'}=$env{'user.adv'};
                   10642:     $env{'browser.type'}=$clientbrowser;
                   10643: 
                   10644:     return $cookie;
                   10645: 
                   10646: }
                   10647: 
                   10648: sub _add_to_env {
                   10649:     my ($idf,$env_data,$prefix) = @_;
1.676     raeburn  10650:     if (ref($env_data) eq 'HASH') {
                   10651:         while (my ($key,$value) = each(%$env_data)) {
                   10652: 	    $idf->{$prefix.$key} = $value;
                   10653: 	    $env{$prefix.$key}   = $value;
                   10654:         }
1.462     albertel 10655:     }
                   10656: }
                   10657: 
1.685     tempelho 10658: # --- Get the symbolic name of a problem and the url
                   10659: sub get_symb {
                   10660:     my ($request,$silent) = @_;
1.726     raeburn  10661:     (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685     tempelho 10662:     my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
                   10663:     if ($symb eq '') {
                   10664:         if (!$silent) {
                   10665:             $request->print("Unable to handle ambiguous references:$url:.");
                   10666:             return ();
                   10667:         }
                   10668:     }
                   10669:     &Apache::lonenc::check_decrypt(\$symb);
                   10670:     return ($symb);
                   10671: }
                   10672: 
                   10673: # --------------------------------------------------------------Get annotation
                   10674: 
                   10675: sub get_annotation {
                   10676:     my ($symb,$enc) = @_;
                   10677: 
                   10678:     my $key = $symb;
                   10679:     if (!$enc) {
                   10680:         $key =
                   10681:             &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
                   10682:     }
                   10683:     my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
                   10684:     return $annotation{$key};
                   10685: }
                   10686: 
                   10687: sub clean_symb {
1.731     raeburn  10688:     my ($symb,$delete_enc) = @_;
1.685     tempelho 10689: 
                   10690:     &Apache::lonenc::check_decrypt(\$symb);
                   10691:     my $enc = $env{'request.enc'};
1.731     raeburn  10692:     if ($delete_enc) {
1.730     raeburn  10693:         delete($env{'request.enc'});
                   10694:     }
1.685     tempelho 10695: 
                   10696:     return ($symb,$enc);
                   10697: }
1.462     albertel 10698: 
1.41      ng       10699: =pod
                   10700: 
                   10701: =back
                   10702: 
1.112     bowersj2 10703: =cut
1.41      ng       10704: 
1.112     bowersj2 10705: 1;
                   10706: __END__;
1.41      ng       10707: 

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